clashofclans.js 2.8.4 → 3.0.0-dev.f6ce42f

package/CHANGELOG.md

@@ -2,17 +2,6 @@
 
 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.
 
-## 2.8.3 (2022-09-13)
-
-### Bug Fixes
-
-- Conflict with the same name of builder base and home base troops. ([#123](https://github.com/clashperk/clashofclans.js/pull/123))
-- Fix the issue with the `Client#getLeagueWar()` method.
-
-### Features
-
-- Clan Capital related properties and typings.
-
 ## 2.8.0 (2022-07-22)
 
 ### Features

package/dist/client/Client.d.ts

@@ -1,9 +1,8 @@
 /// <reference types="node" />
+import { EventEmitter } from 'node:events';
 import { ClanSearchOptions, SearchOptions, ClientOptions, LoginOptions, OverrideOptions } from '../types';
-import { EVENTS, CWL_ROUNDS } from '../util/Constants';
+import { CWLRounds } from '../util/Constants';
 import { RESTManager } from '../rest/RESTManager';
-import { EventManager } from './EventManager';
-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';
 /**
@@ -14,15 +13,11 @@ import { Clan, ClanMember, ClanWar, ClanWarLog, League, Location, Player, WarLea
  * ```
  */
 export declare class Client extends EventEmitter {
-    /** Event Manager for the client. */
-    events: EventManager;
     /** REST Handler of the client. */
     rest: RESTManager;
     constructor(options?: ClientOptions);
     /** Contains various general-purpose utility methods. */
     get util(): typeof Util;
-    /** Whether the API is in maintenance break. */
-    get inMaintenance(): boolean;
     /**
      * Initialize the client to create keys.
      * @example
@@ -57,7 +52,7 @@ export declare class Client extends EventEmitter {
      */
     getCurrentWar(clanTag: string | {
         clanTag: string;
-        round?: keyof typeof CWL_ROUNDS;
+        round?: keyof typeof CWLRounds;
     }, options?: OverrideOptions): Promise<ClanWar | null>;
     /**
      * Get info about currently running CWL round.
@@ -72,7 +67,7 @@ export declare class Client extends EventEmitter {
      */
     getLeagueWar(clanTag: string | {
         clanTag: string;
-        round?: keyof typeof CWL_ROUNDS;
+        round?: keyof typeof CWLRounds;
     }, options?: OverrideOptions): Promise<ClanWar | null>;
     /** Returns active wars (last 2) of the CWL group. */
     getLeagueWars(clanTag: string, options?: OverrideOptions): Promise<ClanWar[]>;
@@ -131,68 +126,4 @@ export declare class Client extends EventEmitter {
     getPlayerLabels(options?: SearchOptions): Promise<Label[]>;
     /** Get info about gold pass season. */
     getGoldPassSeason(options?: OverrideOptions): Promise<GoldPassSeason>;
-    /**
-     * Emits when a new season starts.
-     *
-     * **Parameters**
-     *
-     * | Name |   Type   | Description           |
-     * | :--: | :------: | :-------------------: |
-     * | `id` | `string` | Id of the new season. |
-     * @public
-     * @event
-     */
-    private static newSeasonStart;
-    /**
-     * Emits when maintenance break starts in the API.
-     * @public
-     * @event
-     */
-    private static maintenanceStart;
-    /**
-     * Emits when maintenance break ends in the API.
-     *
-     * **Parameters**
-     *
-     * |    Name    |   Type   |                    Description                     |
-     * | :--------: | :------: | :------------------------------------------------: |
-     * | `duration` | `number` | Duration of the maintenance break in milliseconds. |
-     * @public
-     * @event
-     */
-    private static maintenanceEnd;
-    /** @internal */
-    on<K extends keyof ClientEvents>(event: K, listeners: (...args: ClientEvents[K]) => void): this;
-    /** @internal */
-    on<S extends keyof CustomEvents>(event: Exclude<S, keyof ClientEvents>, listeners: (...args: CustomEvents[S]) => void): this;
-    /** @internal */ on<S extends string | symbol>(event: Exclude<S, keyof ClientEvents>, listeners: (...args: any[]) => void): this;
-    /** @internal */
-    once<K extends keyof ClientEvents>(event: K, listeners: (...args: ClientEvents[K]) => void): this;
-    /** @internal */
-    once<S extends keyof CustomEvents>(event: Exclude<S, keyof ClientEvents>, listeners: (...args: CustomEvents[S]) => void): this;
-    /** @internal */ once<S extends string | symbol>(event: Exclude<S, keyof ClientEvents>, listeners: (...args: any[]) => void): this;
-    /** @internal */
-    emit<K extends keyof ClientEvents>(event: K, ...args: ClientEvents[K]): boolean;
-    /** @internal */
-    emit<S extends keyof CustomEvents>(event: Exclude<S, keyof ClientEvents>, ...args: CustomEvents[S]): this;
-    /** @internal */ emit<S extends string | symbol>(event: Exclude<S, keyof ClientEvents>, ...args: any[]): boolean;
-}
-interface ClientEvents {
-    [EVENTS.NEW_SEASON_START]: [id: string];
-    [EVENTS.MAINTENANCE_START]: [];
-    [EVENTS.MAINTENANCE_END]: [duration: number];
-    [EVENTS.CLAN_LOOP_START]: [];
-    [EVENTS.CLAN_LOOP_END]: [];
-    [EVENTS.PLAYER_LOOP_START]: [];
-    [EVENTS.PLAYER_LOOP_END]: [];
-    [EVENTS.WAR_LOOP_START]: [];
-    [EVENTS.WAR_LOOP_END]: [];
-    [EVENTS.ERROR]: [error: unknown];
-    [EVENTS.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 {};

package/dist/client/Client.js

@@ -1,11 +1,10 @@
 "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 EventManager_1 = require("./EventManager");
-const events_1 = require("events");
 const Util_1 = require("../util/Util");
 const struct_1 = require("../struct");
 /**
@@ -15,21 +14,15 @@ 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.events = new EventManager_1.EventManager(this);
     }
     /** Contains various general-purpose utility methods. */
     get util() {
         return Util_1.Util;
     }
-    /** Whether the API is in maintenance break. */
-    get inMaintenance() {
-        // @ts-expect-error
-        return this.events._inMaintenance;
-    }
     /**
      * Initialize the client to create keys.
      * @example
@@ -116,7 +109,7 @@ class Client extends events_1.EventEmitter {
      */
     async getLeagueWar(clanTag, options) {
         const args = typeof clanTag === 'string' ? { clanTag } : { clanTag: clanTag.clanTag, round: clanTag.round };
-        const state = (args.round && Constants_1.CWL_ROUNDS[args.round]) ?? 'inWar'; // eslint-disable-line
+        const state = (args.round && Constants_1.CWLRounds[args.round]) ?? 'inWar'; // eslint-disable-line
         const data = await this.getClanWarLeagueGroup(args.clanTag, options);
         const rounds = data.rounds.filter((round) => !round.warTags.includes('#0'));
         if (!rounds.length)
@@ -128,7 +121,7 @@ class Client extends events_1.EventEmitter {
             .flat()
             .reverse();
         const wars = await this.util.allSettled(warTags.map((warTag) => this.getClanWarLeagueRound({ warTag, clanTag: args.clanTag }, { ...options, ignoreRateLimit: true })));
-        if (args.round && args.round in Constants_1.CWL_ROUNDS) {
+        if (args.round && args.round in Constants_1.CWLRounds) {
             return wars.find((war) => war.clan.tag === args.clanTag && war.state === state) ?? null;
         }
         return (wars.find((war) => war.clan.tag === args.clanTag && war.state === state) ??
@@ -147,7 +140,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)) {
@@ -196,12 +189,12 @@ class Client extends events_1.EventEmitter {
     }
     /** Get Legend League season Ids. */
     async getLeagueSeasons(options) {
-        const { data } = await this.rest.getLeagueSeasons(Constants_1.LEGEND_LEAGUE_ID, options);
+        const { data } = await this.rest.getLeagueSeasons(Constants_1.LegendLeagueId, options);
         return data.items.map((league) => league.id);
     }
     /** Get Legend League season rankings by season Id. */
     async getSeasonRankings(seasonId, options) {
-        const { data } = await this.rest.getSeasonRankings(Constants_1.LEGEND_LEAGUE_ID, seasonId, options);
+        const { data } = await this.rest.getSeasonRankings(Constants_1.LegendLeagueId, seasonId, options);
         return data.items.map((entry) => new struct_1.SeasonRankedPlayer(this, entry));
     }
     /** Get list of Clan War Leagues. */

package/dist/client/PollingClient.d.ts

@@ -0,0 +1,157 @@
+import { Clan, ClanWar, Player } from '../struct';
+import { ClientOptions } from '../types';
+import { PollingEvents } from '../util/Constants';
+import { Client } from './Client';
+/**
+ * Represents Clash of Clans Polling Event Client.
+ * ```js
+ * const { PollingClient } = require('clashofclans.js');
+ * const client = new PollingClient({ keys: ['***'] });
+ * ```
+ */
+export declare class PollingClient extends Client {
+    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);
+    /** 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.pollingEvents.addClans(['#2PP', '#8QU8J9LP']);
+     *
+     * client.pollingEvents.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.pollingEvents.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;
+    /**
+     * Emits when a new season starts.
+     *
+     * **Parameters**
+     *
+     * | Name |   Type   | Description           |
+     * | :--: | :------: | :-------------------: |
+     * | `id` | `string` | Id of the new season. |
+     * @public
+     * @event
+     */
+    private static newSeasonStart;
+    /**
+     * Emits when maintenance break starts in the API.
+     * @public
+     * @event
+     */
+    private static maintenanceStart;
+    /**
+     * Emits when maintenance break ends in the API.
+     *
+     * **Parameters**
+     *
+     * |    Name    |   Type   |                    Description                     |
+     * | :--------: | :------: | :------------------------------------------------: |
+     * | `duration` | `number` | Duration of the maintenance break in milliseconds. |
+     * @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;
+}
+interface ClientPollingEvents {
+    [PollingEvents.NewSeasonStart]: [id: string];
+    [PollingEvents.MaintenanceStart]: [];
+    [PollingEvents.MaintenanceEnd]: [duration: number];
+    [PollingEvents.ClanLoopStart]: [];
+    [PollingEvents.ClanLoopEnd]: [];
+    [PollingEvents.PlayerLoopStart]: [];
+    [PollingEvents.PlayerLoopEnd]: [];
+    [PollingEvents.WarLoopStart]: [];
+    [PollingEvents.WarLoopEnd]: [];
+    [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 {};