clashofclans.js 3.0.0-dev.392ca4c → 3.0.0-dev.577f128

package/CHANGELOG.md

@@ -2,121 +2,140 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## 3.0.0 (11-01-2023)
+
+### Bug Fixes
+
+- Conflict with the same name of builder base and home base troops. (#123)
+- Fix the issue with the `Client#getLeagueWar()` method.
+- Typings and documentation for clan capital.
+
+### Features
+
+- Added `Client#getCapitalRaidSeasons()` method.
+- Added `Client#getCapitalLeagues()` method.
+- Added `Client#getClanCapitalRanks()` method.
+
+### Breaking Changes
+
+- Using PascalCase instead of SCREAMING_SNAKE_CASE ([#115](https://github.com/clashperk/clashofclans.js/pull/115))
+- `Client#events` and `EventManager` have been removed in favor of `PollingClient` ([#117](https://github.com/clashperk/clashofclans.js/pull/117), [#127](https://github.com/clashperk/clashofclans.js/pull/127))
+
 ## 2.8.0 (2022-07-22)
 
 ### Features
 
--   Better Throttler with JS generator function. ([#111](https://github.com/clashperk/clashofclans.js/pull/111))
--   Updated raw data from game files. ([#111](https://github.com/clashperk/clashofclans.js/pull/111))
--   New method Util#parseArmyLink has been added. ([#110](https://github.com/clashperk/clashofclans.js/pull/110))
+- Better Throttler with JS generator function. ([#111](https://github.com/clashperk/clashofclans.js/pull/111))
+- Updated raw data from game files. ([#111](https://github.com/clashperk/clashofclans.js/pull/111))
+- New method Util#parseArmyLink has been added. ([#110](https://github.com/clashperk/clashofclans.js/pull/110))
 
 ## 2.7.0 (2022-05-22)
 
 ### Features
 
--   Some useful QOL methods have been added. ([#106](https://github.com/clashperk/clashofclans.js/pull/106))
+- Some useful QOL methods have been added. ([#106](https://github.com/clashperk/clashofclans.js/pull/106))
 
 ## 2.6.1 (2022-02-03)
 
 ### Bug Fixes
 
--   New value and typings `notInWar` added for `ClanWarLeagueGroup#state` ([#101](https://github.com/clashperk/clashofclans.js/pull/101))
--   Throw error if `Util.formatTag` / `Util.parseTag` is called with invalid argument ([#102](https://github.com/clashperk/clashofclans.js/pull/101))
+- New value and typings `notInWar` added for `ClanWarLeagueGroup#state` ([#101](https://github.com/clashperk/clashofclans.js/pull/101))
+- Throw error if `Util.formatTag` / `Util.parseTag` is called with invalid argument ([#102](https://github.com/clashperk/clashofclans.js/pull/101))
 
 ## 2.6.0 (2022-01-29)
 
 ## Features
 
--   Replaced Keyv with customizable cache store ([#99](https://github.com/clashperk/clashofclans.js/pull/99))
--   Guide for [Internal Caching](https://clashofclans.js.org/guide/internal-caching)
+- Replaced Keyv with customizable cache store ([#99](https://github.com/clashperk/clashofclans.js/pull/99))
+- Guide for [Internal Caching](https://clashofclans.js.org/guide/internal-caching)
 
 ## 2.5.2 (2022-01-23)
 
 ### Bug Fixes
 
--   Fix `ClanWar#attacksPerMembers` property ([#97](https://github.com/clashperk/clashofclans.js/pull/97))
--   Bump `node-fetch` from 2.6.6 to 2.6.7 ([#96](https://github.com/clashperk/clashofclans.js/pull/96))
+- Fix `ClanWar#attacksPerMembers` property ([#97](https://github.com/clashperk/clashofclans.js/pull/97))
+- Bump `node-fetch` from 2.6.6 to 2.6.7 ([#96](https://github.com/clashperk/clashofclans.js/pull/96))
 
 ## 2.5.1 (2022-01-11)
 
 ### Bug Fixes
 
--   Typings for `ClanWarLeagueGroup#state` property. ([#94](https://github.com/clashperk/clashofclans.js/pull/94))
+- Typings for `ClanWarLeagueGroup#state` property. ([#94](https://github.com/clashperk/clashofclans.js/pull/94))
 
 ## 2.5.0 (2021-12-30)
 
 ### Bug Fixes
 
--   Fix caching issue with unnecessary/invalid query params. ([#91](https://github.com/clashperk/clashofclans.js/pull/91))
--   Added necessary methods to `RESTManager` class. ([#92](https://github.com/clashperk/clashofclans.js/pull/92))
+- Fix caching issue with unnecessary/invalid query params. ([#91](https://github.com/clashperk/clashofclans.js/pull/91))
+- Added necessary methods to `RESTManager` class. ([#92](https://github.com/clashperk/clashofclans.js/pull/92))
 
 ## 2.4.0 (2021-12-28)
 
 ### Features
 
--   `ClanWar#getClanWarLeagueGroup`, `ClanWar#isCWL` and `ClanWar#isFriendly` are now available. ([#87](https://github.com/clashperk/clashofclans.js/pull/87))
--   `RESTOptions#rejectIfNotValid` added to perform `res.ok` operations over `RESTManager` methods. [Know more?](https://clashofclans.js.org/guide/access-raw-data#easy-access) ([#87](https://github.com/clashperk/clashofclans.js/pull/87))
--   `Icon#fileName` and `Icon#sizes` are now available in `Icon` class. ([#87](https://github.com/clashperk/clashofclans.js/pull/87))
--   `Badge#fileName` and `Badge#sizes` are now available in `Badge` class. ([#87](https://github.com/clashperk/clashofclans.js/pull/87))
+- `ClanWar#getClanWarLeagueGroup`, `ClanWar#isCWL` and `ClanWar#isFriendly` are now available. ([#87](https://github.com/clashperk/clashofclans.js/pull/87))
+- `RESTOptions#rejectIfNotValid` added to perform `res.ok` operations over `RESTManager` methods. [Know more?](https://clashofclans.js.org/guide/access-raw-data#easy-access) ([#87](https://github.com/clashperk/clashofclans.js/pull/87))
+- `Icon#fileName` and `Icon#sizes` are now available in `Icon` class. ([#87](https://github.com/clashperk/clashofclans.js/pull/87))
+- `Badge#fileName` and `Badge#sizes` are now available in `Badge` class. ([#87](https://github.com/clashperk/clashofclans.js/pull/87))
 
 ### Deprecations
 
--   `ClanWarMember#previousBestOpponentAttack` has been deprecated. Use `ClanWarAttack#previousBestAttack` instead. ([#87](https://github.com/clashperk/clashofclans.js/pull/87))
+- `ClanWarMember#previousBestOpponentAttack` has been deprecated. Use `ClanWarAttack#previousBestAttack` instead. ([#87](https://github.com/clashperk/clashofclans.js/pull/87))
 
 ## 2.3.0 (2021-12-17)
 
 ### Features
 
--   BigInt literals issue fixed. ([#84](https://github.com/clashperk/clashofclans.js/pull/84))
--   Some Utility methods renamed. ([#84](https://github.com/clashperk/clashofclans.js/pull/84))
-    -   `Util.encodeTag()` to `Util.encodeURI()`
-    -   `Util.encodeTagToId()` to `Util.encodeTag()`
-    -   `Util.decodeIdToTag()` to `Util.decodeTag()`
--   Added `dps`, `resourceType`, `trainingTime` and `regenerationTime` to the `Unit` class. ([#85](https://github.com/clashperk/clashofclans.js/pull/85))
+- BigInt literals issue fixed. ([#84](https://github.com/clashperk/clashofclans.js/pull/84))
+- Some Utility methods renamed. ([#84](https://github.com/clashperk/clashofclans.js/pull/84))
+  - `Util.encodeTag()` to `Util.encodeURI()`
+  - `Util.encodeTagToId()` to `Util.encodeTag()`
+  - `Util.decodeIdToTag()` to `Util.decodeTag()`
+- Added `dps`, `resourceType`, `trainingTime` and `regenerationTime` to the `Unit` class. ([#85](https://github.com/clashperk/clashofclans.js/pull/85))
 
 ## 2.2.0 (2021-12-16)
 
 ### Bug Fixes
 
--   Show units as per in-game orders. ([#82](https://github.com/clashperk/clashofclans.js/pull/82)) ([6e23d2f](https://github.com/clashperk/clashofclans.js/commit/95cf3001059fd3ede9262e249814178631660d5b))
--   Season end time utility method. ([#82](https://github.com/clashperk/clashofclans.js/pull/82)) ([6e23d2f](https://github.com/clashperk/clashofclans.js/commit/95cf3001059fd3ede9262e249814178631660d5b))
--   Updated raw files for new Troops. ([#82](https://github.com/clashperk/clashofclans.js/pull/82)) ([6e23d2f](https://github.com/clashperk/clashofclans.js/commit/95cf3001059fd3ede9262e249814178631660d5b))
+- Show units as per in-game orders. ([#82](https://github.com/clashperk/clashofclans.js/pull/82)) ([6e23d2f](https://github.com/clashperk/clashofclans.js/commit/95cf3001059fd3ede9262e249814178631660d5b))
+- Season end time utility method. ([#82](https://github.com/clashperk/clashofclans.js/pull/82)) ([6e23d2f](https://github.com/clashperk/clashofclans.js/commit/95cf3001059fd3ede9262e249814178631660d5b))
+- Updated raw files for new Troops. ([#82](https://github.com/clashperk/clashofclans.js/pull/82)) ([6e23d2f](https://github.com/clashperk/clashofclans.js/commit/95cf3001059fd3ede9262e249814178631660d5b))
 
 ### Features
 
--   Added `seasonal`, `boostable` and `isLoaded` property to `Unit` class. ([#82](https://github.com/clashperk/clashofclans.js/pull/82)) ([6e23d2f](https://github.com/clashperk/clashofclans.js/commit/95cf3001059fd3ede9262e249814178631660d5b))
+- Added `seasonal`, `boostable` and `isLoaded` property to `Unit` class. ([#82](https://github.com/clashperk/clashofclans.js/pull/82)) ([6e23d2f](https://github.com/clashperk/clashofclans.js/commit/95cf3001059fd3ede9262e249814178631660d5b))
 
 ## 2.1.0 (2021-12-06)
 
 ### Bug Fixes
 
--   Consistency of `ClanWar.attacksPerMember` property. ([#75](https://github.com/clashperk/clashofclans.js/pull/75)) ([6e23d2f](https://github.com/clashperk/clashofclans.js/commit/6e23d2fe0373f56268ffa55d5ac2807c9a2dc2fc))
+- Consistency of `ClanWar.attacksPerMember` property. ([#75](https://github.com/clashperk/clashofclans.js/pull/75)) ([6e23d2f](https://github.com/clashperk/clashofclans.js/commit/6e23d2fe0373f56268ffa55d5ac2807c9a2dc2fc))
 
 ### Features
 
--   More utility methods added to `Util` class. ([#76](https://github.com/clashperk/clashofclans.js/pull/76)) ([ff41115](https://github.com/clashperk/clashofclans.js/commit/ff4111530d6293ef1fc54aa916436130fc30a09c))
+- More utility methods added to `Util` class. ([#76](https://github.com/clashperk/clashofclans.js/pull/76)) ([ff41115](https://github.com/clashperk/clashofclans.js/commit/ff4111530d6293ef1fc54aa916436130fc30a09c))
 
-    -   `Util.formatTag(tag: string): string`
-    -   `Util.formatDate(date: string): Date`
-    -   `Util.isValidTag(tag: string): boolean`
-    -   `Util.encodeTagToId(tag: string): string` (Removed on 2.3.0)
-    -   `Util.decodeIdToTag(id: string): string` (Removed on 2.3.0)
+  - `Util.formatTag(tag: string): string`
+  - `Util.formatDate(date: string): Date`
+  - `Util.isValidTag(tag: string): boolean`
+  - `Util.encodeTagToId(tag: string): string` (Removed on 2.3.0)
+  - `Util.decodeIdToTag(id: string): string` (Removed on 2.3.0)
 
--   Support of async/await for custom events ([#79](https://github.com/clashperk/clashofclans.js/pull/79)) ([ff41115](https://github.com/clashperk/clashofclans.js/commit/a23db3786bcca44b8547c70f27773bdb1216f990))
+- Support of async/await for custom events ([#79](https://github.com/clashperk/clashofclans.js/pull/79)) ([ff41115](https://github.com/clashperk/clashofclans.js/commit/a23db3786bcca44b8547c70f27773bdb1216f990))
 
 ## 2.0.2 (2021-11-30)
 
 ### Bug Fixes
 
--   Return `null` for `RankedPlayer.clan` if they are not in the clan. ([#73](https://github.com/clashperk/clashofclans.js/pull/73)) ([ba82327](https://github.com/clashperk/clashofclans.js/commit/ba8232740f4ca9af2bcc7971aca3574612ef25b6))
--   `OverrideOptions` added for `Client#getClans` and `RESTManager#getClans` ([#73](https://github.com/clashperk/clashofclans.js/pull/73)) ([ba82327](https://github.com/clashperk/clashofclans.js/commit/ba8232740f4ca9af2bcc7971aca3574612ef25b6))
--   `SeasonRankedPlayer` class for legend league ranking. ([#73](https://github.com/clashperk/clashofclans.js/pull/73)) ([ba82327](https://github.com/clashperk/clashofclans.js/commit/ba8232740f4ca9af2bcc7971aca3574612ef25b6))
+- Return `null` for `RankedPlayer.clan` if they are not in the clan. ([#73](https://github.com/clashperk/clashofclans.js/pull/73)) ([ba82327](https://github.com/clashperk/clashofclans.js/commit/ba8232740f4ca9af2bcc7971aca3574612ef25b6))
+- `OverrideOptions` added for `Client#getClans` and `RESTManager#getClans` ([#73](https://github.com/clashperk/clashofclans.js/pull/73)) ([ba82327](https://github.com/clashperk/clashofclans.js/commit/ba8232740f4ca9af2bcc7971aca3574612ef25b6))
+- `SeasonRankedPlayer` class for legend league ranking. ([#73](https://github.com/clashperk/clashofclans.js/pull/73)) ([ba82327](https://github.com/clashperk/clashofclans.js/commit/ba8232740f4ca9af2bcc7971aca3574612ef25b6))
 
 ## 2.0.1 (2021-11-27)
 
 ### Bug Fixes
 
--   IP retrieval method and Event Loop ([#70](https://github.com/clashperk/clashofclans.js/issues/70)) ([82b84ba](https://github.com/clashperk/clashofclans.js/commit/82b84ba5d96505c43b75e53aa07f547ef0b77778))
+- IP retrieval method and Event Loop ([#70](https://github.com/clashperk/clashofclans.js/issues/70)) ([82b84ba](https://github.com/clashperk/clashofclans.js/commit/82b84ba5d96505c43b75e53aa07f547ef0b77778))
 
 ## 2.0.0 (2021-11-26)
 
@@ -124,10 +143,10 @@ This new version is a complete TypeScript rewrite to convert everything from pla
 
 ### Features
 
--   HTTP Request Request Retries ([#26](https://github.com/clashperk/clashofclans.js/issues/26)) ([94585f3](https://github.com/clashperk/clashofclans.js/commit/94585f3a84a7175b2d07872f9eb9e42372b95e12))
--   Event Manager and Custom Events ([#37](https://github.com/clashperk/clashofclans.js/issues/37)) ([5027ae6](https://github.com/clashperk/clashofclans.js/commit/5027ae663a8e07175e17384c7e5706f4a1a7afb4))
--   Email Password Login ([#31](https://github.com/clashperk/clashofclans.js/issues/31)) ([4153cd3](https://github.com/clashperk/clashofclans.js/commit/4153cd37ea0e1c71550b9e892105b84d5a407e23))
--   Queue Throttler and Batch Throttler ([#34](https://github.com/clashperk/clashofclans.js/issues/34)) ([3a8f051](https://github.com/clashperk/clashofclans.js/commit/3a8f051552e93b98f89bc7d524acdecddf242718))
--   Override Request Options ([#36](https://github.com/clashperk/clashofclans.js/issues/36)) ([42d7fdd](https://github.com/clashperk/clashofclans.js/commit/42d7fdd36262cc46f23b731f8cffb9daea19d3b0))
--   Internal Caching Options ([#53](https://github.com/clashperk/clashofclans.js/issues/53)) ([984451d](https://github.com/clashperk/clashofclans.js/commit/30ea3240c11866008d0dae514468c0fdbb34ffd0))
--   Additional Properties for Player Units ([#65](https://github.com/clashperk/clashofclans.js/pull/65)) ([aa1696](https://github.com/clashperk/clashofclans.js/commit/aa1696243d96d4fed0250b4282c60522a6482343))
+- HTTP Request Request Retries ([#26](https://github.com/clashperk/clashofclans.js/issues/26)) ([94585f3](https://github.com/clashperk/clashofclans.js/commit/94585f3a84a7175b2d07872f9eb9e42372b95e12))
+- Event Manager and Custom Events ([#37](https://github.com/clashperk/clashofclans.js/issues/37)) ([5027ae6](https://github.com/clashperk/clashofclans.js/commit/5027ae663a8e07175e17384c7e5706f4a1a7afb4))
+- Email Password Login ([#31](https://github.com/clashperk/clashofclans.js/issues/31)) ([4153cd3](https://github.com/clashperk/clashofclans.js/commit/4153cd37ea0e1c71550b9e892105b84d5a407e23))
+- Queue Throttler and Batch Throttler ([#34](https://github.com/clashperk/clashofclans.js/issues/34)) ([3a8f051](https://github.com/clashperk/clashofclans.js/commit/3a8f051552e93b98f89bc7d524acdecddf242718))
+- Override Request Options ([#36](https://github.com/clashperk/clashofclans.js/issues/36)) ([42d7fdd](https://github.com/clashperk/clashofclans.js/commit/42d7fdd36262cc46f23b731f8cffb9daea19d3b0))
+- Internal Caching Options ([#53](https://github.com/clashperk/clashofclans.js/issues/53)) ([984451d](https://github.com/clashperk/clashofclans.js/commit/30ea3240c11866008d0dae514468c0fdbb34ffd0))
+- Additional Properties for Player Units ([#65](https://github.com/clashperk/clashofclans.js/pull/65)) ([aa1696](https://github.com/clashperk/clashofclans.js/commit/aa1696243d96d4fed0250b4282c60522a6482343))

package/README.md

@@ -25,6 +25,7 @@
 ```js
 const { Client } = require('clashofclans.js');
 const client = new Client();
+// const client = new Client({ keys: [], cache: true, retryLimit: 2, restRequestTimeout: 5000 });
 
 (async function () {
     await client.login({ email: 'developer@email.com', password: '***' });
@@ -34,32 +35,35 @@ const client = new Client();
 })();
 ```
 
-### Custom Event
+### Custom Polling Event
+
+> **Warning** <br />
+> Events are neither real-time nor supported by the API. They are polled frequently and compared with the cached data. If there is a difference, the event is emitted.
 
 ```js
-const { Client, BatchThrottler } = require('clashofclans.js');
-const client = new Client({
+const { PollingClient, BatchThrottler } = require('clashofclans.js');
+const pollingClient = new PollingClient({
     cache: true,
     retryLimit: 1,
     restRequestTimeout: 5000,
     throttler: new BatchThrottler(20)
 });
 
-client.events.addClans(['#8QU8J9LP', '#8P2QG08P']);
-client.events.setClanEvent({
+pollingClient.addClans(['#8QU8J9LP', '#8P2QG08P']);
+pollingClient.setClanEvent({
     name: 'clanDescriptionChange',
     filter: (oldClan, newClan) => {
         return oldClan.description !== newClan.description;
     }
 });
 
-client.on('clanDescriptionChange', (oldClan, newClan) => {
+pollingClient.on('clanDescriptionChange', (oldClan, newClan) => {
     console.log(oldClan.description, newClan.description);
 });
 
 (async function () {
-    await client.login({ email: 'developer@email.com', password: '***' });
-    await client.events.init();
+    await pollingClient.login({ email: 'developer@email.com', password: '***' });
+    await pollingClient.init();
 })();
 ```
 

package/dist/client/Client.d.ts

@@ -1,10 +1,34 @@
 /// <reference types="node" />
+import { EventEmitter } from 'node:events';
 import { ClanSearchOptions, SearchOptions, ClientOptions, LoginOptions, OverrideOptions } from '../types';
-import { CWLRounds } from '../util/Constants';
+import { CWLRounds, ClientEvents } from '../util/Constants';
 import { RESTManager } from '../rest/RESTManager';
-import { EventEmitter } from 'events';
 import { Util } from '../util/Util';
 import { Clan, ClanMember, ClanWar, ClanWarLog, League, Location, Player, WarLeague, RankedClan, RankedPlayer, Label, SeasonRankedPlayer, GoldPassSeason, ClanWarLeagueGroup } from '../struct';
+import { CapitalRaidSeason } from '../struct/CapitalRaidSeason';
+interface IClientEvents {
+    [ClientEvents.Error]: [error: unknown];
+    [ClientEvents.Debug]: [path: string, status: string, message: string];
+}
+export interface Client {
+    emit: (<K extends keyof IClientEvents>(event: K, ...args: IClientEvents[K]) => boolean) & (<S extends string | symbol>(event: Exclude<S, keyof IClientEvents>, ...args: any[]) => boolean);
+    off: (<K extends keyof IClientEvents>(event: K, listener: (...args: IClientEvents[K]) => void) => this) & (<S extends string | symbol>(event: Exclude<S, keyof IClientEvents>, listener: (...args: any[]) => void) => this);
+    on: (<K extends keyof IClientEvents>(event: K, listener: (...args: IClientEvents[K]) => void) => this) & (<S extends string | symbol>(event: Exclude<S, keyof IClientEvents>, listener: (...args: any[]) => void) => this);
+    once: (<K extends keyof IClientEvents>(event: K, listener: (...args: IClientEvents[K]) => void) => this) & (<S extends string | symbol>(event: Exclude<S, keyof IClientEvents>, listener: (...args: any[]) => void) => this);
+    removeAllListeners: (<K extends keyof IClientEvents>(event?: K) => this) & (<S extends string | symbol>(event?: Exclude<S, keyof IClientEvents>) => this);
+    /**
+     * Emitted for general debugging information.
+     * @public
+     * @event
+     */
+    debug: string;
+    /**
+     * Emitted when the client encounters an error.
+     * @public
+     * @event
+     */
+    error: string;
+}
 /**
  * Represents Clash of Clans API Client.
  * ```js
@@ -35,6 +59,8 @@ export declare class Client extends EventEmitter {
     getClan(clanTag: string, options?: OverrideOptions): Promise<Clan>;
     /** Get list of clan members. */
     getClanMembers(clanTag: string, options?: SearchOptions): Promise<ClanMember[]>;
+    /** Get capital raid seasons. */
+    getCapitalRaidSeasons(tag: string, options?: SearchOptions): Promise<CapitalRaidSeason[]>;
     /** Get clan war log. */
     getClanWarLog(clanTag: string, options?: SearchOptions): Promise<ClanWarLog[]>;
     /** Get info about currently running war (normal or friendly) in the clan. */
@@ -86,8 +112,10 @@ export declare class Client extends EventEmitter {
     getPlayers(playerTags: string[], options?: OverrideOptions): Promise<Player[]>;
     /** Verify Player API token that can be found from the Game settings. */
     verifyPlayerToken(playerTag: string, token: string, options?: OverrideOptions): Promise<boolean>;
-    /** Get list of Leagues. */
+    /** Get a list of Leagues. */
     getLeagues(options?: SearchOptions): Promise<League[]>;
+    /** Get a list of Capital Leagues. */
+    getCapitalLeagues(options?: SearchOptions): Promise<import("../types").APICapitalLeague[]>;
     /** Get Legend League season Ids. */
     getLeagueSeasons(options?: SearchOptions): Promise<string[]>;
     /** Get Legend League season rankings by season Id. */
@@ -120,6 +148,12 @@ export declare class Client extends EventEmitter {
      * For global ranking, use `global` as `locationId`.
      */
     getVersusPlayerRanks(locationId: number | 'global', options?: SearchOptions): Promise<RankedPlayer[]>;
+    /**
+     * Get clan capital rankings for a specific location.
+     *
+     * For global ranking, use `global` as `locationId`.
+     */
+    getClanCapitalRanks(locationId: number | 'global', options?: SearchOptions): Promise<import("../types").APIClanCapitalRanking[]>;
     /** Get list of clan labels. */
     getClanLabels(options?: SearchOptions): Promise<Label[]>;
     /** Get list of player labels. */
@@ -127,3 +161,4 @@ export declare class Client extends EventEmitter {
     /** Get info about gold pass season. */
     getGoldPassSeason(options?: OverrideOptions): Promise<GoldPassSeason>;
 }
+export {};

package/dist/client/Client.js

@@ -1,12 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Client = void 0;
+const node_events_1 = require("node:events");
 const Constants_1 = require("../util/Constants");
 const HTTPError_1 = require("../rest/HTTPError");
 const RESTManager_1 = require("../rest/RESTManager");
-const events_1 = require("events");
 const Util_1 = require("../util/Util");
 const struct_1 = require("../struct");
+const CapitalRaidSeason_1 = require("../struct/CapitalRaidSeason");
 /**
  * Represents Clash of Clans API Client.
  * ```js
@@ -14,10 +15,12 @@ const struct_1 = require("../struct");
  * const client = new Client({ keys: ['***'] });
  * ```
  */
-class Client extends events_1.EventEmitter {
+class Client extends node_events_1.EventEmitter {
     constructor(options) {
         super();
-        this.rest = new RESTManager_1.RESTManager({ ...options, rejectIfNotValid: true });
+        this.rest = new RESTManager_1.RESTManager({ ...options, rejectIfNotValid: true })
+            .on(Constants_1.RestEvents.Debug, this.emit.bind(this, Constants_1.RestEvents.Debug))
+            .on(Constants_1.RestEvents.Error, this.emit.bind(this, Constants_1.RestEvents.Error));
     }
     /** Contains various general-purpose utility methods. */
     get util() {
@@ -32,11 +35,11 @@ class Client extends events_1.EventEmitter {
      * ```
      */
     login(options) {
-        return this.rest.handler.init(options);
+        return this.rest.requestHandler.init(options);
     }
     /** Set Clash of Clans API keys. */
     setKeys(keys) {
-        this.rest.handler.setKeys(keys);
+        this.rest.requestHandler.setKeys(keys);
         return this;
     }
     /** Search clans by name and/or filtering parameters or get clans by their tags (fetches in parallel). */
@@ -60,6 +63,11 @@ class Client extends events_1.EventEmitter {
         const { data } = await this.rest.getClanMembers(clanTag, options);
         return data.items.map((entry) => new struct_1.ClanMember(this, entry));
     }
+    /** Get capital raid seasons. */
+    async getCapitalRaidSeasons(tag, options) {
+        const { data } = await this.rest.getCapitalRaidSeasons(tag, options);
+        return data.items.map((entry) => new CapitalRaidSeason_1.CapitalRaidSeason(this, entry));
+    }
     /** Get clan war log. */
     async getClanWarLog(clanTag, options) {
         const { data } = await this.rest.getClanWarLog(clanTag, options);
@@ -67,10 +75,7 @@ class Client extends events_1.EventEmitter {
     }
     /** Get info about currently running war (normal or friendly) in the clan. */
     async getClanWar(clanTag, options) {
-        const { data, maxAge, path, status } = await this.rest.getCurrentWar(clanTag, options);
-        if (data.state === 'notInWar') {
-            throw new HTTPError_1.HTTPError(HTTPError_1.NotInWarError, status, path, maxAge);
-        }
+        const { data, maxAge } = await this.rest.getCurrentWar(clanTag, options);
         return new struct_1.ClanWar(this, data, { clanTag, maxAge });
     }
     /**
@@ -140,7 +145,7 @@ class Client extends events_1.EventEmitter {
             return [await this.getClanWar(clanTag, options)];
         }
         try {
-            return this.getLeagueWars(clanTag, options);
+            return await this.getLeagueWars(clanTag, options);
         }
         catch (e) {
             if (e instanceof HTTPError_1.HTTPError && [404].includes(e.status)) {
@@ -151,19 +156,13 @@ class Client extends events_1.EventEmitter {
     }
     /** Get info about clan war league. */
     async getClanWarLeagueGroup(clanTag, options) {
-        const { data, status, path, maxAge } = await this.rest.getClanWarLeagueGroup(clanTag, options);
-        if (data.state === 'notInWar') {
-            throw new HTTPError_1.HTTPError(HTTPError_1.NotInWarError, status, path, maxAge);
-        }
+        const { data } = await this.rest.getClanWarLeagueGroup(clanTag, options);
         return new struct_1.ClanWarLeagueGroup(this, data);
     }
     /** Get info about a CWL round by WarTag. */
     async getClanWarLeagueRound(warTag, options) {
         const args = typeof warTag === 'string' ? { warTag } : { warTag: warTag.warTag, clanTag: warTag.clanTag };
-        const { data, maxAge, status, path } = await this.rest.getClanWarLeagueRound(args.warTag, options);
-        if (data.state === 'notInWar') {
-            throw new HTTPError_1.HTTPError(HTTPError_1.NotInWarError, status, path, maxAge);
-        }
+        const { data, maxAge } = await this.rest.getClanWarLeagueRound(args.warTag, options);
         return new struct_1.ClanWar(this, data, { warTag: args.warTag, clanTag: args.clanTag, maxAge });
     }
     /** Get info about a player by tag. */
@@ -182,11 +181,16 @@ class Client extends events_1.EventEmitter {
         const { data } = await this.rest.verifyPlayerToken(playerTag, token, options);
         return data.status === 'ok';
     }
-    /** Get list of Leagues. */
+    /** Get a list of Leagues. */
     async getLeagues(options) {
         const { data } = await this.rest.getLeagues(options);
         return data.items.map((entry) => new struct_1.League(entry));
     }
+    /** Get a list of Capital Leagues. */
+    async getCapitalLeagues(options) {
+        const { data } = await this.rest.getCapitalLeagues(options);
+        return data.items;
+    }
     /** Get Legend League season Ids. */
     async getLeagueSeasons(options) {
         const { data } = await this.rest.getLeagueSeasons(Constants_1.LegendLeagueId, options);
@@ -243,6 +247,15 @@ class Client extends events_1.EventEmitter {
         const { data } = await this.rest.getVersusPlayerRanks(locationId, options);
         return data.items.map((entry) => new struct_1.RankedPlayer(this, entry));
     }
+    /**
+     * Get clan capital rankings for a specific location.
+     *
+     * For global ranking, use `global` as `locationId`.
+     */
+    async getClanCapitalRanks(locationId, options) {
+        const { data } = await this.rest.getClanCapitalRanks(locationId, options);
+        return data.items;
+    }
     /** Get list of clan labels. */
     async getClanLabels(options) {
         const { data } = await this.rest.getClanLabels(options);

package/dist/client/PollingClient.d.ts

@@ -2,20 +2,101 @@ import { Clan, ClanWar, Player } from '../struct';
 import { ClientOptions } from '../types';
 import { PollingEvents } from '../util/Constants';
 import { Client } from './Client';
-import { PollingEventManager } from './EventManager';
 /**
- * Represents Clash of Clans Polling Event Client.
+ * Represents a Polling Event Client.
  * ```js
  * const { PollingClient } = require('clashofclans.js');
- * const client = new PollingClient({ keys: ['***'] });
+ * const pollingClient = new PollingClient({ keys: ['***'] });
  * ```
  */
 export declare class PollingClient extends Client {
-    /** Polling Event Manager for the client. */
-    pollingEvents: PollingEventManager;
+    private readonly _clanTags;
+    private readonly _playerTags;
+    private readonly _warTags;
+    private readonly _clans;
+    private readonly _players;
+    private readonly _wars;
+    private readonly _pollingEvents;
+    inMaintenance: boolean;
+    private _maintenanceStartTime;
     constructor(options?: ClientOptions);
-    /** Whether the API is in maintenance break. */
-    get inMaintenance(): any;
+    /** Initialize the PollingEvent Manager to start pulling the data by polling api. */
+    init(): Promise<string[]>;
+    /** Add clan tags to clan polling events. */
+    addClans(tags: string[] | string): this;
+    /** Delete clan tags from clan polling events. */
+    deleteClans(tags: string[] | string): this;
+    /** Add player tags for player polling events. */
+    addPlayers(tags: string[] | string): this;
+    /** Delete player tags from player polling events. */
+    deletePlayers(tags: string[] | string): this;
+    /** Add clan tags for war polling events. */
+    addWars(tags: string[] | string): this;
+    /** Delete clan tags from war polling events. */
+    deleteWars(tags: string[] | string): this;
+    /**
+     * Set your own custom clan polling event.
+     *
+     * In order to emit the custom polling event, you must have this filter function that returns a boolean.
+     *
+     * @example
+     * ```js
+     * client.addClans(['#2PP', '#8QU8J9LP']);
+     *
+     * client.setClanEvent({
+     *   name: 'clanMemberUpdate',
+     *   filter: (oldClan, newClan) => {
+     *     return oldClan.memberCount !== newClan.memberCount;
+     *   }
+     * });
+     *
+     * client.on('clanMemberUpdate', (oldClan, newClan) => {
+     *   console.log(oldClan.memberCount, newClan.memberCount);
+     * });
+     *
+     * (async function () {
+     *   await client.init();
+     * })();
+     * ```
+     * @returns
+     */
+    setClanEvent(event: {
+        name: string;
+        filter: (oldClan: Clan, newClan: Clan) => boolean;
+    }): this;
+    /**
+     * Set your own custom war event.
+     *
+     * In order to emit the custom event, you must have this filter function that returns a boolean.
+     */
+    setWarEvent(event: {
+        name: string;
+        filter: (oldWar: ClanWar, newWar: ClanWar) => boolean;
+    }): this;
+    /**
+     * Set your own custom player event.
+     *
+     * In order to emit the custom event, you must have this filter function that returns a boolean.
+     */
+    setPlayerEvent(event: {
+        name: string;
+        filter: (oldPlayer: Player, newPlayer: Player) => boolean;
+    }): this;
+    private maintenanceHandler;
+    private seasonEndHandler;
+    private clanUpdateHandler;
+    private playerUpdateHandler;
+    private warUpdateHandler;
+    private runClanUpdate;
+    private runPlayerUpdate;
+    private runWarUpdate;
+}
+export interface PollingClient {
+    emit: (<K extends keyof IPollingEvents>(event: K, ...args: IPollingEvents[K]) => boolean) & (<S extends string | symbol>(event: Exclude<S, keyof IPollingEvents>, ...args: any[]) => boolean);
+    off: (<K extends keyof IPollingEvents>(event: K, listener: (...args: IPollingEvents[K]) => void) => this) & (<S extends string | symbol>(event: Exclude<S, keyof IPollingEvents>, listener: (...args: any[]) => void) => this);
+    on: (<K extends keyof IPollingEvents>(event: K, listener: (...args: IPollingEvents[K]) => void) => this) & (<S extends string | symbol>(event: Exclude<S, keyof IPollingEvents>, listener: (...args: any[]) => void) => this);
+    once: (<K extends keyof IPollingEvents>(event: K, listener: (...args: IPollingEvents[K]) => void) => this) & (<S extends string | symbol>(event: Exclude<S, keyof IPollingEvents>, listener: (...args: any[]) => void) => this);
+    removeAllListeners: (<K extends keyof IPollingEvents>(event?: K) => this) & (<S extends string | symbol>(event?: Exclude<S, keyof IPollingEvents>) => this);
     /**
      * Emits when a new season starts.
      *
@@ -27,13 +108,13 @@ export declare class PollingClient extends Client {
      * @public
      * @event
      */
-    private static newSeasonStart;
+    newSeasonStart: string;
     /**
      * Emits when maintenance break starts in the API.
      * @public
      * @event
      */
-    private static maintenanceStart;
+    maintenanceStart: string;
     /**
      * Emits when maintenance break ends in the API.
      *
@@ -45,39 +126,31 @@ export declare class PollingClient extends Client {
      * @public
      * @event
      */
-    private static maintenanceEnd;
-    /** @internal */
-    on<K extends keyof ClientPollingEvents>(event: K, listeners: (...args: ClientPollingEvents[K]) => void): this;
-    /** @internal */
-    on<S extends keyof CustomEvents>(event: Exclude<S, keyof ClientPollingEvents>, listeners: (...args: CustomEvents[S]) => void): this;
-    /** @internal */ on<S extends string | symbol>(event: Exclude<S, keyof ClientPollingEvents>, listeners: (...args: any[]) => void): this;
-    /** @internal */
-    once<K extends keyof ClientPollingEvents>(event: K, listeners: (...args: ClientPollingEvents[K]) => void): this;
-    /** @internal */
-    once<S extends keyof CustomEvents>(event: Exclude<S, keyof ClientPollingEvents>, listeners: (...args: CustomEvents[S]) => void): this;
-    /** @internal */ once<S extends string | symbol>(event: Exclude<S, keyof ClientPollingEvents>, listeners: (...args: any[]) => void): this;
-    /** @internal */
-    emit<K extends keyof ClientPollingEvents>(event: K, ...args: ClientPollingEvents[K]): boolean;
-    /** @internal */
-    emit<S extends keyof CustomEvents>(event: Exclude<S, keyof ClientPollingEvents>, ...args: CustomEvents[S]): this;
-    /** @internal */ emit<S extends string | symbol>(event: Exclude<S, keyof ClientPollingEvents>, ...args: any[]): boolean;
+    maintenanceEnd: string;
+    /**
+     * Emitted for general debugging information.
+     * @public
+     * @event
+     */
+    debug: string;
+    /**
+     * Emitted when the client encounters an error.
+     * @public
+     * @event
+     */
+    error: string;
 }
-interface ClientPollingEvents {
-    [PollingEvents.NewSeasonStart]: [id: string];
-    [PollingEvents.MaintenanceStart]: [];
-    [PollingEvents.MaintenanceEnd]: [duration: number];
+interface IPollingEvents {
     [PollingEvents.ClanLoopStart]: [];
     [PollingEvents.ClanLoopEnd]: [];
     [PollingEvents.PlayerLoopStart]: [];
     [PollingEvents.PlayerLoopEnd]: [];
     [PollingEvents.WarLoopStart]: [];
     [PollingEvents.WarLoopEnd]: [];
+    [PollingEvents.NewSeasonStart]: [id: string];
+    [PollingEvents.MaintenanceStart]: [];
+    [PollingEvents.MaintenanceEnd]: [duration: number];
     [PollingEvents.Error]: [error: unknown];
     [PollingEvents.Debug]: [path: string, status: string, message: string];
 }
-interface CustomEvents {
-    [key: `clan${string}`]: [oldClan: Clan, newClan: Clan];
-    [key: `war${string}`]: [oldWar: ClanWar, newWar: ClanWar];
-    [key: `player${string}`]: [oldPlayer: Player, newPlayer: Player];
-}
 export {};