poe-api-manager 1.2.19 → 1.2.22

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,77 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others’ private information, such as a physical or email address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [email@example.com](mailto:email@example.com). All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, available at [https://www.contributor-covenant.org/version/2/0/code_of_conduct.html](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html).
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are available at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations).

package/CONTRIBUTING.md

@@ -0,0 +1,56 @@
+### CONTRIBUTING.md
+
+```md
+# Contributing to poe-api-manager
+
+First off, thanks for taking the time to contribute! 🎉
+
+The following is a set of guidelines for contributing to poe-api-manager. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
+
+## Code of Conduct
+
+This project and everyone participating in it is governed by the [poe-api-manager Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [ayberkgezer@outlook.com](mailto:ayberkgezer@outlook.com).
+
+## How Can I Contribute?
+
+### Reporting Bugs
+
+This section guides you through submitting a bug report for poe-api-manager. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.
+
+- **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/ayberkgezer/poe-api-manager/issues).
+- If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/ayberkgezer/poe-api-manager/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
+
+### Suggesting Enhancements
+
+This section guides you through submitting an enhancement suggestion for poe-api-manager, including completely new features and minor improvements to existing functionality.
+
+- **Ensure the enhancement was not already suggested** by searching on GitHub under [Issues](https://github.com/ayberkgezer/poe-api-manager/issues).
+- If you find an enhancement that matches your suggestion, feel free to add additional comments or ideas.
+- If you cannot find an existing issue, [open a new one](https://github.com/ayberkgezer/poe-api-manager/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior.
+
+### Pull Requests
+
+The process described here has several goals:
+
+- Maintain poe-api-manager's quality
+- Fix problems that are important to users
+- Engage the community in working toward the best possible poe-api-manager
+- Enable a sustainable system for poe-api-manager's maintainers to review contributions
+
+Please follow these steps to have your contribution considered by the maintainers:
+
+1. Fork the repository and create your branch from `main`.
+2. If you've added code that should be tested, add tests.
+3. If you've changed APIs, update the documentation.
+4. Ensure the test suite passes.
+5. Make sure your code lints.
+6. Issue that pull request!
+
+### Coding Style
+
+- Please follow the coding style used throughout the project.
+- Ensure your code is properly formatted and linted.
+
+## License
+
+By contributing to poe-api-manager, you agree that your contributions will be licensed under its MIT License.

package/Changelog.md

@@ -1,4 +1,7 @@
-# Changelog
+# CHANGELOG
+
+## 1.2.20
+- 🚀[Added] CODE_OF_CONDUCT, CONTRIBUTING, and SECURITY policies.
 
 ## 1.2.19
 - 🚀[Added] poe.watch API with the following features:

package/SECURITY.md

@@ -0,0 +1,14 @@
+# Security Policy
+
+## Supported Versions
+
+We release patches for security vulnerabilities. Which versions are eligible for receiving such patches depend on the CVSS v3.0 Rating:
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 1.2.x   | :white_check_mark: |
+| < 1.2   | :x:                |
+
+## Reporting a Vulnerability
+
+If you discover a security vulnerability within this project, please send an email to Ayberk Gezer at [ayberkgezer@outlook.com](mailto:ayberkgezer@outlook.com) . All security vulnerabilities will be promptly addressed.

package/dist/lib/AbstractClass/PoeNinja.js

@@ -4,6 +4,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const getData_1 = __importDefault(require("../modules/poe.ninja/func/getData"));
+const CustomError_1 = __importDefault(require("../errors/CustomError"));
+const ApiError_1 = __importDefault(require("../errors/ApiError"));
 /**
  * Abstract class representing a PoeNinja.
  * @abstract
@@ -37,7 +39,11 @@ class PoeNinja {
             return (0, getData_1.default)(this.league, this.typeName, this.type, requestedProperties);
         }
         catch (error) {
-            throw new Error(`Error getData ${this.typeName} and ${this.type} data: ${error.message}`);
+            // Pass through custom errors
+            if (error instanceof CustomError_1.default) {
+                throw error;
+            }
+            throw new ApiError_1.default(`Error getData ${this.typeName} and ${this.type} data: ${error.message}`, 500, { league: this.league, typeName: this.typeName, type: this.type });
         }
     }
 }

package/dist/lib/AbstractClass/PoeWatch.js

@@ -4,6 +4,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const getData_1 = __importDefault(require("../modules/poe.watch/func/getData"));
+const CustomError_1 = __importDefault(require("../errors/CustomError"));
+const ApiError_1 = __importDefault(require("../errors/ApiError"));
 /**
  * Represents an abstract class for interacting with the PoeWatch API.
  * @abstract
@@ -33,7 +35,11 @@ class PoeWatch {
             return (0, getData_1.default)(this.league, this.type, requestedProperties);
         }
         catch (error) {
-            throw new Error(`Error retrieving ${this.type} data: ${error.message}`);
+            // Pass through custom errors
+            if (error instanceof CustomError_1.default) {
+                throw error;
+            }
+            throw new ApiError_1.default(`Error retrieving ${this.type} data: ${error.message}`, 500, { league: this.league, type: this.type });
         }
     }
 }

package/dist/lib/mainfunctions/propertyFilter.js

@@ -1,5 +1,9 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+const ValidationError_js_1 = __importDefault(require("../errors/ValidationError.js"));
 /**
  * Filters properties of objects in an array based on the specified properties.
  * @param {Record<string, any> []} data The array of objects to filter.
@@ -7,6 +11,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * @returns {object[]} An array of objects with only the specified properties.
  */
 function filterProperties(data, requestedProperties) {
+    // Validate input first
+    if (!Array.isArray(data)) {
+        throw new ValidationError_js_1.default("Input data must be an array", 400, {
+            providedType: typeof data,
+        });
+    }
+    if (!Array.isArray(requestedProperties)) {
+        throw new ValidationError_js_1.default("requestedProperties must be an array", 400, {
+            providedType: typeof requestedProperties,
+        });
+    }
     const result = [];
     data.forEach((item) => {
         const itemResult = {};

package/dist/lib/modules/poe.ninja/currencyView/currencySubModules/submodules/CurrencyModule.js

@@ -5,6 +5,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const PoeNinja_1 = __importDefault(require("../../../../../AbstractClass/PoeNinja"));
 const getQuickCurrency_1 = __importDefault(require("../../../func/getQuickCurrency"));
+const CustomError_1 = __importDefault(require("../../../../../errors/CustomError"));
+const ApiError_1 = __importDefault(require("../../../../../errors/ApiError"));
 /**
  * Represents a module for retrieving currency data from the PoeNinja API.
  */
@@ -33,7 +35,16 @@ class CurrencyModule extends PoeNinja_1.default {
             return await (0, getQuickCurrency_1.default)(this.league, this.typeName, this.type, currencyTypeName);
         }
         catch (error) {
-            throw new Error(`Error fetching QuickCurrencyData ${this.type} and Currency Name:${currencyTypeName} data: ${error.message}`);
+            // Pass through custom errors
+            if (error instanceof CustomError_1.default) {
+                throw error;
+            }
+            throw new ApiError_1.default(`Error fetching QuickCurrencyData ${this.type} and Currency Name:${currencyTypeName} data: ${error.message}`, 500, {
+                league: this.league,
+                typeName: this.typeName,
+                type: this.type,
+                currencyTypeName,
+            });
         }
     }
 }

package/dist/lib/modules/poe.ninja/fetch/fetchData.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const axios_1 = __importDefault(require("axios"));
 const mergeData_1 = __importDefault(require("./merge/mergeData"));
 const urlGenerator_1 = __importDefault(require("../func/urlGenerator"));
+const ApiError_1 = __importDefault(require("../../../errors/ApiError"));
 /**
  * Fetches data from a specified API endpoint, merges relevant data, and returns the result.
  * @param league The game league for which to fetch data.
@@ -21,20 +22,22 @@ async function fetchData(league, typeName, type) {
         //axios.get(url) is a promise
         const response = await axios_1.default.get(url, {
             headers: {
-                'Accept-Encoding': 'identity',
+                "Accept-Encoding": "identity",
             },
         });
         //typwName is either currencyoverview or itemoverview
         if (typeName == "currencyoverview") {
             //if the response has data and lines and currencyDetails
-            if (response.data && response.data.lines && response.data.currencyDetails) {
+            if (response.data &&
+                response.data.lines &&
+                response.data.currencyDetails) {
                 const lines = response.data.lines;
                 const currencyDetails = response.data.currencyDetails;
                 //the join data is the currencyDetails
                 return (0, mergeData_1.default)(lines, currencyDetails);
             }
             else {
-                throw new Error(`Invalid response format from POE Ninja API CurrencyView Type:${type}`);
+                throw new ApiError_1.default(`Invalid response format from POE Ninja API CurrencyView Type:${type}`, 400, { league, typeName, type });
             }
         }
         else if (typeName == "itemoverview") {
@@ -43,15 +46,29 @@ async function fetchData(league, typeName, type) {
                 return response.data.lines;
             }
             else {
-                throw new Error(`"Invalid response format from POE Ninja API ItemView Type:${type}`);
+                throw new ApiError_1.default(`Invalid response format from POE Ninja API ItemView Type:${type}`, 400, { league, typeName, type });
             }
         }
         else {
-            throw new Error(`Invalid type: ${type}`);
+            throw new ApiError_1.default(`Invalid type: ${type}`, 400, {
+                league,
+                typeName,
+                type,
+            });
         }
     }
     catch (error) {
-        throw new Error(`Error fetching data: ${error.message} TypeName:${typeName} and Type:${type}`);
+        // If it's already an ApiError, pass it through
+        if (error instanceof ApiError_1.default) {
+            throw error;
+        }
+        // Handle axios errors with more context
+        if (axios_1.default.isAxiosError(error)) {
+            const statusCode = error.response?.status || 500;
+            throw new ApiError_1.default(`Error fetching data: ${error.message} TypeName:${typeName} and Type:${type}`, statusCode, { url: error.config?.url, league, typeName, type });
+        }
+        // General error case
+        throw new ApiError_1.default(`Error fetching data: ${error.message} TypeName:${typeName} and Type:${type}`, 500, { league, typeName, type });
     }
 }
 exports.default = fetchData;

