poe-api-manager 1.0.0 → 1.2.2

package/.github/workflows/CI_CD.yml

@@ -0,0 +1,53 @@
+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/Changelog.md

@@ -1,4 +1,15 @@
 # Changelog
+## 1.2.2
+- 🛠️ [Fixed] Control mechanisms in API calls have been improved for better error handling.
+- 🔄 [Changed] Updated dependencies to their latest versions for improved security and performance.
+- 🚀 [Added] `getQuickCurrency()` has been added to the Currency class.
+
+
+## 1.2.1
+- 🔄 [Update] Development was done with OOP. Classes have been changed.
+  >There was no change in the scripts.
+- 🚀[Added] Added `filterProperties()` to utils class.
+
 ## 1.0.0
 - 🚀[New] utils class
 - 🚀[New] utils `getLeagues`function. Get league name.

package/README.md

@@ -8,7 +8,7 @@
 
 
 - [Introduction](#introduction)
-- [Overwiev](#overwiev)
+- [Overview](#overview)
 - [Installation](#installation)
 - [Getting Started](#getting-started)
   - [poe.ninja](#ninjaapi)
@@ -16,6 +16,7 @@
     - [itemView](#itemwiev)
   - [poe.watch](#watchapi)
     - [view](#view)
+  - [utils](#utils)
 - [Changelog](https://github.com/ayberkgezer/poe-api-manager/blob/main/Changelog.md)
 - [Examples](#examples)
 
@@ -28,7 +29,7 @@ The purpose of this library is to make the economic data in the Path of Exile ga
 
 > Note: This product is in no way affiliated with or endorsed by Grinding Gear Games, poe.ninja and poe.watch.
 
-## Overwiev
+## Overview
 
 Permission to access two different services. poe.ninja and poe.watch
 
@@ -52,14 +53,14 @@ What we can get here is as follows.
 - Currency
 - Fragment
 
-getData() => function returns data purely.
+- getData() => function returns data purely.
 ```javascript
 //Example Currency
 ninjaAPI.currencyView.currency.getData().then((data) => {
   console.log(data);
 });
 ```
-getdata(requestedProperties) => The function filters the data as desired.
+- getData(requestedProperties) => The function filters the data as desired.
 >Note: Enter [poe.ninja Document](https://github.com/ayberkgezer/poe.ninja-API-Document?tab=readme-ov-file#poeninja-api) to access the values for the filter.
 ```javascript
 //Filtered data is returned
@@ -67,6 +68,13 @@ ninjaAPI.currencyView.currency.getData(["id", "name", "icon"]).then((data) => {
   console.log(data);
 });
 ```
+- getQuickCurrency() => This function returns the chaos value from the currency name. It returns "Divine Orb" chaos as the default value. currencyTypeName default "Divine Orb"
+```javascript
+ninjaAPI.currencyView.currency.getQuickCurrency(currencyTypeName).then((data)=> {
+  console.log(data);
+});
+```
+
 #### itemView
 What we can get here is as follows.
 - BaseType
@@ -97,14 +105,14 @@ What we can get here is as follows.
 - Invitations
 - Memories
 
-getData() => function returns data purely.
+- getData() => function returns data purely.
 ```javascript
 //Example BaseType
 ninjaAPI.itemView.baseType.getData().then((data) => {
   console.log(data);
 });
 ```
-getdata(requestedProperties) => The function filters the data as desired.
+- getdata(requestedProperties) => The function filters the data as desired.
 >Note: Enter [poe.ninja Document](https://github.com/ayberkgezer/poe.ninja-API-Document?tab=readme-ov-file#poeninja-api) to access the values for the filter.
 ```javascript
 //Filtered data is returned
@@ -138,7 +146,7 @@ What we can get here is as follows.
 - Base
 - Beast
 
-getData() => function returns data purely.
+- getData() => function returns data purely.
 ```javascript
 //Example Currency
 watchAPI.view.baseType.getData().then((data) => {
@@ -147,14 +155,14 @@ watchAPI.view.baseType.getData().then((data) => {
 ```
 > Enter [poe.watch Document](https://docs.poe.watch/#get-all-armours) to access the values for the filter.
 
-getdata(requestedProperties) => The function filters the data as desired.
+- getdata(requestedProperties) => The function filters the data as desired.
 ```javascript
 //Filtered data is returned
 watchAPI.view.currency.getData(["id", "name", "icon"]).then((data) => {
   console.log(data);
 });
 ```
-getCategory("categoryName") => The function quickly filters through specific categories.
+- getCategory("categoryName") => The function quickly filters through specific categories.
 
 > Note: Used in accessory, armour, base, gem and weapon.
 
@@ -170,16 +178,21 @@ Utils class is a class that contains some auxiliary tools.
 const { Utils } = require("poe-api-manager");
 const utils = new Utils();
 ```
-getLeagues() => Returns available league names.
+- getLeagues() => Returns available league names.
 
 ```javascript
-const utils = new Utils();
-
 utils.getLeagues().then((data) => {
   console.log(data);
 });
 ```
 
+- filterProperties(data, properties) => It is used to filter data.
+
+```javascript
+utils.filterProperties(data, ["currencyTypeName", "chaosEquivalent"])
+  .then((result) => console.log(result));
+```
+
 
 ## Examples
 ```javascript

package/index.js

@@ -1,9 +1,11 @@
 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/Utils.js

@@ -1,4 +1,5 @@
 const getLeagues = require("./modules/utils/getLeagues");
+const filterProperties = require("./modules/mainfunctions/filter/propertyFilter");
 
 /**
  * A utility class.
@@ -21,6 +22,20 @@ class Utils {
       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

@@ -6,50 +6,18 @@ const WatchWievModule = require("./modules/poe.watch/WatchWievModule");
  * @class
  */
 class WatchAPI {
-  /**
-   * The league for which the API is initialized.
-   *
-   * @private
-   * @type {string}
-   */
-  #league;
-
-  /**
-   * The URL parameter for the league in the Path of Exile.
-   *
-   * @private
-   * @type {string}
-   */
-  #leagueUrl;
-
   /**
    * Creates an instance of WatchAPI.
    *
    * @param {string} league - The league for which the API should be initialized.
    */
   constructor(league) {
-    /**
-     * The league for which the API is initialized.
-     *
-     * @private
-     * @type {string}
-     */
-    this.#league = league;
-
-    /**
-     * The URL parameter for the league in the Path of Exile watch service.
-     *
-     * @private
-     * @type {string}
-     */
-    this.#leagueUrl = `&league=${this.#league}`;
-
     /**
      * The WatchWievModule instance associated with this API.
      *
      * @type {WatchWievModule}
      */
-    this.view = new WatchWievModule(this.#leagueUrl);
+    this.view = new WatchWievModule(league);
   }
 }
 

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

@@ -0,0 +1,47 @@
+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,5 +1,4 @@
 const currencySubmodules = require("./currencySubmodules/CurrencySubModules");
-const baseurl = require("../../../config/poeNinja/url");
 
 /**
  * Represents a module for fetching currency overview data.
@@ -7,8 +6,6 @@ const baseurl = require("../../../config/poeNinja/url");
  * @class
  */
 class CurrencyWievModule {
-  #league;
-  #baseurl;
   /**
    * Creates a new CurrencyWievModule instance.
    *
@@ -17,38 +14,16 @@ class CurrencyWievModule {
    */
   constructor(league) {
     /**
-     * The league for which the currency overview data is fetched.
-     *
-     * @private
-     * @type {string}
-     */
-    this.#league = league;
-
-    /**
-     * The base URL for fetching currency overview data.
-     *
-     * @private
-     * @type {string}
-     */
-    this.#baseurl = baseurl.baseurl;
-
-    /**
-     * The URL for currency overview data specific to the league.
-     *
-     * @private
-     * @type {string}
-     */
-    const url = `${this.#baseurl}currencyoverview?league=${this.#league}&type=`;
 
     /**
      * Represents a module for fetching currency data.
      */
-    this.currency = new currencySubmodules.CurrencyModule(url);
+    this.currency = new currencySubmodules.CurrencyModule(league);
 
     /**
      * Represents a module for fetching fragment data.
      */
-    this.fragment = new currencySubmodules.FragmentModule(url);
+    this.fragment = new currencySubmodules.FragmentModule(league);
   }
 }
 

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

@@ -1,17 +1,18 @@
 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} baseurl - The base URL of the API.
+ * @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(baseurl, type) {
+async function fetchData(league, type) {
   try {
-    const url = `${baseurl}${type}`;
+    const url = currencyUrlGenerator(league, type);
     const response = await axios.get(url);
 
     if (response.data && response.data.lines && response.data.currencyDetails) {
@@ -23,7 +24,7 @@ async function fetchData(baseurl, type) {
       return mergedData;
     } else {
       throw new Error(
-        "Invalid response format from POE Ninja API Currencyview"
+        "Invalid response format from POE Ninja API CurrencyView"
       );
     }
   } catch (error) {

package/lib/modules/poe.ninja/currency/currencySubmodules/subModules/CurrencyModule.js

@@ -1,59 +1,52 @@
-const getData = require("../functions/getData");
+const CurrencyBaseClass = require("../../CurrencyBaseClass");
+const getQuickCurrency = require("../../methods/getQuickCurrency");
 
 /**
- * Represents a module for fetching data related to Currency.
- *
- * @class
+ * Represents a module for interacting with currency data.
+ * @extends CurrencyBaseClass
  */
-class CurrencyModule {
+class CurrencyModule extends CurrencyBaseClass {
   /**
-   * The URL for fetching data.
-   *
-   * @private
+   * The league name for which currency data is requested.
    * @type {string}
+   * @private
    */
-  #url;
-
+  #league;
   /**
-   * The type of data (Currency in this case).
-   *
-   * @private
+   * The type name for which currency data is requested.
    * @type {string}
+   * @private
    */
-  #type;
-
+  #typeName;
   /**
-   * Creates an instance of CurrencyModule.
-   *
-   * @param {string} url - The URL to fetch data from.
+   * Constructs a new CurrencyModule instance.
+   * @param {string} league - The league name for which currency data is requested.
    */
-  constructor(url) {
-    this.#url = url;
-    this.#type = "Currency";
+  constructor(league) {
+    /**
+     * The type name for which currency data is requested.
+     * @type {string}
+     */
+    const type = "Currency";
+    super(league, type);
+    this.#league = league;
+    this.#typeName = type;
   }
-
   /**
-   * Asynchronously retrieves data based on the specified properties.
-   *
-   * @async
-   * @param {Array<string>} requestedProperties - An array of properties to retrieve.
-   * @returns {Promise<Object>} A promise that resolves to the retrieved data.
+   * Fetches quick currency data for a given currency ID. Defaults to "Divine Orb" if no ID is provided.
+   * @param {string} currencyTypeName - The "currencyTypeName" of the currency to fetch data for. Defaults to "Divine Orb".
+   * @returns {Promise<{currencyTypeName: string, chaosEquivalent: number}>} A promise that resolves with the currency data, including the currency type name and its chaos equivalent.
+   * @throws {Error} Throws an error if fetching currency data fails.
    */
-  async getData(requestedProperties) {
+  async getQuickCurrency(currencyTypeName = "Divine Orb") {
     try {
-      /**
-       * Calls the getData function to fetch Currency data.
-       *
-       * @type {Promise<Array<Object>>}
-       */
-      return getData(this.#url, this.#type, requestedProperties);
+      return await getQuickCurrency(
+        this.#league,
+        this.#typeName,
+        currencyTypeName
+      );
     } catch (error) {
-      /**
-       * Throws an error if there's an issue fetching or processing the Currency data.
-       *
-       * @throws {Error}
-       */
-      throw new Error(`Error fetching Currency data: ${error.message}`);
+      throw new Error(`Error fetching CurrencyData data: ${error.message}`);
     }
   }
 }

package/lib/modules/poe.ninja/currency/currencySubmodules/subModules/FragmentModule.js

@@ -1,60 +1,16 @@
-const getData = require("../functions/getData");
+const CurrencyBaseClass = require("../../CurrencyBaseClass");
 
 /**
- * Represents a module for fetching data related to Fragments.
- *
- * @class
+ * Represents a module for interacting with fragment currency data.
+ * @extends CurrencyBaseClass
  */
-class FragmentModule {
+class FragmentModule extends CurrencyBaseClass {
   /**
-   * The URL for fetching data.
-   *
-   * @private
-   * @type {string}
+   * Constructs a new FragmentModule instance.
+   * @param {string} league - The league name for which fragment currency data is requested.
    */
-  #url;
-
-  /**
-   * The type of data (Fragment in this case).
-   *
-   * @private
-   * @type {string}
-   */
-  #type;
-
-  /**
-   * Creates an instance of FragmentModule.
-   *
-   * @param {string} url - The URL to fetch data from.
-   */
-  constructor(url) {
-    this.#url = url;
-    this.#type = "Fragment";
-  }
-
-  /**
-   * Asynchronously retrieves data based on the specified properties.
-   *
-   * @async
-   * @param {Array<string>} requestedProperties - An array of properties to retrieve.
-   * @returns {Promise<Object>} A promise that resolves to the retrieved data.
-   */
-  async getData(requestedProperties) {
-    try {
-      /**
-       * Calls the getData function to fetch Fragment data.
-       *
-       * @type {Promise<Array<Object>>}
-       */
-      return getData(this.#url, this.#type, requestedProperties);
-    } catch (error) {
-      /**
-       * Throws an error if there's an issue fetching or processing the Fragment data.
-       *
-       * @throws {Error}
-       */
-      throw new Error(`Error fetching Fragment data: ${error.message}`);
-    }
+  constructor(league) {
+    super(league, "Fragment");
   }
 }
 

package/lib/modules/poe.ninja/currency/currencyUrlGenerator/CurrencyUrlGenerator.js

@@ -0,0 +1,9 @@
+/**
+ * Generates a URL based on league and type. poe.ninja (currencyView) 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.
+ */
+module.exports = function urlGenerator(league, type) {
+  return `https://poe.ninja/api/data/currencyoverview?league=${league}&type=${type}`;
+};

package/lib/modules/poe.ninja/currency/{currencySubmodules/functions → methods}/getData.js

@@ -1,5 +1,5 @@
-const fetchData = require("../../currencyFetch/fetchCurrency");
-const filterProperties = require("../../../../mainfunctions/filter/propertyFilter");
+const fetchData = require("../currencyFetch/fetchCurrency");
+const filterProperties = require("../../../mainfunctions/filter/propertyFilter");
 
 /**
  * Retrieves data from a specified API endpoint, optionally filters the data based on requested properties, and returns the result.
@@ -14,10 +14,10 @@ const filterProperties = require("../../../../mainfunctions/filter/propertyFilte
  * @function
  *
  */
-async function getData(url, type, requestedProperties) {
+async function getData(league, type, requestedProperties) {
   try {
     // Fetch data using the fetchData function
-    const fetchedData = await fetchData(url, type);
+    const fetchedData = await fetchData(league, type);
 
     // If requestedProperties are specified, filter the data based on those properties
     if (requestedProperties) {

package/lib/modules/poe.ninja/currency/methods/getQuickCurrency.js

@@ -0,0 +1,28 @@
+const fetchCurrency = require("../currencyFetch/fetchCurrency");
+
+/**
+ * Retrieves quick currency data for a specific currency in a given league and type.
+ * @param {string} league - The league for which to fetch currency data.
+ * @param {string} type - The type of currency data to fetch.
+ * @param {string} 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 {Error} Throws an error if the currency data cannot be fetched or if the currency is not found.
+ */
+async function getQuickCurrency(league, type, currencyTypeName) {
+  try {
+    const fetchedData = await fetchCurrency(league, type);
+    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}`);
+  }
+}
+
+module.exports = getQuickCurrency;