poe-api-manager 1.2.4 → 1.2.12

package/dist/lib/modules/poe.watch/allModules/subModules/GemModule.js

@@ -0,0 +1,37 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const PoeWatch_1 = __importDefault(require("../../../AbstractClass/PoeWatch"));
+const getCategory_1 = __importDefault(require("../func/getCategory"));
+/**
+ * Class for retrieving gem data from the POE Watch API.
+ */
+class GemModule extends PoeWatch_1.default {
+    /**
+     * Creates a new instance of GemModule.
+     * @param league - The league from which the data will be fetched.
+     */
+    constructor(league) {
+        const type = "gem";
+        super(league, type);
+    }
+    /**
+     * Retrieves category data for accessories.
+     * @async
+     * @param categoryName - The name of the category to retrieve.
+     * *  Possible values: "gems", "supportgem".
+     * @returns - A Promise containing data for the specified category.
+     * @throws - Throws errors encountered while fetching data.
+     */
+    async getCategory(categoryName) {
+        try {
+            return await (0, getCategory_1.default)(this.league, this.type, categoryName);
+        }
+        catch (error) {
+            throw new Error(`Error fetching Accessory data: ${error.message}`);
+        }
+    }
+}
+exports.default = GemModule;

package/dist/lib/modules/poe.watch/allModules/subModules/InscribedModule.d.ts

@@ -0,0 +1,12 @@
+import PoeWatch from "../../../AbstractClass/PoeWatch";
+/**
+ * Subclass of PoeWatch for accessing inscribed data.
+ */
+declare class InscribedModule extends PoeWatch {
+    /**
+     * Creates a new instance of InscribedModule.
+     * @param league - The league from which the data will be fetched.
+     */
+    constructor(league: string);
+}
+export default InscribedModule;

package/dist/lib/modules/poe.watch/allModules/subModules/InscribedModule.js

@@ -0,0 +1,20 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const PoeWatch_1 = __importDefault(require("../../../AbstractClass/PoeWatch"));
+/**
+ * Subclass of PoeWatch for accessing inscribed data.
+ */
+class InscribedModule extends PoeWatch_1.default {
+    /**
+     * Creates a new instance of InscribedModule.
+     * @param league - The league from which the data will be fetched.
+     */
+    constructor(league) {
+        const type = "inscribed";
+        super(league, type);
+    }
+}
+exports.default = InscribedModule;

package/dist/lib/modules/poe.watch/allModules/subModules/InvitationModule.d.ts

@@ -0,0 +1,12 @@
+import PoeWatch from "../../../AbstractClass/PoeWatch";
+/**
+ * Subclass of PoeWatch for accessing invitation data.
+ */
+declare class InvitationModule extends PoeWatch {
+    /**
+     * Creates a new instance of InvitationModule.
+     * @param league - The league from which the data will be fetched.
+     */
+    constructor(league: string);
+}
+export default InvitationModule;

package/dist/lib/modules/poe.watch/allModules/subModules/InvitationModule.js

@@ -0,0 +1,20 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const PoeWatch_1 = __importDefault(require("../../../AbstractClass/PoeWatch"));
+/**
+ * Subclass of PoeWatch for accessing invitation data.
+ */
+class InvitationModule extends PoeWatch_1.default {
+    /**
+     * Creates a new instance of InvitationModule.
+     * @param league - The league from which the data will be fetched.
+     */
+    constructor(league) {
+        const type = "invitation";
+        super(league, type);
+    }
+}
+exports.default = InvitationModule;

package/dist/lib/modules/poe.watch/allModules/subModules/JewelModule.d.ts

@@ -0,0 +1,12 @@
+import PoeWatch from "../../../AbstractClass/PoeWatch";
+/**
+ * Subclass of PoeWatch for accessing jewel data.
+ */
+declare class JewelModule extends PoeWatch {
+    /**
+     * Creates a new instance of JewelModule.
+     * @param league - The league from which the data will be fetched.
+     */
+    constructor(league: string);
+}
+export default JewelModule;