package/dist/lib/modules/poe.watch/fetch/watchFetch.js

@@ -4,6 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const axios_1 = __importDefault(require("axios"));
+const ApiError_1 = __importDefault(require("../../../errors/ApiError"));
 const WatchUrlGenerator_1 = __importDefault(require("../func/WatchUrlGenerator"));
 /**
  * Fetches data from the POE Watch API based on the provided query URL.
@@ -24,13 +25,33 @@ async function fetchData(league, type) {
             return response.data;
         }
         else {
-            throw new Error("Invalid response format from POE Watch API");
+            throw new ApiError_1.default("Invalid response format from POE Watch API", 400, {
+                league,
+                type,
+            });
         }
     }
     catch (error) {
-        throw new Error(axios_1.default.isAxiosError(error) && error.response
-            ? `Error fetching data from poe.watch: ${error.response.data.error}, Code: ${error.response.data.code}`
-            : `Error fetching data from poe.watch: ${error}`);
+        // If it's already an ApiError, pass it through
+        if (error instanceof ApiError_1.default) {
+            throw error;
+        }
+        // Handle axios errors
+        if (axios_1.default.isAxiosError(error)) {
+            const statusCode = error.response?.status || 500;
+            const errorDetails = error.response?.data || {};
+            throw new ApiError_1.default(`Error fetching data from poe.watch: ${errorDetails.error || error.message}`, statusCode, {
+                code: errorDetails.code,
+                league,
+                type,
+                url: error.config?.url,
+            });
+        }
+        // General error case
+        throw new ApiError_1.default(`Error fetching data from poe.watch: ${error}`, 500, {
+            league,
+            type,
+        });
     }
 }
 exports.default = fetchData;

package/dist/lib/modules/poe.watch/func/getCategory.js

@@ -4,6 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const watchFetch_1 = __importDefault(require("../fetch/watchFetch"));
+const ValidationError_1 = __importDefault(require("../../../errors/ValidationError"));
 /**
  * Fetches data based on the provided query URL and filters it by category name.
  * @param league - The league to fetch the data from.
@@ -14,22 +15,32 @@ const watchFetch_1 = __importDefault(require("../fetch/watchFetch"));
  */
 async function getCategory(league, type, categoryName) {
     try {
-        const fetchedData = await (0, watchFetch_1.default)(league, type);
-        // Validate category name
+        // Validate category name first
         if (!categoryName && categoryName !== "0") {
-            throw new Error("Category name is required.");
+            throw new ValidationError_1.default("Category name is required.", 400, {
+                league,
+                type,
+            });
         }
+        const fetchedData = await (0, watchFetch_1.default)(league, type);
         // Filter data by category name
         const filteredData = fetchedData.filter((item) => item.group === categoryName);
         // Check if filtered data is empty
         if (filteredData.length === 0) {
-            throw new Error(`No data found for category: ${categoryName}`);
+            throw new ValidationError_1.default(`No data found for category: ${categoryName}`, 404, {
+                league,
+                type,
+                categoryName,
+            });
         }
         return filteredData;
     }
     catch (error) {
-        throw new Error(`Error fetching or filtering data for category: ${error.message}`);
+        // If it's already a custom error, pass it through
+        if (error instanceof ValidationError_1.default) {
+            throw error;
+        }
+        throw new ValidationError_1.default(`Error fetching or filtering data for category: ${error.message}`, 400, { league, type, categoryName });
     }
 }
