poe-api-manager 1.2.12 → 1.2.14

package/Changelog.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.2.14
+- 🚀[New] Publish jsr.
+
+## 1.2.13
+- 🛠️[Fix] Quick Fix.
+
 ## 1.2.12
 - 🚀[New] I decided to develop the main project with Typescript language. From now on, development will only continue from here.
 - 🛠️[Fix] Typescript uses.

package/README.md

@@ -5,6 +5,7 @@
 ![GitHub top language](https://img.shields.io/github/languages/top/ayberkgezer/poe-api-manager?logo=typescript)
 [![ISSUES](https://img.shields.io/github/issues/ayberkgezer/poe-api-manager-ts)](https://github.com/ayberkgezer/poe-api-manager/issues)
 ![NPM Downloads](https://img.shields.io/npm/dt/poe-api-manager?logo=npm)
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/ayberkgezer/poe-api-manager/build.yml)
 
 
 - [Introduction](#introduction)

package/dist/lib/modules/poe.ninja/itemView/ItemViewModule.d.ts

@@ -120,7 +120,7 @@ export declare class ItemViewModule {
      */
     allflameEmber: AllflameEmberModule;
     /**
-     * Creates a new instance of ItemWievModule.
+     * Creates a new instance of ItemViewModule.
      * @param league - The Path of Exile league for which the item information is retrieved.
      * @param typeName - The type of item information to retrieve.
      */

package/dist/lib/modules/poe.ninja/itemView/ItemViewModule.js

@@ -123,7 +123,7 @@ class ItemViewModule {
      */
     allflameEmber;
     /**
-     * Creates a new instance of ItemWievModule.
+     * Creates a new instance of ItemViewModule.
      * @param league - The Path of Exile league for which the item information is retrieved.
      * @param typeName - The type of item information to retrieve.
      */

package/jsr.json

@@ -0,0 +1,5 @@
+{
+  "name": "@ayberkgezer/poe-api-manager",
+  "version": "1.2.14",
+  "exports": "src/index.ts"
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "poe-api-manager",
-  "version": "1.2.12",
+  "version": "1.2.14",
   "description": "poe.ninja and poe.watch API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -12,7 +12,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/ayberkgezer/poe-api-manager-ts.git"
+    "url": "https://github.com/ayberkgezer/poe-api-manager.git"
   },
   "keywords": [
     "poe",

package/src/index.ts

@@ -1,9 +0,0 @@
-import { NinjaAPI } from "./lib/NinjaAPI";
-import { WatchAPI } from "./lib/WatchAPI";
-import Utils from "./lib/Utils";
-
-export {
-  NinjaAPI,
-  WatchAPI,
-  Utils,
-};

package/src/lib/NinjaAPI.ts

@@ -1,27 +0,0 @@
-import { CurrencyViewModule } from "./modules/poe.ninja/currencyView/CurrencyViewModule";
-import { ItemViewModule } from "./modules/poe.ninja/itemView/ItemViewModule";
-
-/**
- * Represents an API for interacting with the poe.ninja API.
- */
-export class NinjaAPI {
-  /**
-   * The CurrencyViewModule instance for fetching currency-related data.
-   */
-  public currencyView: CurrencyViewModule;
-
-  /** 
-   * The ItemViewModule instance for fetching item-related data.
-   * 
-   */
-  public itemView: ItemViewModule;
-
-  /**
-   * Creates an instance of NinjaAPI.
-   * @param league The PoE league for which data is requested.
-   */
-  constructor(league: string) {
-    this.currencyView = new CurrencyViewModule(league, "currencyoverview");
-    this.itemView = new ItemViewModule(league, "itemoverview");
-  }
-}

package/src/lib/Utils.ts

@@ -1,39 +0,0 @@
-import getLeagues from "./modules/utils/getLeagues";
-import filterProperties from "./modules/mainfunctions/propertyFilter";
-
-/**
- * A utility class.
- */
-class Utils {
-  constructor() {}
-
-  /**
-   * Fetches the list of leagues for the game.
-   * @returns The array of league names.
-   * @throws If there's an error fetching the leagues.
-   */
-  async getLeagues(): Promise<string[]> {
-    try {
-      return await getLeagues();
-    } catch (error) {
-      throw new Error(`Error fetching data Leagues: ${(error as Error).message}`);
-    }
-  }
-
-  /**
-   * Filters properties of objects in an array based on the specified properties.
-   *
-   * @param data - The array of objects to filter.
-   * @param properties - The array of property names to include in the result.
-   * @returns - An array of objects with only the specified properties.
-   */
-  async filterProperties(data: object[], properties: string[]): Promise<object[]> {
-    try {
-      return filterProperties(data, properties);
-    } catch (error) {
-      throw new Error(`Error fetching data Leagues: ${(error as Error).message}`);
-    }
-  }
-}
-
-export default Utils;

package/src/lib/WatchAPI.ts

@@ -1,19 +0,0 @@
-import WatchWievModule from "./modules/poe.watch/WatchViewModule";
-
-/**
- * Represents an API for interacting with a poe.watch service.
- */
-export class WatchAPI {
-  /**
-   * The WatchWievModule instance associated with this API.
-   */
-  public view: WatchWievModule;
-
-  /**
-   * Creates an instance of WatchAPI.
-   * @param league - The league for which the API should be initialized.
-   */
-  constructor(league: string) {
-    this.view = new WatchWievModule(league);
-  }
-}

package/src/lib/modules/AbstractClass/PoeNinja.ts

@@ -1,37 +0,0 @@
-import IPoeNinja from "../Interfaces/IPoeNinja";
-import getData from "../poe.ninja/func/getData";
-
-/**
- * Abstract class representing a PoeNinja.
- * @abstract
- * @class
- * @implements {IPoeNinja}
- */
-abstract class PoeNinja implements IPoeNinja {
-
-    /**
-     * Represents a PoeNinja object.
-     * @constructor
-     * @param league - The league name.
-     * @param typeName
-     * @param type - The type.
-     */
-    constructor(protected readonly league: string, protected readonly typeName: string, protected readonly type: string) {
-    }
-    /**
-     * Retrieves data from the API based on the specified league, type name, and type.
-     * @param requestedProperties - Optional array of properties to include in the retrieved data.
-     * @returns A promise that resolves to an array of objects containing the retrieved data.
-     * @throws If there is an error retrieving the data.
-     */
-    public async getData(requestedProperties?: string[]): Promise<object[]> {
-        try {
-            return getData(this.league, this.typeName, this.type, requestedProperties);
-        } catch (error: any) {
-            throw new Error(`Error getData ${this.typeName} and ${this.type} data: ${error.message}`);
-        }
-    }
-
-}
-
-export default PoeNinja;

package/src/lib/modules/AbstractClass/PoeWatch.ts

@@ -1,26 +0,0 @@
-import IPoeWatch from "../Interfaces/IPoeWatch";
-import getData from "../poe.watch/allModules/func/getData";
-
-/**
- * Represents an abstract class for interacting with the PoeWatch API.
- */
-abstract class PoeWatch implements IPoeWatch {
-    constructor(protected readonly league: string, protected readonly type: string) {
-    }
-
-    /**
-     * Retrieves data from the PoeWatch API.
-     * @param requestedProperties Optional array of properties to include in the response.
-     * @returns A promise that resolves to an array of objects containing the requested data.
-     * @throws If there is an error retrieving the data.
-     */
-    public async getData(requestedProperties?: string[]): Promise<object[]> {
-        try {
-            return getData(this.league, this.type, requestedProperties);
-        } catch (error: any) {
-            throw new Error(`Error retrieving ${this.type} data: ${error.message}`);
-        }
-    }
-}
-
-export default PoeWatch;

package/src/lib/modules/Interfaces/IPoeNinja.ts

@@ -1,13 +0,0 @@
-/**
- * Represents the interface for interacting with the PoeNinja API.
- */
-interface IPoeNinja {
-    /**
-     * Retrieves data from the PoeNinja API.
-     * @param requestedProperties Optional array of properties to include in the response.
-     * @returns A promise that resolves to the retrieved data.
-     */
-    getData(requestedProperties?: string[]): Promise<object[]>;
-}
-
-export default IPoeNinja;

package/src/lib/modules/Interfaces/IPoeWatch.ts

@@ -1,13 +0,0 @@
-/**
- * Represents the interface for interacting with PoeWatch data.
- */
-interface IPoeWatch {
-    /**
-     * Retrieves data from PoeWatch API.
-     * @param requestedProperties Optional array of properties to include in the response.
-     * @returns A promise that resolves to an array of objects representing the retrieved data.
-     */
-    getData(requestedProperties?: string[]): Promise<object[]>;
-}
-
-export default IPoeWatch;

package/src/lib/modules/mainfunctions/propertyFilter.ts

@@ -1,25 +0,0 @@
-/**
- * Filters properties of objects in an array based on the specified properties.
- * @param data The array of objects to filter.
- * @param requestedProperties The array of property names to include in the result.
- * @returns An array of objects with only the specified properties.
- */
-export default function filterProperties(data: Record<string, any>[], requestedProperties: string[]): object[] {
-    const result: object[] = [];
-  
-    data.forEach((item) => {
-      const itemResult: Record<string, any> = {};
-  
-      requestedProperties.forEach((prop) => {
-        if (Object.prototype.hasOwnProperty.call(item, prop)) {
-          itemResult[prop] = item[prop];
-        } else {
-          console.warn(`Property not found: ${prop}`);
-        }
-      });
-  
-      result.push(itemResult);
-    });
-  
-    return result;
-  }

package/src/lib/modules/poe.ninja/currencyView/CurrencyViewModule.ts

@@ -1,26 +0,0 @@
-import { CurrencyModule, FragmentModule } from "./currencySubModules/CurrencySubModules";
-
-/**
- * Represents a module for fetching currency overview data.
- */
-export class CurrencyViewModule {
-  /**
-   * Represents a module for fetching currency data.
-   */
-  public currency: CurrencyModule;
-
-  /**
-   * Represents a module for fetching fragment data.
-   */
-  public fragment: FragmentModule;
-
-  /**
-   * Creates a new CurrencyViewModule instance.
-   * @param league The name of the Path of Exile league.
-   * @param typeName The type of data to retrieve.
-   */
-  constructor(league: string, typeName: string) {
-    this.currency = new CurrencyModule(league, typeName);
-    this.fragment = new FragmentModule(league, typeName);
-  }
-}

package/src/lib/modules/poe.ninja/currencyView/currencySubModules/CurrencySubModules.ts

@@ -1,7 +0,0 @@
-import CurrencyModule from "./submodules/CurrencyModule";
-import FragmentModule  from "./submodules/FragmentModule";
-
-export {
-  CurrencyModule,
-  FragmentModule,
-};

package/src/lib/modules/poe.ninja/currencyView/currencySubModules/submodules/CurrencyModule.ts

@@ -1,33 +0,0 @@
-import PoeNinja from "../../../../AbstractClass/PoeNinja";
-import getQuickCurrency from "../../../func/getQuickCurrency";
-
-/**
- * Represents a module for retrieving currency data from the PoeNinja API.
- */
-class CurrencyModule extends PoeNinja {
-  /**
-   * Creates an instance of CurrencyModule.
-   * @param league - The name of the league.
-   * @param typeName - The name of the type.
-   */
-  constructor(protected league: string, protected typeName: string) {
-    const type: string = "Currency";
-    super(league, typeName, type);
-  }
-
-  /**
-   * Retrieves the quick currency data for the specified currency type.
-   * @param currencyTypeName - The name of the currency. Defaults to "Divine Orb".
-   * @returns A promise that resolves to an object containing the currency type name and its chaos equivalent value.
-   * @throws If there is an error fetching the quick currency data.
-   */
-  async getQuickCurrency(currencyTypeName: string = "Divine Orb"): Promise<{ currencyTypeName: string, chaosEquivalent: number }> {
-    try {
-      return await getQuickCurrency(this.league, this.typeName, this.type, currencyTypeName);
-    } catch (error: any) {
-      throw new Error(`Error fetching QuickCurrencyData ${this.type} and Currency Name:${currencyTypeName} data: ${error.message}`);
-    }
-  }
-}
-
-export default CurrencyModule;

package/src/lib/modules/poe.ninja/currencyView/currencySubModules/submodules/FragmentModule.ts

@@ -1,18 +0,0 @@
-import PoeNinja from "../../../../AbstractClass/PoeNinja";
-
-/**
- * Represents a module for handling fragments in the PoeNinja currency view.
- */
-class FragmentModule extends PoeNinja {
-  /**
-   * Creates an instance of FragmentModule.
-   * @param league The league for which the module is created.
-   * @param typeName The type name of the module.
-   */
-  constructor(protected league: string, protected typeName: string) {
-    const type: string = "Fragment";
-    super(league, typeName, type);
-  }
-}
-
-export default FragmentModule;

package/src/lib/modules/poe.ninja/fetch/fetchData.ts

@@ -1,51 +0,0 @@
-import axios from "axios";
-import mergeData from "./merge/mergeData";
-import urlGenerator from "../func/urlGenerator";
-
-/**
- * Fetches data from a specified API endpoint, merges relevant data, and returns the result.
- * @param league The game league for which to fetch data.
- * @param type The type of data to fetch. (e.g. "Currency", "Fragment")
- * @param typeName The name of the type of data to fetch. (e.g. "CurrencyOverview", "ItemOverview")
- * @returns A promise that resolves to an array of merged objects containing both line and currency details.
- * @throws Throws an error if there's an issue with the API response or data fetching process.
- */
-async function fetchData(league: string, typeName: string, type: string): Promise<object[]> {
-    try {
-        // Generate the URL for the specified league, type name, and type
-        const url: string = urlGenerator(league, typeName, type);
-        //axios.get(url) is a promise
-        const response = await axios.get(url, {
-            headers: {
-                '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) {
-                const lines: any[] = response.data.lines;
-                const currencyDetails: any[] = response.data.currencyDetails;
-                //the join data is the currencyDetails
-                return mergeData(lines, currencyDetails);
-            } else {
-                throw new Error(
-                    `Invalid response format from POE Ninja API CurrencyView Type:${type}`
-                );
-            }
-        } else if (typeName == "itemoverview") {
-            //if the response has data and lines
-            if (response.data && response.data.lines) {
-                return response.data.lines;
-            } else {
-                throw new Error(`"Invalid response format from POE Ninja API ItemView Type:${type}`);
-            }
-        } else {
-            throw new Error(`Invalid type: ${type}`);
-        }
-    } catch (error: any) {
-        throw new Error(`Error fetching data: ${error.message} TypeName:${typeName} and Type:${type}`);
-    }
-}
-
-export default fetchData;

package/src/lib/modules/poe.ninja/fetch/merge/mergeData.ts

@@ -1,35 +0,0 @@
-/**
- * Merges the provided lines with the corresponding currency details.
- * @param lines The lines to be merged.
- * @param currencyDetails The currency details to be merged with the lines.
- * @returns The merged data.
- */
-function mergeData(lines: any[], currencyDetails: any[]): any[] {
-    const mergedData: any[] = [];
-
-    lines.forEach((line) => {
-        const currencyType: string = line.currencyTypeName;
-
-        // Find the corresponding currencyDetail based on currencyType
-        const currencyDetail = currencyDetails.find(
-            (detail) => detail.name === currencyType
-        );
-
-        if (currencyDetail) {
-            // Merge line and currencyDetail into a new object
-            const mergedItem: any = {
-                ...line,
-                id: currencyDetail.id,
-                icon: currencyDetail.icon,
-                name: currencyDetail.name,
-            };
-
-            // Add the merged item to the result array
-            mergedData.push(mergedItem);
-        }
-    });
-
-    return mergedData;
-}
-
-export default mergeData;

package/src/lib/modules/poe.ninja/func/getData.ts

@@ -1,30 +0,0 @@
-import fetchData from '../fetch/fetchData';
-import filterProperties from '../../mainfunctions/propertyFilter';
-
-/**
- * Fetches data from the specified league, type, and typeName.
- * 
- * @param league - The name of the league to fetch data from.
- * @param typeName - The name of the type to fetch data for.
- * @param type - The type of data to fetch.
- * @param requestedProperties - Optional. An array of properties to filter the fetched data by.
- * @returns A promise that resolves to an array of objects containing the fetched data.
- * @throws If there is an error fetching the data.
- */
-async function getData(league: string, typeName: string, type: string, requestedProperties?: string[]): Promise<object[]> {
-    try {
-        const fetchedData: object[] = await fetchData(league, typeName, type);
-
-        //if requestedProperties use filterProperties to filter fetchedData
-        if (requestedProperties) {
-            const result: object[] = filterProperties(fetchedData, requestedProperties);
-            return result;
-        } else {
-            return fetchedData;
-        }
-    } catch (error) {
-        throw new Error(`Type:${type} Error fetching data: ${(error as Error).message}`);
-    }
-}
-
-export default getData;

package/src/lib/modules/poe.ninja/func/getQuickCurrency.ts

@@ -1,30 +0,0 @@
-import fetchData from "../fetch/fetchData";
-
-/**
- * Retrieves quick currency data for a specific currency in a given league and type.
- * @param league - The league for which to fetch currency data.
- * @param typeName - The type of currency data to fetch.
- * @param type - The type of currency data to fetch.
- * @param 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 Throws an error if the currency data cannot be fetched or if the currency is not found.
- */
-async function getQuickCurrency(league: string, typeName: string, type: string, currencyTypeName: string): Promise<{ currencyTypeName: string, chaosEquivalent: number }> {
-    try {
-        const fetchedData = await fetchData(league, typeName, type) as { currencyTypeName: string, chaosEquivalent: number }[];
-        //find the currencyTypeName in the fetchedData
-        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 as Error).message}`);
-    }
-}
-
-export default getQuickCurrency;

package/src/lib/modules/poe.ninja/func/urlGenerator.ts

@@ -1,10 +0,0 @@
-/**
- * Generates a URL based on league and type. poe.ninja (currencyView) API is used.
- * @param league The league for which the URL is generated.
- * @param type The type of data for which the URL is generated.
- * @param typeName The name of the type of data for which the URL is generated.
- * @returns The generated URL.
- */
-export default function urlGenerator(league: string, typeName: string, type: string): string {
-    return `https://poe.ninja/api/data/${typeName}?league=${league}&type=${type}`;
-}