package/dist/lib/modules/poe.watch/allModules/subModules/JewelModule.js

@@ -0,0 +1,20 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const PoeWatch_1 = __importDefault(require("../../../AbstractClass/PoeWatch"));
+/**
+ * Subclass of PoeWatch for accessing jewel data.
+ */
+class JewelModule extends PoeWatch_1.default {
+    /**
+     * Creates a new instance of JewelModule.
+     * @param league - The league from which the data will be fetched.
+     */
+    constructor(league) {
+        const type = "jewel";
+        super(league, type);
+    }
+}
+exports.default = JewelModule;

package/dist/lib/modules/poe.watch/allModules/subModules/MapModule.d.ts

@@ -0,0 +1,12 @@
+import PoeWatch from "../../../AbstractClass/PoeWatch";
+/**
+ * Subclass of PoeWatch for accessing map data.
+ */
+declare class MapModule extends PoeWatch {
+    /**
+     * Creates a new instance of MapModule.
+     * @param league - The league from which the data will be fetched.
+     */
+    constructor(league: string);
+}
+export default MapModule;

package/dist/lib/modules/poe.watch/allModules/subModules/MapModule.js

@@ -0,0 +1,20 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const PoeWatch_1 = __importDefault(require("../../../AbstractClass/PoeWatch"));
+/**
+ * Subclass of PoeWatch for accessing map data.
+ */
+class MapModule extends PoeWatch_1.default {
+    /**
+     * Creates a new instance of MapModule.
+     * @param league - The league from which the data will be fetched.
+     */
+    constructor(league) {
+        const type = "map";
+        super(league, type);
+    }
+}
+exports.default = MapModule;

package/dist/lib/modules/poe.watch/allModules/subModules/OilModule.d.ts

@@ -0,0 +1,12 @@
+import PoeWatch from "../../../AbstractClass/PoeWatch";
+/**
+ * Subclass of PoeWatch for accessing oil data.
+ */
+declare class OilModule extends PoeWatch {
+    /**
+     * Creates a new instance of OilModule.
+     * @param league - The league from which the data will be fetched.
+     */
+    constructor(league: string);
+}
+export default OilModule;

package/dist/lib/modules/poe.watch/allModules/subModules/OilModule.js

@@ -0,0 +1,20 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const PoeWatch_1 = __importDefault(require("../../../AbstractClass/PoeWatch"));
+/**
+ * Subclass of PoeWatch for accessing oil data.
+ */
+class OilModule extends PoeWatch_1.default {
+    /**
+     * Creates a new instance of OilModule.
+     * @param league - The league from which the data will be fetched.
+     */
+    constructor(league) {
+        const type = "oil";
+        super(league, type);
+    }
+}
+exports.default = OilModule;

package/dist/lib/modules/poe.watch/allModules/subModules/ScarabModule.d.ts

@@ -0,0 +1,12 @@
+import PoeWatch from "../../../AbstractClass/PoeWatch";
+/**
+ * Subclass of PoeWatch for accessing scarab data.
+ */
+declare class ScarabModule extends PoeWatch {
+    /**
+     * Creates a new instance of ScarabModule.
+     * @param league - The league from which the data will be fetched.
+     */
+    constructor(league: string);
+}
+export default ScarabModule;

package/dist/lib/modules/poe.watch/allModules/subModules/ScarabModule.js

@@ -0,0 +1,20 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const PoeWatch_1 = __importDefault(require("../../../AbstractClass/PoeWatch"));
+/**
+ * Subclass of PoeWatch for accessing scarab data.
+ */
+class ScarabModule extends PoeWatch_1.default {
+    /**
+     * Creates a new instance of ScarabModule.
+     * @param league - The league from which the data will be fetched.
+     */
+    constructor(league) {
+        const type = "scarab";
+        super(league, type);
+    }
+}
+exports.default = ScarabModule;

package/dist/lib/modules/poe.watch/allModules/subModules/SextantModule.d.ts

