poe-api-manager 1.2.18 → 1.2.19

package/Changelog.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.2.19
+- 🚀[Added] poe.watch API with the following features:
+  - Unique Maps
+  - Delirium Orb
+  - Divination Card
+
 ## 1.2.18
 - 🛠️[Fix] Quick fix poeWatch error.
 - 🛠️[Fix] Quick fix folder structure.

package/README.md

@@ -152,6 +152,9 @@ What we can get here is as follows.
 - Flask
 - Base
 - Beast
+- Unique Maps
+- Delirium Orb
+- Divination Card
 
 - getData() => function returns data purely.
 ```javascript

package/dist/index.d.ts

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

package/dist/index.js

@@ -1,4 +1,9 @@
 "use strict";
+/*
+ * Main Entry Point for the poe-api-manager package.
+ * This file exports the main classes and functions.
+ * @module poe-api-manager
+ */
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };

package/dist/lib/AbstractClass/PoeNinja.d.ts

@@ -12,17 +12,16 @@ declare abstract class PoeNinja implements IPoeNinja {
     /**
      * Represents a PoeNinja object.
      * @constructor
-     * @param league - The league name.
-     * @param typeName
-     * @param type - The type.
-     * @implements {IPoeNinja}
+     * @param {string} league - The league name.
+     * @param {string} typeName
+     * @param {string} type - The type.
      */
     constructor(league: string, typeName: string, 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.
+     * @param {string} requestedProperties - Optional array of properties to include in the retrieved data.
+     * @returns {Promise<object[]>} A promise that resolves to an array of objects containing the retrieved data.
+     * @throws {Error} If there is an error retrieving the data.
      */
     getData(requestedProperties?: string[]): Promise<object[]>;
 }

package/dist/lib/AbstractClass/PoeNinja.js

@@ -17,10 +17,9 @@ class PoeNinja {
     /**
      * Represents a PoeNinja object.
      * @constructor
-     * @param league - The league name.
-     * @param typeName
-     * @param type - The type.
-     * @implements {IPoeNinja}
+     * @param {string} league - The league name.
+     * @param {string} typeName
+     * @param {string} type - The type.
      */
     constructor(league, typeName, type) {
         this.league = league;
@@ -29,9 +28,9 @@ class PoeNinja {
     }
     /**
      * 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.
+     * @param {string} requestedProperties - Optional array of properties to include in the retrieved data.
+     * @returns {Promise<object[]>} A promise that resolves to an array of objects containing the retrieved data.
+     * @throws {Error} If there is an error retrieving the data.
      */
     async getData(requestedProperties) {
         try {

package/dist/lib/AbstractClass/PoeWatch.d.ts

@@ -1,16 +1,24 @@
 import IPoeWatch from "../Interfaces/IPoeWatch";
 /**
  * Represents an abstract class for interacting with the PoeWatch API.
+ * @abstract
+ * @class
+ * @implements {IPoeWatch}
  */
 declare abstract class PoeWatch implements IPoeWatch {
     protected readonly league: string;
     protected readonly type: string;
+    /**
+     * Creates a new instance of PoeWatch.
+     * @param {string} league - The league name to get data from.
+     * @param {string} type - The type of data to retrieve (e.g. 'currency', 'items', etc.).
+     */
     constructor(league: string, 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.
+     * @param {string[]} requestedProperties Optional array of properties to include in the response.
+     * @returns {Promise<object[]>} A promise that resolves to an array of objects containing the requested data.
+     * @throws {Error} If there is an error retrieving the data.
      */
     getData(requestedProperties?: string[]): Promise<object[]>;
 }

package/dist/lib/AbstractClass/PoeWatch.js

@@ -6,19 +6,27 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const getData_1 = __importDefault(require("../modules/poe.watch/func/getData"));
 /**
  * Represents an abstract class for interacting with the PoeWatch API.
+ * @abstract
+ * @class
+ * @implements {IPoeWatch}
  */
 class PoeWatch {
     league;
     type;
+    /**
+     * Creates a new instance of PoeWatch.
+     * @param {string} league - The league name to get data from.
+     * @param {string} type - The type of data to retrieve (e.g. 'currency', 'items', etc.).
+     */
     constructor(league, type) {
         this.league = league;
         this.type = type;
     }
     /**
      * 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.
+     * @param {string[]} requestedProperties Optional array of properties to include in the response.
+     * @returns {Promise<object[]>} A promise that resolves to an array of objects containing the requested data.
+     * @throws {Error} If there is an error retrieving the data.
      */
     async getData(requestedProperties) {
         try {

package/dist/lib/Utils.d.ts

@@ -7,7 +7,7 @@ declare class Utils {
     /**
      * Fetches the list of leagues for the game.
      * @returns {string[]} The array of league names.
-     * @throws If there's an error fetching the leagues.
+     * @throws {Error} If there's an error fetching the leagues.
      */
     getLeagues(): Promise<string[]>;
     /**
@@ -15,7 +15,8 @@ declare class Utils {
      *
      * @param {object[]} data - The array of objects to filter.
      * @param {string[]} properties - The array of property names to include in the result.
-     * @returns {object[]} - An array of objects with only the specified properties.
+     * @returns {Promise<object[]>} - An array of objects with only the specified properties.
+     * @throws {Error} If there's an error filtering the properties.
      */
     filterProperties(data: object[], properties: string[]): Promise<object[]>;
 }

package/dist/lib/Utils.js

@@ -14,7 +14,7 @@ class Utils {
     /**
      * Fetches the list of leagues for the game.
      * @returns {string[]} The array of league names.
-     * @throws If there's an error fetching the leagues.
+     * @throws {Error} If there's an error fetching the leagues.
      */
     async getLeagues() {
         try {
@@ -29,7 +29,8 @@ class Utils {
      *
      * @param {object[]} data - The array of objects to filter.
      * @param {string[]} properties - The array of property names to include in the result.
-     * @returns {object[]} - An array of objects with only the specified properties.
+     * @returns {Promise<object[]>} - An array of objects with only the specified properties.
+     * @throws {Error} If there's an error filtering the properties.
      */
     async filterProperties(data, properties) {
         try {

package/dist/lib/errors/ApiError.d.ts

@@ -1,9 +1,21 @@
 import CustomError from "./CustomError";
 /**
  * Represents an API error with a message, status code, and additional details.
+ * @class
+ * @extends {CustomError}
  */
 declare class ApiError extends CustomError {
+    /**
+     * The additional details of the error.
+     * @type {any}
+     */
     details: any;
+    /**
+     * Creates a new instance of ApiError.
+     * @param {string} message - The error message.
+     * @param {number} statusCode - The HTTP status code.
+     * @param {any} details - The additional details of the error.
+     */
     constructor(message: string, statusCode: number, details?: any);
 }
 export default ApiError;

package/dist/lib/errors/ApiError.js

@@ -6,9 +6,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const CustomError_1 = __importDefault(require("./CustomError"));
 /**
  * Represents an API error with a message, status code, and additional details.
+ * @class
+ * @extends {CustomError}
  */
 class ApiError extends CustomError_1.default {
+    /**
+     * The additional details of the error.
+     * @type {any}
+     */
     details;
+    /**
+     * Creates a new instance of ApiError.
+     * @param {string} message - The error message.
+     * @param {number} statusCode - The HTTP status code.
+     * @param {any} details - The additional details of the error.
+     */
     constructor(message, statusCode, details) {
         super(message, statusCode);
         this.details = details;

package/dist/lib/errors/CustomError.d.ts

@@ -1,8 +1,15 @@
 /**
  * Represents a custom error with a message and a status code.
+ * @class
+ * @extends {Error}
  */
 declare class CustomError extends Error {
     statusCode: number;
+    /**
+     * Creates a new instance of CustomError.
+     * @param {string} message - The error message.
+     * @param {number} statusCode - The HTTP status code.
+     */
     constructor(message: string, statusCode: number);
 }
 export default CustomError;

package/dist/lib/errors/CustomError.js

@@ -2,9 +2,16 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 /**
  * Represents a custom error with a message and a status code.
+ * @class
+ * @extends {Error}
  */
 class CustomError extends Error {
     statusCode;
+    /**
+     * Creates a new instance of CustomError.
+     * @param {string} message - The error message.
+     * @param {number} statusCode - The HTTP status code.
+     */
     constructor(message, statusCode) {
         super(message);
         this.statusCode = statusCode;

package/dist/lib/errors/ValidationError.d.ts

@@ -1,9 +1,17 @@
 import CustomError from "./CustomError";
 /**
  * Represents an API error with a message, status code, and additional details.
+ * @class
+ * @extends {CustomError}
  */
 declare class ValidationError extends CustomError {
     details: any;
+    /**
+     * Creates a new instance of ApiError.
+     * @param {string} message - The error message.
+     * @param {number} statusCode - The HTTP status code.
+     * @param {any} details - The additional details of the error.
+     */
     constructor(message: string, statusCode: number, details?: any);
 }
 export default ValidationError;

package/dist/lib/errors/ValidationError.js

@@ -6,9 +6,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const CustomError_1 = __importDefault(require("./CustomError"));
 /**
  * Represents an API error with a message, status code, and additional details.
+ * @class
+ * @extends {CustomError}
  */
 class ValidationError extends CustomError_1.default {
     details;
+    /**
+     * Creates a new instance of ApiError.
+     * @param {string} message - The error message.
+     * @param {number} statusCode - The HTTP status code.
+     * @param {any} details - The additional details of the error.
+     */
     constructor(message, statusCode, details) {
         super(message, statusCode);
         this.details = details;

package/dist/lib/mainfunctions/propertyFilter.d.ts

@@ -1,7 +1,7 @@
 /**
  * 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.
+ * @param {Record<string, any> []} data The array of objects to filter.
+ * @param {string} requestedProperties The array of property names to include in the result.
+ * @returns {object[]} An array of objects with only the specified properties.
  */
 export default function filterProperties(data: Record<string, any>[], requestedProperties: string[]): object[];

package/dist/lib/mainfunctions/propertyFilter.js

@@ -2,9 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 /**
  * 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.
+ * @param {Record<string, any> []} data The array of objects to filter.
+ * @param {string} requestedProperties The array of property names to include in the result.
+ * @returns {object[]} An array of objects with only the specified properties.
  */
 function filterProperties(data, requestedProperties) {
     const result = [];

package/dist/lib/modules/poe.watch/WatchViewModule.d.ts

@@ -1,4 +1,4 @@
-import { CurrencyModule, AccessoryModule, ArmourModule, BaseModule, BeastModule, EssenceModule, FossilModule, FragmentModule, MapModule, FlaskModule, JewelModule, GemModule, InvitationModule, OilModule, ScarabModule, SextantModule, WeaponModule } from "./allModules/Modules";
+import { CurrencyModule, AccessoryModule, ArmourModule, BaseModule, BeastModule, DeliriumOrbModule, DivsModule, EssenceModule, FossilModule, FragmentModule, MapModule, FlaskModule, JewelModule, GemModule, InvitationModule, OilModule, ScarabModule, SextantModule, UniqueMapsModule, WeaponModule } from "./allModules/Modules";
 /**
  * Represents a module for fetching data related to Watchstones and Watchstone Regions.
  */
@@ -26,9 +26,11 @@ export declare class WatchViewModule {
     /**
      * Module for fetching data related to DeliriumOrb.
      */
+    deliriumOrb: DeliriumOrbModule;
     /**
      * Module for fetching data related to Divs.
      */
+    divs: DivsModule;
     /**
      * Module for fetching data related to Essence.
      */
@@ -79,6 +81,7 @@ export declare class WatchViewModule {
     /**
      * Module for fetching data related to UniqueMaps.
      */
+    uniqueMaps: UniqueMapsModule;
     /**
      * Module for fetching data related to Weapon.
      */

package/dist/lib/modules/poe.watch/WatchViewModule.js

@@ -29,11 +29,11 @@ class WatchViewModule {
     /**
      * Module for fetching data related to DeliriumOrb.
      */
-    //public deliriumOrb: DeliriumOrbModule;
+    deliriumOrb;
     /**
      * Module for fetching data related to Divs.
      */
-    //public divs: DivsModule;
+    divs;
     /**
      * Module for fetching data related to Essence.
      */
@@ -85,7 +85,7 @@ class WatchViewModule {
     /**
      * Module for fetching data related to UniqueMaps.
      */
-    //public uniqueMaps: UniqueMapsModule;
+    uniqueMaps;
     /**
      * Module for fetching data related to Weapon.
      */
@@ -100,8 +100,6 @@ class WatchViewModule {
         this.armour = new Modules_1.ArmourModule(league);
         this.base = new Modules_1.BaseModule(league);
         this.beast = new Modules_1.BeastModule(league);
-        //this.deliriumOrb = new DeliriumOrbModule(league);
-        //this.divs = new DivsModule(league);
         this.essence = new Modules_1.EssenceModule(league);
         this.fossil = new Modules_1.FossilModule(league);
         this.fragment = new Modules_1.FragmentModule(league);
@@ -109,13 +107,15 @@ class WatchViewModule {
         this.flask = new Modules_1.FlaskModule(league);
         this.jewel = new Modules_1.JewelModule(league);
         this.gem = new Modules_1.GemModule(league);
-        //this.inscribed = new InscribedModule(league);
         this.invitation = new Modules_1.InvitationModule(league);
         this.oil = new Modules_1.OilModule(league);
         this.scarab = new Modules_1.ScarabModule(league);
         this.sextant = new Modules_1.SextantModule(league);
-        //this.uniqueMaps = new UniqueMapsModule(league);
         this.weapon = new Modules_1.WeaponModule(league);
+        this.uniqueMaps = new Modules_1.UniqueMapsModule(league);
+        this.deliriumOrb = new Modules_1.DeliriumOrbModule(league);
+        this.divs = new Modules_1.DivsModule(league);
+        //this.inscribed = new InscribedModule(league);- not now
     }
 }
 exports.WatchViewModule = WatchViewModule;

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

@@ -13,7 +13,7 @@ class DivsModule extends PoeWatch_1.default {
      * @param league - The league from which the data will be fetched.
      */
     constructor(league) {
-        const type = "div";
+        const type = "card";
         super(league, type);
     }
 }

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

@@ -13,7 +13,7 @@ class UniqueMapsModule extends PoeWatch_1.default {
      * @param league - The league from which the data will be fetched.
      */
     constructor(league) {
-        const type = "uniqueMaps";
+        const type = "uniqueMap";
         super(league, type);
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "poe-api-manager",
-  "version": "1.2.18",
+  "version": "1.2.19",
   "description": "poe.ninja and poe.watch API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/tsconfig.json

@@ -1,13 +1,12 @@
 {
-    "compilerOptions": {
-      "target": "ESNext",
-      "module": "commonjs",
-      "outDir": "dist",
-      "declaration": true,
-      "strict": true,
-      "esModuleInterop": true
-    },
-    "include": ["src/**/*"],
-    "exclude": ["node_modules", "dist"]
-  }
-  
+  "compilerOptions": {
+    "target": "ESNext",
+    "module": "CommonJS",
+    "outDir": "dist",
+    "declaration": true,
+    "strict": true,
+    "esModuleInterop": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}