-;
 exports.default = getCategory;

package/dist/lib/modules/utils/getLeagues.js

@@ -3,6 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+const ApiError_1 = __importDefault(require("../../errors/ApiError"));
 const fetchData_1 = __importDefault(require("./fetchData/fetchData"));
 /**
  * Fetches league names from the provided URL.
@@ -18,11 +19,23 @@ async function getLeagues() {
     const url = "https://api.poe.watch/leagues";
     try {
         const { data } = await (0, fetchData_1.default)(url);
+        if (!data || !Array.isArray(data)) {
+            throw new ApiError_1.default("Invalid response format from leagues API", 400, {
+                url,
+            });
+        }
         const names = data.map((item) => item.name);
+        if (names.length === 0) {
+            throw new ApiError_1.default("No leagues found in response", 404, { url });
+        }
         return names;
     }
     catch (error) {
-        throw new Error(`Error fetching League Names: ${error.message}`);
+        // Pass through ApiError instances
+        if (error instanceof ApiError_1.default) {
+            throw error;
+        }
+        throw new ApiError_1.default(`Error fetching League Names: ${error.message}`, 500, { url });
     }
 }
 exports.default = getLeagues;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "poe-api-manager",
-  "version": "1.2.19",
+  "version": "1.2.22",
   "description": "poe.ninja and poe.watch API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -46,4 +46,4 @@
   "dependencies": {
     "axios": "^1.6.8"
   }
-}
+}