@@ -0,0 +1,12 @@
+import PoeWatch from "../../../AbstractClass/PoeWatch";
+/**
+ * Subclass of PoeWatch for accessing sextans data.
+ */
+declare class SextantModule extends PoeWatch {
+    /**
+     * Creates a new instance of SextantModule.
+     * @param league - The league from which the data will be fetched.
+     */
+    constructor(league: string);
+}
+export default SextantModule;

package/dist/lib/modules/poe.watch/allModules/subModules/SextantModule.js

@@ -0,0 +1,20 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const PoeWatch_1 = __importDefault(require("../../../AbstractClass/PoeWatch"));
+/**
+ * Subclass of PoeWatch for accessing sextans data.
+ */
+class SextantModule extends PoeWatch_1.default {
+    /**
+     * Creates a new instance of SextantModule.
+     * @param league - The league from which the data will be fetched.
+     */
+    constructor(league) {
+        const type = "sextans";
+        super(league, type);
+    }
+}
+exports.default = SextantModule;

package/dist/lib/modules/poe.watch/allModules/subModules/UniqueMapsModule.d.ts

@@ -0,0 +1,12 @@
+import PoeWatch from "../../../AbstractClass/PoeWatch";
+/**
+ * Subclass of WatchBaseClass for accessing uniqueMaps data.
+ */
+declare class UniqueMapsModule extends PoeWatch {
+    /**
+     * Creates a new instance of UniqueMapsModule.
+     * @param league - The league from which the data will be fetched.
+     */
+    constructor(league: string);
+}
+export default UniqueMapsModule;

package/dist/lib/modules/poe.watch/allModules/subModules/UniqueMapsModule.js

@@ -0,0 +1,20 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const PoeWatch_1 = __importDefault(require("../../../AbstractClass/PoeWatch"));
+/**
+ * Subclass of WatchBaseClass for accessing uniqueMaps data.
+ */
+class UniqueMapsModule extends PoeWatch_1.default {
+    /**
+     * Creates a new instance of UniqueMapsModule.
+     * @param league - The league from which the data will be fetched.
+     */
+    constructor(league) {
+        const type = "uniqueMaps";
+        super(league, type);
+    }
+}
+exports.default = UniqueMapsModule;

package/dist/lib/modules/poe.watch/allModules/subModules/WeaponModule.d.ts

@@ -0,0 +1,21 @@
+import PoeWatch from "../../../AbstractClass/PoeWatch";
+/**
+ * Subclass of PoeWatch for accessing weapon data.
+ */
+declare class WeaponModule extends PoeWatch {
+    /**
+     * Creates a new instance of WeaponModule.
+     * @param league - The league from which the data will be fetched.
+     */
+    constructor(league: string);
+    /**
+     * Retrieves category data for accessories.
+     * @async
+     * @param categoryName - The name of the category to retrieve.
+     * *   Possible values: "twohandswords", "fishingrods", "onehandswords", "twohandaxes", "staves", "warstaff", "daggers", "scepters".
+     * @returns - A Promise containing data for the specified category.
+     * @throws - Throws errors encountered while fetching data.
+     */
+    getCategory(categoryName: string): Promise<object[]>;
+}
+export default WeaponModule;

package/dist/lib/modules/poe.watch/allModules/subModules/WeaponModule.js

@@ -0,0 +1,37 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const getCategory_1 = __importDefault(require("../func/getCategory"));
+const PoeWatch_1 = __importDefault(require("../../../AbstractClass/PoeWatch"));
+/**
+ * Subclass of PoeWatch for accessing weapon data.
+ */
+class WeaponModule extends PoeWatch_1.default {
+    /**
+     * Creates a new instance of WeaponModule.
+     * @param league - The league from which the data will be fetched.
+     */
+    constructor(league) {
+        const type = "weapon";
+        super(league, type);
+    }
+    /**
+     * Retrieves category data for accessories.
+     * @async
+     * @param categoryName - The name of the category to retrieve.
+     * *   Possible values: "twohandswords", "fishingrods", "onehandswords", "twohandaxes", "staves", "warstaff", "daggers", "scepters".
+     * @returns - A Promise containing data for the specified category.
+     * @throws - Throws errors encountered while fetching data.
+     */
+    async getCategory(categoryName) {
+        try {
+            return await (0, getCategory_1.default)(this.league, this.type, categoryName);
+        }
+        catch (error) {
+            throw new Error(`Error fetching Accessory data: ${error.message}`);
+        }
+    }
+}
+exports.default = WeaponModule;

