poe-api-manager 0.2.2 → 0.2.8

package/Changelog.md

@@ -1,19 +1,22 @@
 # Changelog
-## 0.2.2
-poe.watch API add
-
-use getData() function
+## 0.2.8
+- 🚀[Added] poe.watch API with `getCategory()` function.
+- 🛠️ [Fixed] WatchAPI sınıfında yazım hatası
+- 📝 [Update] The documentation has been updated.
+## 0.2.6
+- 🎨[Added] JSDocs for easy understanding.
 
+## 0.2.2
+- 🚀[Added] poe.watch API with `getData()` function.
 
-## 0.1.0 
-poe.ninja API new 
-
-- Omens
-- Unique Relics
-- Cluster Jewels
-- Blighted Maps
-- Blight Ravaged Maps
-- Invitations
-- Memories
+## 0.1.0
+- 🚀[Added] poe.ninja API with the following features:
+    - Omens
+    - Unique Relics
+    - Cluster Jewels
+    - Blighted Maps
+    - Blight Ravaged Maps
+    - Invitations
+    - Memories
 
 ## 0.0.1 Publish

package/README.md

@@ -12,10 +12,10 @@
 - [Installation](#installation)
 - [Getting Started](#getting-started)
   - [poe.ninja](#ninjaapi)
-    - [currencyWiev](#currencywiev)
-    - [itemWiev](#itemwiev)
+    - [currencyView](#currencywiev)
+    - [itemView](#itemwiev)
   - [poe.watch](#watchapi)
-    - [wiev](#wiev)
+    - [view](#view)
 - [Changelog](https://github.com/ayberkgezer/poe-api-manager/blob/main/Changelog.md)
 - [Examples](#examples)
 
@@ -47,7 +47,7 @@ const { NinjaAPI } = require("poe-api-manager");
 const ninjaAPI = new NinjaAPI("League-Name");
 ```
 
-#### currencyWiev
+#### currencyView
 What we can get here is as follows.
 - Currency
 - Fragment
@@ -55,7 +55,7 @@ What we can get here is as follows.
 getData() => function returns data purely.
 ```javascript
 //Example Currency
-ninjaAPI.currencyWiev.currency.getData().then((data) => {
+ninjaAPI.currencyView.currency.getData().then((data) => {
   console.log(data);
 });
 ```
@@ -63,11 +63,11 @@ 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
-ninjaAPI.currencyWiev.currency.getData(["id", "name", "icon"]).then((data) => {
+ninjaAPI.currencyView.currency.getData(["id", "name", "icon"]).then((data) => {
   console.log(data);
 });
 ```
-#### itemWiev
+#### itemView
 What we can get here is as follows.
 - BaseType
 - Beast
@@ -100,7 +100,7 @@ What we can get here is as follows.
 getData() => function returns data purely.
 ```javascript
 //Example BaseType
-ninjaAPI.itemWiev.baseType.getData().then((data) => {
+ninjaAPI.itemView.baseType.getData().then((data) => {
   console.log(data);
 });
 ```
@@ -108,7 +108,7 @@ 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
-ninjaAPI.itemWiev.baseType.getData(["id", "name", "icon"]).then((data) => {
+ninjaAPI.itemView.baseType.getData(["id", "name", "icon"]).then((data) => {
   console.log(data);
 });
 ```
@@ -118,7 +118,7 @@ const { WatchAPI } = require("poe-api-manager");
 
 const watchAPI = new WatchAPI("League-Name");
 ```
-#### wiev
+#### view
 What we can get here is as follows.
 - Currency
 - Essences
@@ -138,16 +138,29 @@ What we can get here is as follows.
 - Base
 - Beast
 
+getData() => function returns data purely.
 ```javascript
 //Example Currency
-watchAPI.wiev.baseType.getData().then((data) => {
+watchAPI.view.baseType.getData().then((data) => {
   console.log(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.
 ```javascript
 //Filtered data is returned
-watchAPI.wiev.currency.getData(["id", "name", "icon"]).then((data) => {
+watchAPI.view.currency.getData(["id", "name", "icon"]).then((data) => {
+  console.log(data);
+});
+```
+getCategory("categoryName") => The function quickly filters through specific categories.
+
+> Note: Used in accessory, armour, base, gem and weapon.
+
+```javascript
+//Returns the chest category in Armor.
+watchAPI.view.armour.getCategory("chest").then((data) => {
   console.log(data);
 });
 ```
@@ -165,17 +178,17 @@ const watchAPI = new WatchAPI("Affliction")
 const requestedProperties = ["id", "name", "icon"];
 
 //filtered BaseType data ninjaAPI
-ninjaAPI.itemwiev.baseType.getData(requestedProperties).then((data) => {
+ninjaAPI.itemView.baseType.getData(requestedProperties).then((data) => {
   console.log(data);
 });
 
 //filtered Currency data ninjaAPI
-ninjaAPI.currencyWiev.currency.getData(requestedProperties).then((data) => {
+ninjaAPI.currencyView.currency.getData(requestedProperties).then((data) => {
   console.log(data);
 });
 
 // filtered Scarab data watchAPI
-watchAPI.wiev.scarab.getData(requestedProperties).then((data) => {
+watchAPI.view.scarab.getData(requestedProperties).then((data) => {
   console.log(data);
 });
 ```
@@ -194,18 +207,18 @@ const requestedProperties = ["id", "name", "icon"];
 const fetchData = async () => {
   try {
     //Oil Data poe.ninja
-    const oilData = await ninjaAPI.item.oil.getData(requestedProperties);
+    const oilData = await ninjaAPI.itemView.oil.getData(requestedProperties);
 
 
     console.log("poe.ninja Oil Data:", oilData);
 
     //Currency Data poe.ninja
-    const currencyData = await ninjaAPI.currencyWiev.currency.getData(requestedProperties);
+    const currencyData = await ninjaAPI.currencyView.currency.getData(requestedProperties);
 
     console.log("poe.ninja Currency Data:", currencyData);
 
     //Scarab Data poe.watch
-    const scarabData = await watchAPI.wiev.scarab.getData(requestedProperties)
+    const scarabData = await watchAPI.view.scarab.getData(requestedProperties)
 
     console.log("poe.watch Scarab Data", scarabData);
   } catch (error) {

package/lib/NinjaAPI.js

@@ -1,11 +1,33 @@
-const ItemWievModule = require("./modules/poe.ninja/item/ItemWievModule");
-const CurrencyWievModule = require("./modules/poe.ninja/currency/CurrencyWievModule");
+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) {
-    this.currencyWiev = new CurrencyWievModule(league);
-    this.itemWiev = new ItemWievModule(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/WatchAPI.js

@@ -1,12 +1,56 @@
 const WatchWievModule = require("./modules/poe.watch/WatchWievModule");
 
+/**
+ * Represents an API for interacting with a poe.watch service.
+ *
+ * @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}`;
-    this.wiev = new WatchWievModule(this.#leagueUrl);
+
+    /**
+     * The WatchWievModule instance associated with this API.
+     *
+     * @type {WatchWievModule}
+     */
+    this.view = new WatchWievModule(this.#leagueUrl);
   }
 }
+
 module.exports = WatchAPI;

package/lib/config/poeNinja/url.js

@@ -1,3 +1,12 @@
+/**
+ * Configuration module for poe.ninja API URL.
+ * @module config/poeNinja/url
+ */
+
+/**
+ * Base URL for the poe.ninja API.
+ * @type {string}
+ */
 module.exports = {
   baseurl: "https://poe.ninja/api/data/",
 };

package/lib/config/poeWatch/url.js

@@ -1,3 +1,12 @@
+/**
+ * Configuration module for poe.watch API URL.
+ * @module config/poeWatch/url
+ */
+
+/**
+ * Base URL for the poe.watch API.
+ * @type {string}
+ */
 module.exports = {
   baseurl: "https://api.poe.watch/get?category=",
 };

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

@@ -1,12 +1,30 @@
+/**
+ * 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}`);
       }
     });

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

@@ -1,19 +1,56 @@
 const currencySubmodules = require("./currencySubmodules/CurrencySubModules");
 const baseurl = require("../../../config/poeNinja/url");
 
-//currencywiev module
+/**
+ * Represents a module for fetching currency overview data.
+ *
+ * @class
+ */
 class CurrencyWievModule {
   #league;
   #baseurl;
+  /**
+   * Creates a new CurrencyWievModule instance.
+   *
+   * @constructor
+   * @param {string} league - The name of the Path of Exile league.
+   */
   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);
+
+    /**
+     * Represents a module for fetching fragment data.
+     */
     this.fragment = new currencySubmodules.FragmentModule(url);
   }
 }
 
-//export CurrencyWievModule;
+// Export the CurrencyWievModule class
 module.exports = CurrencyWievModule;

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

@@ -1,7 +1,14 @@
 const axios = require("axios");
 const mergeData = require("./merge/mergeData");
 
-// items for a specific fetch function
+/**
+ * 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} 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) {
   try {
     const url = `${baseurl}${type}`;
@@ -10,11 +17,13 @@ async function fetchData(baseurl, type) {
     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 Currencywiev"
+        "Invalid response format from POE Ninja API Currencyview"
       );
     }
   } catch (error) {
@@ -22,5 +31,4 @@ async function fetchData(baseurl, type) {
   }
 }
 
-// export fetchData;
 module.exports = fetchData;

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

@@ -1,3 +1,10 @@
+/**
+ * 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 = [];
 

package/lib/modules/poe.ninja/currency/currencySubmodules/functions/getData.js

@@ -1,6 +1,19 @@
 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.
+ *
+ * @param {string} url - The URL of the API endpoint.
+ * @param {string} type - The type of data to fetch.
+ * @param {Array<string>} [requestedProperties] - An optional array of property names to filter the fetched data.
+ * @returns {Promise<Array<Object>>} - A promise that resolves to an array of objects containing the fetched and possibly filtered data.
+ * @throws {Error} - Throws an error if there's an issue with the data fetching process or filtering process.
+ *
+ * @async
+ * @function
+ *
+ */
 async function getData(url, type, requestedProperties) {
   try {
     // Fetch data using the fetchData function
@@ -8,6 +21,11 @@ async function getData(url, type, requestedProperties) {
 
     // If requestedProperties are specified, filter the data based on those properties
     if (requestedProperties) {
+      /**
+       * Filter the fetched data based on the specified properties.
+       *
+       * @type {Array<Object>}
+       */
       const result = filterProperties(fetchedData, requestedProperties);
       return result;
     } else {
@@ -15,6 +33,11 @@ async function getData(url, type, requestedProperties) {
       return fetchedData;
     }
   } catch (error) {
+    /**
+     * An error indicating an issue with the data fetching or filtering process.
+     *
+     * @throws {Error} - Throws an error with a descriptive message.
+     */
     throw new Error(`Error fetching data: ${error.message}`);
   }
 }

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

@@ -1,18 +1,61 @@
 const getData = require("../functions/getData");
 
+/**
+ * Represents a module for fetching data related to Currency.
+ *
+ * @class
+ */
 class CurrencyModule {
+  /**
+   * The URL for fetching data.
+   *
+   * @private
+   * @type {string}
+   */
   #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) {
-    return getData(this.#url, this.#type, 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}`);
+    }
   }
 }
 
-//export CurrencyModule;
 module.exports = CurrencyModule;

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

@@ -1,18 +1,61 @@
 const getData = require("../functions/getData");
 
+/**
+ * Represents a module for fetching data related to Fragments.
+ *
+ * @class
+ */
 class FragmentModule {
+  /**
+   * The URL for fetching data.
+   *
+   * @private
+   * @type {string}
+   */
   #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) {
-    return getData(this.#url, this.#type, 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}`);
+    }
   }
 }
 
-//export FragmentModule;
 module.exports = FragmentModule;