poe-api-manager 0.2.8 → 1.0.0

package/Changelog.md

@@ -1,7 +1,12 @@
 # Changelog
+## 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 +24,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)
@@ -164,6 +164,22 @@ 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
+const utils = new Utils();
+
+utils.getLeagues().then((data) => {
+  console.log(data);
+});
+```
+
 
 ## Examples
 ```javascript
@@ -225,4 +241,4 @@ const fetchData = async () => {
     console.error("Error fetching data:", error);
   }
 };
-```
+```

package/index.js

@@ -1,7 +1,9 @@
 const NinjaAPI = require("./lib/NinjaAPI");
 const WatchAPI = require("./lib/WatchAPI");
+const Utils = require("./lib/Utils");
 
 module.exports = {
   NinjaAPI: NinjaAPI,
   WatchAPI: WatchAPI,
+  Utils: Utils,
 };

package/lib/Utils.js

@@ -0,0 +1,26 @@
+const getLeagues = require("./modules/utils/getLeagues");
+
+/**
+ * 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}`);
+    }
+  }
+}
+
+module.exports = Utils;

package/lib/modules/utils/functions/fetch/fetch.js

@@ -0,0 +1,22 @@
+const axios = require("axios");
+
+/**
+ * Fetches data from the provided URL using Axios.
+ * @param {string} url The URL to fetch data from.
+ * @returns {Promise<any>} A Promise that resolves with the fetched data.
+ * @throws {Error} If an error occurs during the fetch process.
+ */
+async function fetchData(url) {
+  try {
+    const response = await axios.get(url);
+    if (response.data) {
+      return response.data;
+    } else {
+      throw new Error("Invalid response fetched");
+    }
+  } catch (error) {
+    throw new Error(`Error fetching data: ${error.message}`);
+  }
+}
+
+module.exports = fetchData;

package/lib/modules/utils/getLeagues.js

@@ -0,0 +1,24 @@
+const fetchData = require("./functions/fetch/fetch");
+
+/**
+ * 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 {Promise<string[]>} A Promise that resolves with an array of league names.
+ * @throws {Error} If an error occurs during the fetch process or if the response data is empty.
+ */
+async function getLeagues() {
+  const url = "https://api.poe.watch/leagues";
+  try {
+    const fetchedData = await fetchData(url);
+    const names = fetchedData.map((item) => item.name);
+    return names;
+  } catch (error) {
+    throw new Error(`Error fetching League Names: ${error.message}`);
+  }
+}
+
+module.exports = getLeagues;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "poe-api-manager",
-  "version": "0.2.8",
+  "version": "1.0.0",
   "description": "API management for poe.ninja and poe.watch",
   "main": "index.js",
   "scripts": {