poe-api-manager 1.2.1 → 1.2.3

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,13 @@
 # Changelog
+## 1.2.3
+- 🚀 [Added] Coffins added to itemview.
+
+## 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.

package/README.md

@@ -8,7 +8,7 @@
 
 
 - [Introduction](#introduction)
-- [Overwiev](#overwiev)
+- [Overview](#overview)
 - [Installation](#installation)
 - [Getting Started](#getting-started)
   - [poe.ninja](#ninjaapi)
@@ -29,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
 
@@ -60,7 +60,7 @@ 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
@@ -68,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

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

@@ -4,9 +4,19 @@ const getData = require("./methods/getData");
  * Represents a base class for interacting with data.
  */
 class CurrencyBaseClass {
-  #url;
-  #type;
-  #baseurl = "https://poe.ninja/api/data/";
+  /**
+   * 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.
@@ -14,8 +24,8 @@ class CurrencyBaseClass {
    * @param {string} typeName - The type of data.
    */
   constructor(league, typeName) {
-    this.#url = `${this.#baseurl}currencyoverview?league=${league}`;
-    this.#type = `&type=${typeName}`;
+    this.#league = league;
+    this.#typeName = typeName;
   }
 
   /**
@@ -27,7 +37,7 @@ class CurrencyBaseClass {
    */
   async getData(requestedProperties) {
     try {
-      return await getData(this.#url, this.#type, requestedProperties);
+      return await getData(this.#league, this.#typeName, requestedProperties);
     } catch (error) {
       throw new Error(`Error fetching CurrencyView data: ${error.message}`);
     }

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,16 +1,53 @@
 const CurrencyBaseClass = require("../../CurrencyBaseClass");
+const getQuickCurrency = require("../../methods/getQuickCurrency");
 
 /**
  * Represents a module for interacting with currency data.
  * @extends CurrencyBaseClass
  */
 class CurrencyModule extends CurrencyBaseClass {
+  /**
+   * The league name for which currency data is requested.
+   * @type {string}
+   * @private
+   */
+  #league;
+  /**
+   * The type name for which currency data is requested.
+   * @type {string}
+   * @private
+   */
+  #typeName;
   /**
    * Constructs a new CurrencyModule instance.
    * @param {string} league - The league name for which currency data is requested.
    */
   constructor(league) {
-    super(league, "Currency");
+    /**
+     * The type name for which currency data is requested.
+     * @type {string}
+     */
+    const type = "Currency";
+    super(league, type);
+    this.#league = league;
+    this.#typeName = type;
+  }
+  /**
+   * 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 getQuickCurrency(currencyTypeName = "Divine Orb") {
+    try {
+      return await getQuickCurrency(
+        this.#league,
+        this.#typeName,
+        currencyTypeName
+      );
+    } catch (error) {
+      throw new Error(`Error fetching CurrencyData data: ${error.message}`);
+    }
   }
 }
 

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/methods/getData.js

@@ -14,10 +14,10 @@ const filterProperties = require("../../../mainfunctions/filter/propertyFilter")
  * @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;

package/lib/modules/poe.ninja/item/ItemBaseClass.js

@@ -1,12 +1,6 @@
 const getData = require("./methods/getData");
 
 class ItemBaseClass {
-  /**
-   * @type {string} The URL used for retrieving item data.
-   * @private
-   */
-  #url;
-
   /**
    * @type {string} The type of item to retrieve data for.
    * @private
@@ -14,36 +8,18 @@ class ItemBaseClass {
   #type;
 
   /**
-   * @type {string} The base URL for poe.watch.
+   * @type {string} The name of the current league.
    * @private
    */
-  #baseurl;
+  #league;
   /**
    * Constructs an instance of ItemBaseClass.
    * @param {string} league - The name of the league to retrieve data for.
    * @param {string} typeName - The type of item to retrieve data for.
    */
   constructor(league, typeName) {
-    /**
-     * The URL used for retrieving item data.
-     * @type {string}
-     * @private
-     */
-    this.#url = `${this.#baseurl}itemoverview?league=${league}`;
-
-    /**
-     * The type of item to retrieve data for.
-     * @type {string}
-     * @private
-     */
-    this.#type = `&type=${typeName}`;
-
-    /**
-     * The base URL for poe.watch.
-     * @type {string}
-     * @private
-     */
-    this.#baseurl = "https://poe.ninja/api/data/";
+    this.#type = typeName;
+    this.#league = league;
   }
 
   /**
@@ -54,7 +30,7 @@ class ItemBaseClass {
    */
   async getData(requestedProperties) {
     try {
-      return await getData(this.#url, this.#type, requestedProperties);
+      return await getData(this.#league, this.#type, requestedProperties);
     } catch (error) {
       throw new Error(`Error fetching ItemOverView data: ${error.message}`);
     }

package/lib/modules/poe.ninja/item/ItemWievModule.js

@@ -145,6 +145,11 @@ class ItemWievModule {
      * Represents a submodule for blight ravaged map item information.
      */
     this.blightRavagedMap = new itemSubmodules.BlightRavagedMapModule(league);
+
+    /**
+     * Represents a submodule for coffin item information.
+     */
+    this.coffin = new itemSubmodules.CoffinModule(league);
   }
 }
 

package/lib/modules/poe.ninja/item/itemFetch/fetchItem.js

@@ -1,32 +1,27 @@
 const axios = require("axios");
+const urlGenerator = require("../itemUrlGenerator/ItemUrlGenerator");
 
 /**
  * Asynchronously fetches data from a specified URL for item-related information.
  *
- * @param {string} baseurl - The base URL for the data fetch operation.
+ * @param {string} league - The league name for the data fetch operation.
  * @param {string} type - The specific type of item data to fetch.
  * @returns {Promise<Array<Object>>} - A promise that resolves to the fetched item data.
  * @throws {Error} - Throws an error if there's an issue fetching or processing the data.
  */
-async function fetchData(baseurl, type) {
+async function fetchData(league, type) {
   try {
     /**
      * @type {string} url - The complete URL for fetching item-related data.
      */
-    const url = `${baseurl}${type}`;
+    const url = urlGenerator(league, type);
 
-    /**
-     * @type {Object} response - The response object from the data fetch operation.
-     */
     const response = await axios.get(url);
 
     if (response.data && response.data.lines) {
-      /**
-       * @type {Array<Object>} lines - The array of objects containing item-related data.
-       */
       return response.data.lines;
     } else {
-      throw new Error("Invalid response format from POE Ninja API Itemwiev");
+      throw new Error("Invalid response format from POE Ninja API ItemView");
     }
   } catch (error) {
     /**

package/lib/modules/poe.ninja/item/itemSubmodules/itemSubModules.js

@@ -27,4 +27,5 @@ module.exports = {
   ClusterJewelModule: require("./subModules/ClusterJewelModule"),
   BlightedMapModule: require("./subModules/BlightedMapModule"),
   BlightRavagedMapModule: require("./subModules/BlightRavagedMapModule"),
+  CoffinModule: require("./subModules/CoffinModule"),
 };

package/lib/modules/poe.ninja/item/itemSubmodules/subModules/BeastModule.js

@@ -9,7 +9,12 @@ class BeastModule extends ItemBaseClass {
    * @param {string} league - The league name.
    */
   constructor(league) {
-    super(league, "Beast");
+    /**
+     * The name of the beast type.
+     * @type {string}
+     */
+    const typeName = "Beast";
+    super(league, typeName);
   }
 }
 

package/lib/modules/poe.ninja/item/itemSubmodules/subModules/CoffinModule.js

@@ -0,0 +1,9 @@
+const ItemBaseClass = require("../../ItemBaseClass");
+
+class CoffinModule extends ItemBaseClass {
+  constructor(league, type = "Coffin") {
+    super(league, type);
+  }
+}
+
+module.exports = CoffinModule;

package/lib/modules/poe.ninja/item/itemUrlGenerator/ItemUrlGenerator.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/itemoverview?league=${league}&type=${type}`;
+};

package/lib/modules/poe.ninja/item/methods/getData.js

@@ -4,25 +4,19 @@ const filterProperties = require("../../../mainfunctions/filter/propertyFilter")
 /**
  * Asynchronously fetches and filters item-related data from a specified URL.
  *
- * @param {string} url - The URL to fetch item-related data from.
+ * @param {string} league - The name of the current league.
  * @param {string} type - The type of item data to fetch.
  * @param {Array<string>} [requestedProperties] - (Optional) An array of property names to include in the filtered result.
  * @returns {Promise<Array<Object>|Object>} - A promise that resolves to the fetched or filtered item data.
  * @throws {Error} - Throws an error if there's an issue fetching or processing the data.
  */
-async function getData(url, type, requestedProperties) {
+async function getData(league, type, requestedProperties) {
   try {
     // Fetch data using the fetchData function
-    /**
-     * @type {Array<Object>|Object} fetchedData - The fetched item data.
-     */
-    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) {
-      /**
-       * @type {Array<Object>|Object} result - The filtered item data based on requested properties.
-       */
       const result = filterProperties(fetchedData, requestedProperties);
       return result;
     } else {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "poe-api-manager",
-  "version": "1.2.1",
+  "version": "1.2.3",
   "description": "API management for poe.ninja and poe.watch",
   "main": "index.js",
   "scripts": {
@@ -23,7 +23,9 @@
     "poe economy api",
     "path of exile api",
     "poe.watch api",
-    "poe.ninja api"
+    "poe.ninja api",
+    "backend",
+    "frontend"
   ],
   "author": "Ayberk Gezer",
   "license": "MIT",