package/dist/lib/modules/utils/fetchData/fetchData.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Fetches data from the provided URL using Axios.
+ * @param url The URL to fetch data from.
+ * @returns A Promise that resolves with the fetched data.
+ * @throws If an error occurs during the fetch process.
+ */
+declare function fetchData(url: string): Promise<{
+    data: any[];
+}>;
+export default fetchData;

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

@@ -0,0 +1,26 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const axios_1 = __importDefault(require("axios"));
+/**
+ * Fetches data from the provided URL using Axios.
+ * @param url The URL to fetch data from.
+ * @returns A Promise that resolves with the fetched data.
+ * @throws If an error occurs during the fetch process.
+ */
+async function fetchData(url) {
+    try {
+        const response = await axios_1.default.get(url, {
+            headers: {
+                'Accept-Encoding': 'identity',
+            },
+        });
+        return response;
+    }
+    catch (error) {
+        throw new Error(`Error fetching data: ${error.message}`);
+    }
+}
+exports.default = fetchData;

package/dist/lib/modules/utils/getLeagues.d.ts

@@ -0,0 +1,12 @@
+/**
+ * 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 A Promise that resolves with an array of league names.
+ * @throws  If an error occurs during the fetch process or if the response data is empty.
+ */
+declare function getLeagues(): Promise<string[]>;
+export default getLeagues;

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

@@ -0,0 +1,28 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fetchData_1 = __importDefault(require("./fetchData/fetchData"));
+/**
+ * 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 A Promise that resolves with an array of league names.
+ * @throws  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 { data } = await (0, fetchData_1.default)(url);
+        const names = data.map((item) => item.name);
+        return names;
+    }
+    catch (error) {
+        throw new Error(`Error fetching League Names: ${error.message}`);
+    }
+}
+exports.default = getLeagues;

package/package.json

@@ -1,14 +1,18 @@
 {
   "name": "poe-api-manager",
-  "version": "1.2.4",
-  "description": "API management for poe.ninja and poe.watch",
-  "main": "index.js",
+  "version": "1.2.12",
+  "description": "poe.ninja and poe.watch API",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "scripts": {
-    "test": "mocha --require esm --recursive test/**/*.js"
+    "build": "tsc && terser dist/index.js -o dist/index.min.js",
+    "dev": "tsc --watch --project ./tsconfig.json && node --watch ./dist/index.js",
+    "test-1": "ts-node test/test1.ts",
+    "test": "node test/test.js"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/ayberkgezer/poe-api-manager.git"
+    "url": "https://github.com/ayberkgezer/poe-api-manager-ts.git"
   },
   "keywords": [
     "poe",
@@ -25,21 +29,21 @@
     "poe.watch api",
     "poe.ninja api",
     "backend",
-    "frontend"
+    "frontend",
+    "typescript"
   ],
-  "author": "Ayberk Gezer",
-  "license": "MIT",
   "bugs": {
     "url": "https://github.com/ayberkgezer/poe-api-manager/issues"
   },
   "homepage": "https://github.com/ayberkgezer/poe-api-manager#readme",
-  "dependencies": {
-    "axios": "^1.6.7"
-  },
+  "author": "Ayberk Gezer",
+  "license": "MIT",
   "devDependencies": {
-    "chai": "^4.3.4",
-    "esm": "^3.2.25",
-    "mocha": "^10.3.0",
-    "sinon": "^17.0.1"
+    "terser": "^5.29.2",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.4.3"
+  },
+  "dependencies": {
+    "axios": "^1.6.8"
   }
 }

package/src/index.ts

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

package/src/lib/NinjaAPI.ts

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

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

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

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