poe-api-manager 1.2.13 → 1.2.16

package/Changelog.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 1.2.14
+- 🚀[New] Publish jsr.
+
 ## 1.2.13
 - 🛠️[Fix] Quick Fix.
 

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/NinjaAPI.d.ts

@@ -2,20 +2,22 @@ import { CurrencyViewModule } from "./modules/poe.ninja/currencyView/CurrencyVie
 import { ItemViewModule } from "./modules/poe.ninja/itemView/ItemViewModule";
 /**
  * Represents an API for interacting with the poe.ninja API.
+ * @class
  */
 export declare class NinjaAPI {
     /**
      * The CurrencyViewModule instance for fetching currency-related data.
+     * @type {CurrencyViewModule}
      */
     currencyView: CurrencyViewModule;
     /**
      * The ItemViewModule instance for fetching item-related data.
-     *
+     * @type {ItemViewModule}
      */
     itemView: ItemViewModule;
     /**
      * Creates an instance of NinjaAPI.
-     * @param league The PoE league for which data is requested.
+     * @param {string} league The PoE league for which data is requested.
      */
     constructor(league: string);
 }

package/dist/lib/NinjaAPI.js

@@ -5,20 +5,22 @@ const CurrencyViewModule_1 = require("./modules/poe.ninja/currencyView/CurrencyV
 const ItemViewModule_1 = require("./modules/poe.ninja/itemView/ItemViewModule");
 /**
  * Represents an API for interacting with the poe.ninja API.
+ * @class
  */
 class NinjaAPI {
     /**
      * The CurrencyViewModule instance for fetching currency-related data.
+     * @type {CurrencyViewModule}
      */
     currencyView;
     /**
      * The ItemViewModule instance for fetching item-related data.
-     *
+     * @type {ItemViewModule}
      */
     itemView;
     /**
      * Creates an instance of NinjaAPI.
-     * @param league The PoE league for which data is requested.
+     * @param {string} league The PoE league for which data is requested.
      */
     constructor(league) {
         this.currencyView = new CurrencyViewModule_1.CurrencyViewModule(league, "currencyoverview");

package/dist/lib/Utils.d.ts

@@ -1,20 +1,21 @@
 /**
  * A utility class.
+ * @class
  */
 declare class Utils {
     constructor();
     /**
      * Fetches the list of leagues for the game.
-     * @returns The array of league names.
+     * @returns {string[]} The array of league names.
      * @throws If there's an error fetching the leagues.
      */
     getLeagues(): Promise<string[]>;
     /**
      * 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.
+     * @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.
      */
     filterProperties(data: object[], properties: string[]): Promise<object[]>;
 }

package/dist/lib/Utils.js

@@ -7,12 +7,13 @@ const getLeagues_1 = __importDefault(require("./modules/utils/getLeagues"));
 const propertyFilter_1 = __importDefault(require("./modules/mainfunctions/propertyFilter"));
 /**
  * A utility class.
+ * @class
  */
 class Utils {
     constructor() { }
     /**
      * Fetches the list of leagues for the game.
-     * @returns The array of league names.
+     * @returns {string[]} The array of league names.
      * @throws If there's an error fetching the leagues.
      */
     async getLeagues() {
@@ -26,9 +27,9 @@ class Utils {
     /**
      * 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.
+     * @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.
      */
     async filterProperties(data, properties) {
         try {

package/dist/lib/WatchAPI.d.ts

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

package/dist/lib/WatchAPI.js

@@ -7,15 +7,17 @@ exports.WatchAPI = void 0;
 const WatchViewModule_1 = __importDefault(require("./modules/poe.watch/WatchViewModule"));
 /**
  * Represents an API for interacting with a poe.watch service.
+ * @class
  */
 class WatchAPI {
     /**
-     * The WatchWievModule instance associated with this API.
+     * The WatchViewModule instance associated with this API.
+     * @type {WatchViewModule}
      */
     view;
     /**
      * Creates an instance of WatchAPI.
-     * @param league - The league for which the API should be initialized.
+     * @param {string} league - The league for which the API should be initialized.
      */
     constructor(league) {
         this.view = new WatchViewModule_1.default(league);

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

@@ -15,6 +15,7 @@ declare abstract class PoeNinja implements IPoeNinja {
      * @param league - The league name.
      * @param typeName
      * @param type - The type.
+     * @implements {IPoeNinja}
      */
     constructor(league: string, typeName: string, type: string);
     /**

package/dist/lib/modules/AbstractClass/PoeNinja.js

@@ -20,6 +20,7 @@ class PoeNinja {
      * @param league - The league name.
      * @param typeName
      * @param type - The type.
+     * @implements {IPoeNinja}
      */
     constructor(league, typeName, type) {
         this.league = league;

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/dist/lib/modules/poe.watch/WatchViewModule.d.ts

@@ -2,7 +2,7 @@ import { CurrencyModule, AccessoryModule, ArmourModule, BaseModule, BeastModule,
 /**
  * Represents a module for fetching data related to Watchstones and Watchstone Regions.
  */
-export declare class WatchWievModule {
+export declare class WatchViewModule {
     /**
      * Module for fetching data related to Currency.
      */
@@ -89,4 +89,4 @@ export declare class WatchWievModule {
      */
     constructor(league: string);
 }
-export default WatchWievModule;
+export default WatchViewModule;

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

@@ -1,11 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WatchWievModule = void 0;
+exports.WatchViewModule = void 0;
 const Modules_1 = require("./allModules/Modules");
 /**
  * Represents a module for fetching data related to Watchstones and Watchstone Regions.
  */
-class WatchWievModule {
+class WatchViewModule {
     /**
      * Module for fetching data related to Currency.
      */
@@ -118,5 +118,5 @@ class WatchWievModule {
         this.weapon = new Modules_1.WeaponModule(league);
     }
 }
-exports.WatchWievModule = WatchWievModule;
-exports.default = WatchWievModule;
+exports.WatchViewModule = WatchViewModule;
+exports.default = WatchViewModule;

package/package.json

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