poe-api-manager 0.2.8 → 1.2.1

package/Changelog.md

@@ -1,7 +1,17 @@
 # Changelog
+## 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.
+- 📝 [Update] The documentation has been updated.
+
 ## 0.2.8
 - 🚀[Added] poe.watch API with `getCategory()` function.
-- 🛠️ [Fixed] WatchAPI sınıfında yazım hatası
+- 🛠️ [Fixed] Typo in WatchAPI class
 - 📝 [Update] The documentation has been updated.
 ## 0.2.6
 - 🎨[Added] JSDocs for easy understanding.
@@ -19,4 +29,4 @@
     - Invitations
     - Memories
 
-## 0.0.1 Publish
+## 0.0.1 Publish

package/README.md

@@ -1,7 +1,7 @@
 # poe-api-manager
 
 [![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/)
-![Version](https://img.shields.io/github/package-json/v/ayberkgezer/poe-api-manager)
+![GitHub package.json version](https://img.shields.io/github/package-json/v/ayberkgezer/poe-api-manager)
 ![GitHub top language](https://img.shields.io/github/languages/top/ayberkgezer/poe-api-manager?logo=javascript)
 [![ISSUES](https://img.shields.io/github/issues/ayberkgezer/poe-api-manager)](https://github.com/ayberkgezer/poe-api-manager/issues)
 ![NPM Downloads](https://img.shields.io/npm/dt/poe-api-manager?logo=npm)
@@ -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)
 
@@ -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
@@ -97,14 +98,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 +139,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 +148,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.
 
@@ -164,6 +165,27 @@ watchAPI.view.armour.getCategory("chest").then((data) => {
   console.log(data);
 });
 ```
+## Utils
+Utils class is a class that contains some auxiliary tools.
+```javascript
+const { Utils } = require("poe-api-manager");
+const utils = new Utils();
+```
+- getLeagues() => Returns available league names.
+
+```javascript
+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
@@ -225,4 +247,4 @@ const fetchData = async () => {
     console.error("Error fetching data:", error);
   }
 };
-```
+```

package/index.js

@@ -1,7 +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

@@ -0,0 +1,41 @@
+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

@@ -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,37 @@
+const getData = require("./methods/getData");
+
+/**
+ * Represents a base class for interacting with data.
+ */
+class CurrencyBaseClass {
+  #url;
+  #type;
+  #baseurl = "https://poe.ninja/api/data/";
+
+  /**
+   * 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.#url = `${this.#baseurl}currencyoverview?league=${league}`;
+    this.#type = `&type=${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.#url, this.#type, 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/currencySubmodules/subModules/CurrencyModule.js

@@ -1,60 +1,16 @@
-const getData = require("../functions/getData");
+const CurrencyBaseClass = require("../../CurrencyBaseClass");
 
 /**
- * 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
-   * @type {string}
+   * Constructs a new CurrencyModule instance.
+   * @param {string} league - The league name for which currency data is requested.
    */
-  #url;
-
-  /**
-   * The type of data (Currency in this case).
-   *
-   * @private
-   * @type {string}
-   */
-  #type;
-
-  /**
-   * Creates an instance of CurrencyModule.
-   *
-   * @param {string} url - The URL to fetch data from.
-   */
-  constructor(url) {
-    this.#url = url;
-    this.#type = "Currency";
-  }
-
-  /**
-   * 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 Currency 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 Currency data.
-       *
-       * @throws {Error}
-       */
-      throw new Error(`Error fetching Currency data: ${error.message}`);
-    }
+  constructor(league) {
+    super(league, "Currency");
   }
 }
 

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/{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.

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

@@ -0,0 +1,64 @@
+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
+   */
+  #type;
+
+  /**
+   * @type {string} The base URL for poe.watch.
+   * @private
+   */
+  #baseurl;
+  /**
+   * 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/";
+  }
+
+  /**
+   * Retrieves item data based on requested properties.
+   * @param {string[]} requestedProperties - An array of properties to retrieve for each item.
+   * @returns {Promise<Array<Object>>} A promise that resolves with the requested item data.
+   * @throws {Error} If there is an error fetching the data.
+   */
+  async getData(requestedProperties) {
+    try {
+      return await getData(this.#url, this.#type, requestedProperties);
+    } catch (error) {
+      throw new Error(`Error fetching ItemOverView data: ${error.message}`);
+    }
+  }
+}
+
+module.exports = ItemBaseClass;