clashofclans.js 2.8.2 → 3.0.0-dev.392ca4c

package/dist/client/Client.d.ts

@@ -1,8 +1,7 @@
 /// <reference types="node" />
 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

@@ -4,7 +4,6 @@ exports.Client = void 0;
 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");
@@ -19,17 +18,11 @@ class Client extends 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) ??
@@ -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/EventManager.d.ts

@@ -1,42 +1,42 @@
 import { Clan, ClanWar, Player } from '../struct';
-import { Client } from './Client';
-/** Represents Event Manager of the {@link Client}. */
-export declare class EventManager {
-    private readonly client;
+import { PollingClient } from './PollingClient';
+/** Represents PollingEvent Manager of the {@link PollingClient}. */
+export declare class PollingEventManager {
+    private readonly pollingClient;
     private readonly _clanTags;
     private readonly _playerTags;
     private readonly _warTags;
     private readonly _clans;
     private readonly _players;
     private readonly _wars;
-    private readonly _events;
+    private readonly _pollingEvents;
     private _inMaintenance;
     private _maintenanceStartTime;
-    constructor(client: Client);
-    /** Initialize the Event Manager to start pulling. */
+    constructor(pollingClient: PollingClient);
+    /** Initialize the PollingEvent Manager to start pulling the data by polling api. */
     init(): Promise<string[]>;
-    /** Add clan tags to clan events. */
+    /** Add clan tags to clan polling events. */
     addClans(tags: string[] | string): this;
-    /** Delete clan tags from clan events. */
+    /** Delete clan tags from clan polling events. */
     deleteClans(tags: string[] | string): this;
-    /** Add player tags for player events. */
+    /** Add player tags for player polling events. */
     addPlayers(tags: string[] | string): this;
-    /** Delete player tags from player events. */
+    /** Delete player tags from player polling events. */
     deletePlayers(tags: string[] | string): this;
-    /** Add clan tags for war events. */
+    /** Add clan tags for war polling events. */
     addWars(tags: string[] | string): this;
-    /** Delete clan tags from war events. */
+    /** Delete clan tags from war polling events. */
     deleteWars(tags: string[] | string): this;
     /**
-     * Set your own custom clan event.
+     * Set your own custom clan polling event.
      *
-     * In order to emit the custom event, you must have this filter function that returns a boolean.
+     * In order to emit the custom polling event, you must have this filter function that returns a boolean.
      *
      * @example
      * ```js
-     * client.events.addClans(['#2PP', '#8QU8J9LP']);
+     * client.pollingEvents.addClans(['#2PP', '#8QU8J9LP']);
      *
-     * client.events.setClanEvent({
+     * client.pollingEvents.setClanEvent({
      *   name: 'clanMemberUpdate',
      *   filter: (oldClan, newClan) => {
      *     return oldClan.memberCount !== newClan.memberCount;
@@ -48,7 +48,7 @@ export declare class EventManager {
      * });
      *
      * (async function () {
-     *   await client.events.init();
+     *   await client.pollingEvents.init();
      * })();
      * ```
      * @returns

package/dist/client/EventManager.js

@@ -1,20 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EventManager = void 0;
+exports.PollingEventManager = void 0;
 const HTTPError_1 = require("../rest/HTTPError");
 const Constants_1 = require("../util/Constants");
 const Util_1 = require("../util/Util");
-/** Represents Event Manager of the {@link Client}. */
-class EventManager {
-    constructor(client) {
-        this.client = client;
+/** Represents PollingEvent Manager of the {@link PollingClient}. */
+class PollingEventManager {
+    constructor(pollingClient) {
+        this.pollingClient = pollingClient;
         this._clanTags = new Set();
         this._playerTags = new Set();
         this._warTags = new Set();
         this._clans = new Map();
         this._players = new Map();
         this._wars = new Map();
-        this._events = {
+        this._pollingEvents = {
             clans: [],
             wars: [],
             players: []
@@ -22,58 +22,58 @@ class EventManager {
         this._inMaintenance = Boolean(false);
         this._maintenanceStartTime = null;
     }
-    /** Initialize the Event Manager to start pulling. */
+    /** Initialize the PollingEvent Manager to start pulling the data by polling api. */
     async init() {
         this.seasonEndHandler();
         this.maintenanceHandler();
         this.clanUpdateHandler();
         this.playerUpdateHandler();
         this.warUpdateHandler();
-        return Promise.resolve(this.client.eventNames());
+        return Promise.resolve(this.pollingClient.eventNames());
     }
-    /** Add clan tags to clan events. */
+    /** Add clan tags to clan polling events. */
     addClans(tags) {
         for (const tag of Array.isArray(tags) ? tags : [tags]) {
-            this._clanTags.add(this.client.util.formatTag(tag));
+            this._clanTags.add(this.pollingClient.util.formatTag(tag));
         }
         return this;
     }
-    /** Delete clan tags from clan events. */
+    /** Delete clan tags from clan polling events. */
     deleteClans(tags) {
         for (const tag of Array.isArray(tags) ? tags : [tags]) {
-            const key = this.client.util.formatTag(tag);
+            const key = this.pollingClient.util.formatTag(tag);
             this._clans.delete(key);
             this._clanTags.delete(key);
         }
         return this;
     }
-    /** Add player tags for player events. */
+    /** Add player tags for player polling events. */
     addPlayers(tags) {
         for (const tag of Array.isArray(tags) ? tags : [tags]) {
-            this._playerTags.add(this.client.util.formatTag(tag));
+            this._playerTags.add(this.pollingClient.util.formatTag(tag));
         }
         return this;
     }
-    /** Delete player tags from player events. */
+    /** Delete player tags from player polling events. */
     deletePlayers(tags) {
         for (const tag of Array.isArray(tags) ? tags : [tags]) {
-            const key = this.client.util.formatTag(tag);
+            const key = this.pollingClient.util.formatTag(tag);
             this._players.delete(key);
             this._playerTags.delete(key);
         }
         return this;
     }
-    /** Add clan tags for war events. */
+    /** Add clan tags for war polling events. */
     addWars(tags) {
         for (const tag of Array.isArray(tags) ? tags : [tags]) {
-            this._warTags.add(this.client.util.formatTag(tag));
+            this._warTags.add(this.pollingClient.util.formatTag(tag));
         }
         return this;
     }
-    /** Delete clan tags from war events. */
+    /** Delete clan tags from war polling events. */
     deleteWars(tags) {
         for (const tag of Array.isArray(tags) ? tags : [tags]) {
-            const key = this.client.util.formatTag(tag);
+            const key = this.pollingClient.util.formatTag(tag);
             this._wars.delete(`${key}:${1}`);
             this._wars.delete(`${key}:${2}`);
             this._warTags.delete(key);
@@ -81,15 +81,15 @@ class EventManager {
         return this;
     }
     /**
-     * Set your own custom clan event.
+     * Set your own custom clan polling event.
      *
-     * In order to emit the custom event, you must have this filter function that returns a boolean.
+     * In order to emit the custom polling event, you must have this filter function that returns a boolean.
      *
      * @example
      * ```js
-     * client.events.addClans(['#2PP', '#8QU8J9LP']);
+     * client.pollingEvents.addClans(['#2PP', '#8QU8J9LP']);
      *
-     * client.events.setClanEvent({
+     * client.pollingEvents.setClanEvent({
      *   name: 'clanMemberUpdate',
      *   filter: (oldClan, newClan) => {
      *     return oldClan.memberCount !== newClan.memberCount;
@@ -101,7 +101,7 @@ class EventManager {
      * });
      *
      * (async function () {
-     *   await client.events.init();
+     *   await client.pollingEvents.init();
      * })();
      * ```
      * @returns
@@ -111,7 +111,7 @@ class EventManager {
             throw new Error('Event name is required.');
         if (typeof event.filter !== 'function')
             throw new Error('Filter function is required.');
-        this._events.clans.push(event);
+        this._pollingEvents.clans.push(event);
         return this;
     }
     /**
@@ -124,7 +124,7 @@ class EventManager {
             throw new Error('Event name is required.');
         if (typeof event.filter !== 'function')
             throw new Error('Filter function is required.');
-        this._events.wars.push(event);
+        this._pollingEvents.wars.push(event);
         return this;
     }
     /**
@@ -137,25 +137,25 @@ class EventManager {
             throw new Error('Event name is required.');
         if (typeof event.filter !== 'function')
             throw new Error('Filter function is required.');
-        this._events.players.push(event);
+        this._pollingEvents.players.push(event);
         return this;
     }
     async maintenanceHandler() {
         setTimeout(this.maintenanceHandler.bind(this), 10000).unref();
         try {
-            const res = await this.client.rest.getClans({ maxMembers: Math.floor(Math.random() * 40) + 10, limit: 1 });
+            const res = await this.pollingClient.rest.getClans({ maxMembers: Math.floor(Math.random() * 40) + 10, limit: 1 });
             if (res.status === 200 && this._inMaintenance) {
                 this._inMaintenance = Boolean(false);
                 const duration = Date.now() - this._maintenanceStartTime.getTime();
                 this._maintenanceStartTime = null;
-                this.client.emit(Constants_1.EVENTS.MAINTENANCE_END, duration);
+                this.pollingClient.emit(Constants_1.PollingEvents.MaintenanceEnd, duration);
             }
         }
         catch (error) {
             if (error instanceof HTTPError_1.HTTPError && error.status === 503 && !this._inMaintenance) {
                 this._inMaintenance = Boolean(true);
                 this._maintenanceStartTime = new Date();
-                this.client.emit(Constants_1.EVENTS.MAINTENANCE_START);
+                this.pollingClient.emit(Constants_1.PollingEvents.MaintenanceStart);
             }
         }
     }
@@ -167,48 +167,48 @@ class EventManager {
         }
         else if (end > 0) {
             setTimeout(() => {
-                this.client.emit(Constants_1.EVENTS.NEW_SEASON_START, Util_1.Util.getSeasonId());
+                this.pollingClient.emit(Constants_1.PollingEvents.NewSeasonStart, Util_1.Util.getSeasonId());
             }, end + 100).unref();
         }
     }
     async clanUpdateHandler() {
-        this.client.emit(Constants_1.EVENTS.CLAN_LOOP_START);
+        this.pollingClient.emit(Constants_1.PollingEvents.ClanLoopStart);
         for (const tag of this._clanTags)
             await this.runClanUpdate(tag);
-        this.client.emit(Constants_1.EVENTS.CLAN_LOOP_END);
+        this.pollingClient.emit(Constants_1.PollingEvents.ClanLoopEnd);
         setTimeout(this.clanUpdateHandler.bind(this), 10000);
     }
     async playerUpdateHandler() {
-        this.client.emit(Constants_1.EVENTS.PLAYER_LOOP_START);
+        this.pollingClient.emit(Constants_1.PollingEvents.PlayerLoopStart);
         for (const tag of this._playerTags)
             await this.runPlayerUpdate(tag);
-        this.client.emit(Constants_1.EVENTS.PLAYER_LOOP_END);
+        this.pollingClient.emit(Constants_1.PollingEvents.PlayerLoopEnd);
         setTimeout(this.playerUpdateHandler.bind(this), 10000);
     }
     async warUpdateHandler() {
-        this.client.emit(Constants_1.EVENTS.WAR_LOOP_START);
+        this.pollingClient.emit(Constants_1.PollingEvents.WarLoopStart);
         for (const tag of this._warTags)
             await this.runWarUpdate(tag);
-        this.client.emit(Constants_1.EVENTS.WAR_LOOP_END);
+        this.pollingClient.emit(Constants_1.PollingEvents.WarLoopEnd);
         setTimeout(this.warUpdateHandler.bind(this), 10000);
     }
     async runClanUpdate(tag) {
         if (this._inMaintenance)
             return null;
-        const clan = await this.client.getClan(tag).catch(() => null);
+        const clan = await this.pollingClient.getClan(tag).catch(() => null);
         if (!clan)
             return null;
         const cached = this._clans.get(clan.tag);
         if (!cached)
             return this._clans.set(clan.tag, clan);
-        for (const { name, filter } of this._events.clans) {
+        for (const { name, filter } of this._pollingEvents.clans) {
             try {
                 if (!(await filter(cached, clan)))
                     continue;
-                this.client.emit(name, cached, clan);
+                this.pollingClient.emit(name, cached, clan);
             }
             catch (error) {
-                this.client.emit(Constants_1.EVENTS.ERROR, error);
+                this.pollingClient.emit(Constants_1.PollingEvents.Error, error);
             }
         }
         return this._clans.set(clan.tag, clan);
@@ -216,20 +216,20 @@ class EventManager {
     async runPlayerUpdate(tag) {
         if (this._inMaintenance)
             return null;
-        const player = await this.client.getPlayer(tag).catch(() => null);
+        const player = await this.pollingClient.getPlayer(tag).catch(() => null);
         if (!player)
             return null;
         const cached = this._players.get(player.tag);
         if (!cached)
             return this._players.set(player.tag, player);
-        for (const { name, filter } of this._events.players) {
+        for (const { name, filter } of this._pollingEvents.players) {
             try {
                 if (!(await filter(cached, player)))
                     continue;
-                this.client.emit(name, cached, player);
+                this.pollingClient.emit(name, cached, player);
             }
             catch (error) {
-                this.client.emit(Constants_1.EVENTS.ERROR, error);
+                this.pollingClient.emit(Constants_1.PollingEvents.Error, error);
             }
         }
         return this._players.set(player.tag, player);
@@ -237,7 +237,7 @@ class EventManager {
     async runWarUpdate(tag) {
         if (this._inMaintenance)
             return null;
-        const clanWars = await this.client.getWars(tag).catch(() => null);
+        const clanWars = await this.pollingClient.getWars(tag).catch(() => null);
         if (!clanWars?.length)
             return null;
         clanWars.forEach(async (war, index) => {
@@ -245,28 +245,28 @@ class EventManager {
             const cached = this._wars.get(key);
             if (!cached)
                 return this._wars.set(key, war);
-            for (const { name, filter } of this._events.wars) {
+            for (const { name, filter } of this._pollingEvents.wars) {
                 try {
                     if (!(await filter(cached, war)))
                         continue;
-                    this.client.emit(name, cached, war);
+                    this.pollingClient.emit(name, cached, war);
                 }
                 catch (error) {
-                    this.client.emit(Constants_1.EVENTS.ERROR, error);
+                    this.pollingClient.emit(Constants_1.PollingEvents.Error, error);
                 }
             }
             // check for war end
             if (index === 1 && cached.warTag !== war.warTag) {
-                const data = await this.client.getLeagueWar({ clanTag: tag, round: 'PREVIOUS_ROUND' }).catch(() => null);
+                const data = await this.pollingClient.getLeagueWar({ clanTag: tag, round: 'PreviousRound' }).catch(() => null);
                 if (data && data.warTag === cached.warTag) {
-                    for (const { name, filter } of this._events.wars) {
+                    for (const { name, filter } of this._pollingEvents.wars) {
                         try {
                             if (!(await filter(cached, data)))
                                 continue;
-                            this.client.emit(name, cached, data);
+                            this.pollingClient.emit(name, cached, data);
                         }
                         catch (error) {
-                            this.client.emit(Constants_1.EVENTS.ERROR, error);
+                            this.pollingClient.emit(Constants_1.PollingEvents.Error, error);
                         }
                     }
                 }
@@ -275,4 +275,4 @@ class EventManager {
         });
     }
 }
-exports.EventManager = EventManager;
+exports.PollingEventManager = PollingEventManager;

package/dist/client/PollingClient.d.ts

@@ -0,0 +1,83 @@
+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.
+ * ```js
+ * const { PollingClient } = require('clashofclans.js');
+ * const client = new PollingClient({ keys: ['***'] });
+ * ```
+ */
+export declare class PollingClient extends Client {
+    /** Polling Event Manager for the client. */
+    pollingEvents: PollingEventManager;
+    constructor(options?: ClientOptions);
+    /** Whether the API is in maintenance break. */
+    get inMaintenance(): any;
+    /**
+     * 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 {};

package/dist/client/PollingClient.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PollingClient = void 0;
+const Constants_1 = require("../util/Constants");
+const Client_1 = require("./Client");
+const EventManager_1 = require("./EventManager");
+/**
+ * Represents Clash of Clans Polling Event Client.
+ * ```js
+ * const { PollingClient } = require('clashofclans.js');
+ * const client = new PollingClient({ keys: ['***'] });
+ * ```
+ */
+class PollingClient extends Client_1.Client {
+    constructor(options) {
+        super(options);
+        this.pollingEvents = new EventManager_1.PollingEventManager(this);
+    }
+    /** Whether the API is in maintenance break. */
+    get inMaintenance() {
+        // @ts-expect-error
+        return this.events._inMaintenance;
+    }
+}
+exports.PollingClient = PollingClient;

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export * from './client/Client';
+export * from './client/PollingClient';
 export * from './rest/RESTManager';
 export * from './rest/RequestHandler';
 export * from './rest/HTTPError';

package/dist/index.js

@@ -11,6 +11,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./client/Client"), exports);
+__exportStar(require("./client/PollingClient"), exports);
 __exportStar(require("./rest/RESTManager"), exports);
 __exportStar(require("./rest/RequestHandler"), exports);
 __exportStar(require("./rest/HTTPError"), exports);

package/dist/index.mjs

@@ -1,12 +1,12 @@
 import mod from "./index.js";
 
 export default mod;
-export const API_BASE_URL = mod.API_BASE_URL;
+export const APIBaseURL = mod.APIBaseURL;
 export const Achievement = mod.Achievement;
-export const BUILDER_TROOPS = mod.BUILDER_TROOPS;
 export const Badge = mod.Badge;
 export const BatchThrottler = mod.BatchThrottler;
-export const CWL_ROUNDS = mod.CWL_ROUNDS;
+export const BuilderTroops = mod.BuilderTroops;
+export const CWLRounds = mod.CWLRounds;
 export const CacheStore = mod.CacheStore;
 export const ChatLanguage = mod.ChatLanguage;
 export const Clan = mod.Clan;
@@ -20,48 +20,49 @@ export const ClanWarLeagueRound = mod.ClanWarLeagueRound;
 export const ClanWarLog = mod.ClanWarLog;
 export const ClanWarMember = mod.ClanWarMember;
 export const Client = mod.Client;
-export const DARK_ELIXIR_SPELLS = mod.DARK_ELIXIR_SPELLS;
-export const DARK_ELIXIR_TROOPS = mod.DARK_ELIXIR_TROOPS;
-export const DEV_SITE_API_BASE_URL = mod.DEV_SITE_API_BASE_URL;
-export const ELIXIR_SPELLS = mod.ELIXIR_SPELLS;
-export const ELIXIR_TROOPS = mod.ELIXIR_TROOPS;
-export const EVENTS = mod.EVENTS;
-export const EventManager = mod.EventManager;
-export const FRIENDLY_WAR_PREPARATION_TIMES = mod.FRIENDLY_WAR_PREPARATION_TIMES;
+export const DarkElixirSpells = mod.DarkElixirSpells;
+export const DarkElixirTroops = mod.DarkElixirTroops;
+export const DevSiteAPIBaseURL = mod.DevSiteAPIBaseURL;
+export const ElixirSpells = mod.ElixirSpells;
+export const ElixirTroops = mod.ElixirTroops;
+export const FriendlyWarPreparationTimes = mod.FriendlyWarPreparationTimes;
 export const GoldPassSeason = mod.GoldPassSeason;
-export const HEROES = mod.HEROES;
-export const HERO_PETS = mod.HERO_PETS;
-export const HOME_TROOPS = mod.HOME_TROOPS;
 export const HTTPError = mod.HTTPError;
 export const Hero = mod.Hero;
+export const HeroPets = mod.HeroPets;
+export const Heroes = mod.Heroes;
+export const HomeTroops = mod.HomeTroops;
 export const Icon = mod.Icon;
-export const LEAGUES = mod.LEAGUES;
-export const LEGEND_LEAGUE_ID = mod.LEGEND_LEAGUE_ID;
 export const Label = mod.Label;
 export const League = mod.League;
+export const Leagues = mod.Leagues;
+export const LegendLeagueId = mod.LegendLeagueId;
 export const LegendStatistics = mod.LegendStatistics;
 export const Location = mod.Location;
 export const NotInWarError = mod.NotInWarError;
 export const Player = mod.Player;
 export const PlayerClan = mod.PlayerClan;
+export const PollingClient = mod.PollingClient;
+export const PollingEventManager = mod.PollingEventManager;
+export const PollingEvents = mod.PollingEvents;
 export const PrivateWarLogError = mod.PrivateWarLogError;
 export const QueueThrottler = mod.QueueThrottler;
-export const RAW_DATA = mod.RAW_DATA;
 export const RESTManager = mod.RESTManager;
 export const RankedClan = mod.RankedClan;
 export const RankedPlayer = mod.RankedPlayer;
+export const RawData = mod.RawData;
 export const RequestHandler = mod.RequestHandler;
-export const SIEGE_MACHINES = mod.SIEGE_MACHINES;
-export const SPELLS = mod.SPELLS;
-export const SUPER_TROOPS = mod.SUPER_TROOPS;
 export const Season = mod.Season;
 export const SeasonRankedPlayer = mod.SeasonRankedPlayer;
+export const SiegeMachines = mod.SiegeMachines;
 export const Spell = mod.Spell;
+export const Spells = mod.Spells;
+export const SuperTroops = mod.SuperTroops;
 export const Troop = mod.Troop;
-export const UNRANKED_LEAGUE_DATA = mod.UNRANKED_LEAGUE_DATA;
 export const Unit = mod.Unit;
+export const UnrankedLeagueData = mod.UnrankedLeagueData;
 export const Util = mod.Util;
-export const WAR_LEAGUES = mod.WAR_LEAGUES;
 export const WarClan = mod.WarClan;
 export const WarLeague = mod.WarLeague;
+export const WarLeagues = mod.WarLeagues;
 export const WarLogClan = mod.WarLogClan;

package/dist/rest/RequestHandler.js

@@ -30,7 +30,7 @@ class RequestHandler {
         this.keys = options?.keys ?? [];
         this.retryLimit = options?.retryLimit ?? 0;
         this.throttler = options?.throttler ?? null;
-        this.baseURL = options?.baseURL ?? Constants_1.API_BASE_URL;
+        this.baseURL = options?.baseURL ?? Constants_1.APIBaseURL;
         this.restRequestTimeout = options?.restRequestTimeout ?? 0;
         this.rejectIfNotValid = options?.rejectIfNotValid ?? true;
         if (typeof options?.cache === 'object')
@@ -120,7 +120,7 @@ class RequestHandler {
         }
     }
     async login() {
-        const res = await (0, node_fetch_1.default)(`${Constants_1.DEV_SITE_API_BASE_URL}/login`, {
+        const res = await (0, node_fetch_1.default)(`${Constants_1.DevSiteAPIBaseURL}/login`, {
             method: 'POST',
             timeout: 10000,
             headers: { 'Content-Type': 'application/json' },
@@ -135,7 +135,7 @@ class RequestHandler {
         return this.getKeys(res.headers.get('set-cookie'), ip);
     }
     async getKeys(cookie, ip) {
-        const res = await (0, node_fetch_1.default)(`${Constants_1.DEV_SITE_API_BASE_URL}/apikey/list`, {
+        const res = await (0, node_fetch_1.default)(`${Constants_1.DevSiteAPIBaseURL}/apikey/list`, {
             method: 'POST',
             timeout: 10000,
             headers: { 'Content-Type': 'application/json', cookie }
@@ -177,7 +177,7 @@ class RequestHandler {
         return this.keys;
     }
     async revokeKey(keyId, cookie) {
-        const res = await (0, node_fetch_1.default)(`${Constants_1.DEV_SITE_API_BASE_URL}/apikey/revoke`, {
+        const res = await (0, node_fetch_1.default)(`${Constants_1.DevSiteAPIBaseURL}/apikey/revoke`, {
             method: 'POST',
             timeout: 10000,
             body: JSON.stringify({ id: keyId }),
@@ -186,7 +186,7 @@ class RequestHandler {
         return res.ok;
     }
     async createKey(cookie, ip) {
-        const res = await (0, node_fetch_1.default)(`${Constants_1.DEV_SITE_API_BASE_URL}/apikey/create`, {
+        const res = await (0, node_fetch_1.default)(`${Constants_1.DevSiteAPIBaseURL}/apikey/create`, {
             method: 'POST',
             timeout: 10000,
             headers: { 'Content-Type': 'application/json', cookie },

package/dist/struct/ClanMember.js

@@ -12,7 +12,7 @@ class ClanMember {
         this.role = data.role.replace('admin', 'elder');
         this.expLevel = data.expLevel;
         // eslint-disable-next-line
-        this.league = new League_1.League(data.league ?? Constants_1.UNRANKED_LEAGUE_DATA);
+        this.league = new League_1.League(data.league ?? Constants_1.UnrankedLeagueData);
         this.trophies = data.trophies;
         this.versusTrophies = data.versusTrophies ?? null;
         this.clanRank = data.clanRank;

package/dist/struct/ClanWar.js

@@ -201,7 +201,7 @@ class ClanWar {
     /** Whether this is a friendly war. */
     get isFriendly() {
         const preparationTime = this.startTime.getTime() - this.preparationStartTime.getTime();
-        return Constants_1.FRIENDLY_WAR_PREPARATION_TIMES.includes(preparationTime);
+        return Constants_1.FriendlyWarPreparationTimes.includes(preparationTime);
     }
     /** Whether this is a CWL. */
     get isCWL() {

package/dist/struct/League.js

@@ -12,7 +12,7 @@ class League {
     }
     /** Position of this League. Starting from 0 (Un-ranked) */
     get position() {
-        return Constants_1.LEAGUES.indexOf(this.id);
+        return Constants_1.Leagues.indexOf(this.id);
     }
 }
 exports.League = League;

package/dist/struct/Player.js

@@ -33,7 +33,7 @@ class Player {
         this.role = data.role?.replace('admin', 'elder') ?? null;
         this.warOptedIn = data.warPreference ? data.warPreference === 'in' : null;
         this.clan = data.clan ? new PlayerClan_1.PlayerClan(client, data.clan) : null;
-        this.league = new League_1.League(data.league ?? Constants_1.UNRANKED_LEAGUE_DATA);
+        this.league = new League_1.League(data.league ?? Constants_1.UnrankedLeagueData);
         this.legendStatistics = data.legendStatistics ? new LegendStatistics_1.LegendStatistics(data.legendStatistics) : null;
         this.achievements = data.achievements.map((data) => new Achievement_1.Achievement(data));
         this.labels = data.labels.map((data) => new Label_1.Label(data));
@@ -70,32 +70,32 @@ class Player {
     /** An array of the player's home base troops. */
     get homeTroops() {
         return this.troops
-            .filter((entry) => Constants_1.HOME_TROOPS.includes(entry.name))
-            .sort((a, b) => Constants_1.HOME_TROOPS.indexOf(a.name) - Constants_1.HOME_TROOPS.indexOf(b.name));
+            .filter((entry) => entry.village === 'home' && Constants_1.HomeTroops.includes(entry.name))
+            .sort((a, b) => Constants_1.HomeTroops.indexOf(a.name) - Constants_1.HomeTroops.indexOf(b.name));
     }
     /** An array of the player's builder base troops. */
     get builderTroops() {
         return this.troops
-            .filter((entry) => Constants_1.BUILDER_TROOPS.includes(entry.name))
-            .sort((a, b) => Constants_1.BUILDER_TROOPS.indexOf(a.name) - Constants_1.BUILDER_TROOPS.indexOf(b.name));
+            .filter((entry) => entry.village === 'builderBase' && Constants_1.BuilderTroops.includes(entry.name))
+            .sort((a, b) => Constants_1.BuilderTroops.indexOf(a.name) - Constants_1.BuilderTroops.indexOf(b.name));
     }
     /** An array of the player's super troops. */
     get superTroops() {
         return this.troops
-            .filter((entry) => Constants_1.SUPER_TROOPS.includes(entry.name))
-            .sort((a, b) => Constants_1.SUPER_TROOPS.indexOf(a.name) - Constants_1.SUPER_TROOPS.indexOf(b.name));
+            .filter((entry) => entry.village === 'home' && Constants_1.SuperTroops.includes(entry.name))
+            .sort((a, b) => Constants_1.SuperTroops.indexOf(a.name) - Constants_1.SuperTroops.indexOf(b.name));
     }
     /** An array of the player's hero pets. */
     get heroPets() {
         return this.troops
-            .filter((entry) => Constants_1.HERO_PETS.includes(entry.name))
-            .sort((a, b) => Constants_1.HERO_PETS.indexOf(a.name) - Constants_1.HERO_PETS.indexOf(b.name));
+            .filter((entry) => entry.village === 'home' && Constants_1.HeroPets.includes(entry.name))
+            .sort((a, b) => Constants_1.HeroPets.indexOf(a.name) - Constants_1.HeroPets.indexOf(b.name));
     }
     /** An array of the player's siege machines. */
     get siegeMachines() {
         return this.troops
-            .filter((entry) => Constants_1.SIEGE_MACHINES.includes(entry.name))
-            .sort((a, b) => Constants_1.SIEGE_MACHINES.indexOf(a.name) - Constants_1.SIEGE_MACHINES.indexOf(b.name));
+            .filter((entry) => entry.village === 'home' && Constants_1.SiegeMachines.includes(entry.name))
+            .sort((a, b) => Constants_1.SiegeMachines.indexOf(a.name) - Constants_1.SiegeMachines.indexOf(b.name));
     }
     /** Get player's formatted link to open player in-game. */
     get shareLink() {

package/dist/struct/Ranking.js

@@ -46,7 +46,7 @@ class RankedPlayer {
         // @ts-expect-error
         this.clan = data.clan ? new PlayerClan_1.PlayerClan(client, data.clan) : null;
         // @ts-expect-error
-        this.league = data.trophies ? new League_1.League(data.league ?? Constants_1.UNRANKED_LEAGUE_DATA) : null; // eslint-disable-line
+        this.league = data.trophies ? new League_1.League(data.league ?? Constants_1.UnrankedLeagueData) : null; // eslint-disable-line
     }
     /** Get player's formatted link to open player in-game. */
     get shareLink() {

package/dist/struct/Unit.js

@@ -10,14 +10,14 @@ class Unit {
         this.level = unit.level;
         this.maxLevel = unit.maxLevel;
         this.village = unit.village;
-        const rawSuperUnit = Constants_1.RAW_DATA.RAW_SUPER_UNITS.find((unit) => unit.name === this.name && this.isHomeBase);
-        const rawUnit = Constants_1.RAW_DATA.RAW_UNITS.find((unit) => unit.name === this.name && unit.village === this.village);
+        const rawSuperUnit = Constants_1.RawData.RawSuperUnits.find((unit) => unit.name === this.name && this.isHomeBase);
+        const rawUnit = Constants_1.RawData.RawUnits.find((unit) => unit.name === this.name && unit.village === this.village);
         if (rawSuperUnit) {
             this.id = rawSuperUnit.id;
             this.housingSpace = rawSuperUnit.housingSpace;
             this.originalName = rawSuperUnit.original;
             this.minOriginalLevel = rawSuperUnit.minOriginalLevel;
-            const original = Constants_1.RAW_DATA.RAW_UNITS.find((unit) => unit.village === 'home' && unit.name === rawSuperUnit.original);
+            const original = Constants_1.RawData.RawUnits.find((unit) => unit.village === 'home' && unit.name === rawSuperUnit.original);
             this.unlockHallLevel = original.levels.findIndex((level) => level >= rawSuperUnit.minOriginalLevel) + 1;
             this.unlockCost = original.unlock.cost;
             this.unlockTime = original.unlock.time;
@@ -87,7 +87,7 @@ class Troop extends Unit {
     }
     /** Whether this troop is a Super Troop. */
     get isSuperTroop() {
-        return this.isActive || (this.isHomeBase && Constants_1.SUPER_TROOPS.includes(this.name));
+        return this.isActive || (this.isHomeBase && Constants_1.SuperTroops.includes(this.name));
     }
 }
 exports.Troop = Troop;

package/dist/struct/WarLeague.js

@@ -10,7 +10,7 @@ class WarLeague {
     }
     /** Position of this War League. Starting from 0 (Unranked) */
     get position() {
-        return Constants_1.WAR_LEAGUES.indexOf(this.id);
+        return Constants_1.WarLeagues.indexOf(this.id);
     }
 }
 exports.WarLeague = WarLeague;

package/dist/util/Constants.d.ts

@@ -1,17 +1,17 @@
-export declare const API_BASE_URL = "https://api.clashofclans.com/v1";
-export declare const DEV_SITE_API_BASE_URL = "https://developer.clashofclans.com/api";
-export declare const ELIXIR_TROOPS: string[];
-export declare const DARK_ELIXIR_TROOPS: string[];
-export declare const HOME_TROOPS: string[];
-export declare const SIEGE_MACHINES: string[];
-export declare const SUPER_TROOPS: string[];
-export declare const ELIXIR_SPELLS: string[];
-export declare const DARK_ELIXIR_SPELLS: string[];
-export declare const SPELLS: string[];
-export declare const BUILDER_TROOPS: string[];
-export declare const HEROES: string[];
-export declare const HERO_PETS: string[];
-export declare const UNRANKED_LEAGUE_DATA: {
+export declare const APIBaseURL = "https://api.clashofclans.com/v1";
+export declare const DevSiteAPIBaseURL = "https://developer.clashofclans.com/api";
+export declare const ElixirTroops: string[];
+export declare const DarkElixirTroops: string[];
+export declare const HomeTroops: string[];
+export declare const SiegeMachines: string[];
+export declare const SuperTroops: string[];
+export declare const ElixirSpells: string[];
+export declare const DarkElixirSpells: string[];
+export declare const Spells: string[];
+export declare const BuilderTroops: string[];
+export declare const Heroes: string[];
+export declare const HeroPets: string[];
+export declare const UnrankedLeagueData: {
     id: number;
     name: string;
     iconUrls: {
@@ -19,30 +19,30 @@ export declare const UNRANKED_LEAGUE_DATA: {
         tiny: string;
     };
 };
-export declare const LEGEND_LEAGUE_ID = 29000022;
-export declare const LEAGUES: number[];
-export declare const WAR_LEAGUES: number[];
-export declare const FRIENDLY_WAR_PREPARATION_TIMES: readonly [number, number, number, number, number, number, number, number, number, number, number, number];
-export declare const EVENTS: {
-    readonly NEW_SEASON_START: "newSeasonStart";
-    readonly CLAN_LOOP_START: "clanLoopStart";
-    readonly CLAN_LOOP_END: "clanLoopEnd";
-    readonly PLAYER_LOOP_START: "playerLoopStart";
-    readonly PLAYER_LOOP_END: "playerLoopEnd";
-    readonly WAR_LOOP_START: "warLoopEnd";
-    readonly WAR_LOOP_END: "warLoopEnd";
-    readonly MAINTENANCE_START: "maintenanceStart";
-    readonly MAINTENANCE_END: "maintenanceEnd";
-    readonly ERROR: "error";
-    readonly DEBUG: "debug";
+export declare const LegendLeagueId = 29000022;
+export declare const Leagues: number[];
+export declare const WarLeagues: number[];
+export declare const FriendlyWarPreparationTimes: readonly [number, number, number, number, number, number, number, number, number, number, number, number];
+export declare const PollingEvents: {
+    readonly NewSeasonStart: "newSeasonStart";
+    readonly ClanLoopStart: "clanLoopStart";
+    readonly ClanLoopEnd: "clanLoopEnd";
+    readonly PlayerLoopStart: "playerLoopStart";
+    readonly PlayerLoopEnd: "playerLoopEnd";
+    readonly WarLoopStart: "warLoopEnd";
+    readonly WarLoopEnd: "warLoopEnd";
+    readonly MaintenanceStart: "maintenanceStart";
+    readonly MaintenanceEnd: "maintenanceEnd";
+    readonly Error: "error";
+    readonly Debug: "debug";
 };
-export declare const CWL_ROUNDS: {
-    readonly PREVIOUS_ROUND: "warEnded";
-    readonly CURRENT_ROUND: "inWar";
-    readonly NEXT_ROUND: "preparation";
+export declare const CWLRounds: {
+    readonly PreviousRound: "warEnded";
+    readonly CurrentRound: "inWar";
+    readonly NextRound: "preparation";
 };
-export declare const RAW_DATA: {
-    RAW_UNITS: {
+export declare const RawData: {
+    RawUnits: {
         id: number;
         name: string;
         housingSpace: number;
@@ -69,7 +69,7 @@ export declare const RAW_DATA: {
         seasonal: boolean;
         levels: number[];
     }[];
-    RAW_SUPER_UNITS: {
+    RawSuperUnits: {
         name: string;
         id: number;
         original: string;

package/dist/util/Constants.js

@@ -3,11 +3,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RAW_DATA = exports.CWL_ROUNDS = exports.EVENTS = exports.FRIENDLY_WAR_PREPARATION_TIMES = exports.WAR_LEAGUES = exports.LEAGUES = exports.LEGEND_LEAGUE_ID = exports.UNRANKED_LEAGUE_DATA = exports.HERO_PETS = exports.HEROES = exports.BUILDER_TROOPS = exports.SPELLS = exports.DARK_ELIXIR_SPELLS = exports.ELIXIR_SPELLS = exports.SUPER_TROOPS = exports.SIEGE_MACHINES = exports.HOME_TROOPS = exports.DARK_ELIXIR_TROOPS = exports.ELIXIR_TROOPS = exports.DEV_SITE_API_BASE_URL = exports.API_BASE_URL = void 0;
+exports.RawData = exports.CWLRounds = exports.PollingEvents = exports.FriendlyWarPreparationTimes = exports.WarLeagues = exports.Leagues = exports.LegendLeagueId = exports.UnrankedLeagueData = exports.HeroPets = exports.Heroes = exports.BuilderTroops = exports.Spells = exports.DarkElixirSpells = exports.ElixirSpells = exports.SuperTroops = exports.SiegeMachines = exports.HomeTroops = exports.DarkElixirTroops = exports.ElixirTroops = exports.DevSiteAPIBaseURL = exports.APIBaseURL = void 0;
 const raw_json_1 = __importDefault(require("../util/raw.json"));
-exports.API_BASE_URL = 'https://api.clashofclans.com/v1';
-exports.DEV_SITE_API_BASE_URL = 'https://developer.clashofclans.com/api';
-exports.ELIXIR_TROOPS = [
+exports.APIBaseURL = 'https://api.clashofclans.com/v1';
+exports.DevSiteAPIBaseURL = 'https://developer.clashofclans.com/api';
+exports.ElixirTroops = [
     'Barbarian',
     'Archer',
     'Giant',
@@ -24,10 +24,10 @@ exports.ELIXIR_TROOPS = [
     'Yeti',
     'Dragon Rider'
 ];
-exports.DARK_ELIXIR_TROOPS = ['Minion', 'Hog Rider', 'Valkyrie', 'Golem', 'Witch', 'Lava Hound', 'Bowler', 'Ice Golem', 'Headhunter'];
-exports.HOME_TROOPS = [...exports.ELIXIR_TROOPS, ...exports.DARK_ELIXIR_TROOPS];
-exports.SIEGE_MACHINES = ['Wall Wrecker', 'Battle Blimp', 'Stone Slammer', 'Siege Barracks', 'Log Launcher', 'Flame Flinger'];
-exports.SUPER_TROOPS = [
+exports.DarkElixirTroops = ['Minion', 'Hog Rider', 'Valkyrie', 'Golem', 'Witch', 'Lava Hound', 'Bowler', 'Ice Golem', 'Headhunter'];
+exports.HomeTroops = [...exports.ElixirTroops, ...exports.DarkElixirTroops];
+exports.SiegeMachines = ['Wall Wrecker', 'Battle Blimp', 'Stone Slammer', 'Siege Barracks', 'Log Launcher', 'Flame Flinger'];
+exports.SuperTroops = [
     'Super Barbarian',
     'Super Archer',
     'Super Giant',
@@ -43,7 +43,7 @@ exports.SUPER_TROOPS = [
     'Ice Hound',
     'Super Bowler'
 ];
-exports.ELIXIR_SPELLS = [
+exports.ElixirSpells = [
     'Lightning Spell',
     'Healing Spell',
     'Rage Spell',
@@ -52,9 +52,9 @@ exports.ELIXIR_SPELLS = [
     'Clone Spell',
     'Invisibility Spell'
 ];
-exports.DARK_ELIXIR_SPELLS = ['Poison Spell', 'Earthquake Spell', 'Haste Spell', 'Skeleton Spell', 'Bat Spell'];
-exports.SPELLS = [...exports.ELIXIR_SPELLS, ...exports.DARK_ELIXIR_SPELLS];
-exports.BUILDER_TROOPS = [
+exports.DarkElixirSpells = ['Poison Spell', 'Earthquake Spell', 'Haste Spell', 'Skeleton Spell', 'Bat Spell'];
+exports.Spells = [...exports.ElixirSpells, ...exports.DarkElixirSpells];
+exports.BuilderTroops = [
     'Raged Barbarian',
     'Sneaky Archer',
     'Boxer Giant',
@@ -67,9 +67,9 @@ exports.BUILDER_TROOPS = [
     'Super P.E.K.K.A',
     'Hog Glider'
 ];
-exports.HEROES = ['Barbarian King', 'Archer Queen', 'Grand Warden', 'Royal Champion', 'Battle Machine'];
-exports.HERO_PETS = ['L.A.S.S.I', 'Electro Owl', 'Mighty Yak', 'Unicorn'];
-exports.UNRANKED_LEAGUE_DATA = {
+exports.Heroes = ['Barbarian King', 'Archer Queen', 'Grand Warden', 'Royal Champion', 'Battle Machine'];
+exports.HeroPets = ['L.A.S.S.I', 'Electro Owl', 'Mighty Yak', 'Unicorn'];
+exports.UnrankedLeagueData = {
     id: 29000000,
     name: 'Unranked',
     iconUrls: {
@@ -77,8 +77,8 @@ exports.UNRANKED_LEAGUE_DATA = {
         tiny: 'https://api-assets.clashofclans.com/leagues/36/e--YMyIexEQQhE4imLoJcwhYn6Uy8KqlgyY3_kFV6t4.png'
     }
 };
-exports.LEGEND_LEAGUE_ID = 29000022;
-exports.LEAGUES = [
+exports.LegendLeagueId = 29000022;
+exports.Leagues = [
     29000000,
     29000001,
     29000002,
@@ -101,13 +101,13 @@ exports.LEAGUES = [
     29000019,
     29000020,
     29000021,
-    exports.LEGEND_LEAGUE_ID
+    exports.LegendLeagueId
 ];
-exports.WAR_LEAGUES = [
+exports.WarLeagues = [
     48000000, 48000001, 48000002, 48000003, 48000004, 48000005, 48000006, 48000007, 48000008, 48000009, 48000010, 48000011, 48000012,
     48000013, 48000014, 48000015, 48000016, 48000017, 48000018
 ];
-exports.FRIENDLY_WAR_PREPARATION_TIMES = [
+exports.FriendlyWarPreparationTimes = [
     1000 * 60 * 60 * 24,
     1000 * 60 * 60 * 20,
     1000 * 60 * 60 * 16,
@@ -121,25 +121,25 @@ exports.FRIENDLY_WAR_PREPARATION_TIMES = [
     1000 * 60 * 15,
     1000 * 60 * 5
 ];
-exports.EVENTS = {
-    NEW_SEASON_START: 'newSeasonStart',
-    CLAN_LOOP_START: 'clanLoopStart',
-    CLAN_LOOP_END: 'clanLoopEnd',
-    PLAYER_LOOP_START: 'playerLoopStart',
-    PLAYER_LOOP_END: 'playerLoopEnd',
-    WAR_LOOP_START: 'warLoopEnd',
-    WAR_LOOP_END: 'warLoopEnd',
-    MAINTENANCE_START: 'maintenanceStart',
-    MAINTENANCE_END: 'maintenanceEnd',
-    ERROR: 'error',
-    DEBUG: 'debug'
+exports.PollingEvents = {
+    NewSeasonStart: 'newSeasonStart',
+    ClanLoopStart: 'clanLoopStart',
+    ClanLoopEnd: 'clanLoopEnd',
+    PlayerLoopStart: 'playerLoopStart',
+    PlayerLoopEnd: 'playerLoopEnd',
+    WarLoopStart: 'warLoopEnd',
+    WarLoopEnd: 'warLoopEnd',
+    MaintenanceStart: 'maintenanceStart',
+    MaintenanceEnd: 'maintenanceEnd',
+    Error: 'error',
+    Debug: 'debug'
 };
-exports.CWL_ROUNDS = {
-    PREVIOUS_ROUND: 'warEnded',
-    CURRENT_ROUND: 'inWar',
-    NEXT_ROUND: 'preparation'
+exports.CWLRounds = {
+    PreviousRound: 'warEnded',
+    CurrentRound: 'inWar',
+    NextRound: 'preparation'
 };
-exports.RAW_DATA = {
-    RAW_UNITS: raw_json_1.default.RAW_UNITS,
-    RAW_SUPER_UNITS: raw_json_1.default.RAW_SUPER_UNITS
+exports.RawData = {
+    RawUnits: raw_json_1.default.RAW_UNITS,
+    RawSuperUnits: raw_json_1.default.RAW_SUPER_UNITS
 };

package/dist/util/Util.js

@@ -132,11 +132,11 @@ class Util extends null {
         }));
         return {
             units: units.map((unit) => {
-                const _unit = Constants_1.RAW_DATA.RAW_UNITS.find((raw) => raw.category === 'troop' && raw.id === unit.id);
+                const _unit = Constants_1.RawData.RawUnits.find((raw) => raw.category === 'troop' && raw.id === unit.id);
                 return { name: _unit?.name ?? null, count: unit.total, id: unit.id };
             }),
             spells: spells.map((spell) => {
-                const _spell = Constants_1.RAW_DATA.RAW_UNITS.find((raw) => raw.category === 'spell' && raw.id === spell.id);
+                const _spell = Constants_1.RawData.RawUnits.find((raw) => raw.category === 'spell' && raw.id === spell.id);
                 return { name: _spell?.name ?? null, count: spell.total, id: spell.id };
             })
         };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "clashofclans.js",
-	"version": "2.8.2",
+	"version": "3.0.0-dev.392ca4c",
 	"description": "JavaScript library for interacting with the Clash of Clans API",
 	"author": "SUVAJIT <suvajit.me@gmail.com>",
 	"license": "MIT",