clashofclans.js 3.0.1-dev.e71b7fa → 3.0.2-dev.6c774bd

package/CHANGELOG.md

@@ -2,13 +2,14 @@
 
 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.1 (11-01-2023)
+## 3.0.2 (15-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.
+- Fix the issue with the `Clan#clanCapital` property.
 
 ### Features
 

package/dist/client/Client.js

@@ -92,13 +92,17 @@ class Client extends node_events_1.EventEmitter {
     async getCurrentWar(clanTag, options) {
         const args = typeof clanTag === 'string' ? { clanTag } : { clanTag: clanTag.clanTag, round: clanTag.round };
         try {
-            return await this.getClanWar(args.clanTag, options);
+            const data = await this.getClanWar(args.clanTag, options);
+            if (data.state === 'notInWar') {
+                return await this.getLeagueWar({ clanTag: args.clanTag, round: args.round }, options);
+            }
+            return data;
         }
-        catch (e) {
-            if (e instanceof HTTPError_1.HTTPError && [200, 403].includes(e.status)) {
+        catch (err) {
+            if (err instanceof HTTPError_1.HTTPError && err.status === 403) {
                 return this.getLeagueWar({ clanTag: args.clanTag, round: args.round }, options);
             }
-            throw e;
+            throw err;
         }
     }
     /**

package/dist/client/PollingClient.d.ts

@@ -1,5 +1,5 @@
 import { Clan, ClanWar, Player } from '../struct';
-import { ClientOptions } from '../types';
+import { PollingClientOptions } from '../types';
 import { PollingEvents } from '../util/Constants';
 import { Client } from './Client';
 /**
@@ -13,13 +13,14 @@ export declare class PollingClient extends Client {
     private readonly _clanTags;
     private readonly _playerTags;
     private readonly _warTags;
+    private readonly _pollingInterval;
     private readonly _clans;
     private readonly _players;
     private readonly _wars;
     private readonly _pollingEvents;
     inMaintenance: boolean;
     private _maintenanceStartTime;
-    constructor(options?: ClientOptions);
+    constructor(options?: PollingClientOptions);
     /** Initialize the PollingEvent Manager to start pulling the data by polling api. */
     init(): Promise<string[]>;
     /** Add clan tags to clan polling events. */

package/dist/client/PollingClient.js

@@ -27,6 +27,10 @@ class PollingClient extends Client_1.Client {
         };
         this.inMaintenance = Boolean(false);
         this._maintenanceStartTime = null;
+        if (options?.pollingInterval && !isNaN(options.pollingInterval)) {
+            throw new Error('The property "pollingInterval" must be a type of number.');
+        }
+        this._pollingInterval = Math.max(options?.pollingInterval ?? 1000, 1000);
     }
     /** Initialize the PollingEvent Manager to start pulling the data by polling api. */
     async init() {
@@ -147,7 +151,7 @@ class PollingClient extends Client_1.Client {
         return this;
     }
     async maintenanceHandler() {
-        setTimeout(this.maintenanceHandler.bind(this), 10000).unref();
+        setTimeout(this.maintenanceHandler.bind(this), this._pollingInterval).unref();
         if (!(this.listenerCount(Constants_1.PollingEvents.MaintenanceStart) && this.listenerCount(Constants_1.PollingEvents.MaintenanceEnd)))
             return;
         try {
@@ -184,21 +188,21 @@ class PollingClient extends Client_1.Client {
         for (const tag of this._clanTags)
             await this.runClanUpdate(tag);
         this.emit(Constants_1.PollingEvents.ClanLoopEnd);
-        setTimeout(this.clanUpdateHandler.bind(this), 10000);
+        setTimeout(this.clanUpdateHandler.bind(this), this._pollingInterval);
     }
     async playerUpdateHandler() {
         this.emit(Constants_1.PollingEvents.PlayerLoopStart);
         for (const tag of this._playerTags)
             await this.runPlayerUpdate(tag);
         this.emit(Constants_1.PollingEvents.PlayerLoopEnd);
-        setTimeout(this.playerUpdateHandler.bind(this), 10000);
+        setTimeout(this.playerUpdateHandler.bind(this), this._pollingInterval);
     }
     async warUpdateHandler() {
         this.emit(Constants_1.PollingEvents.WarLoopStart);
         for (const tag of this._warTags)
             await this.runWarUpdate(tag);
         this.emit(Constants_1.PollingEvents.WarLoopEnd);
-        setTimeout(this.warUpdateHandler.bind(this), 10000);
+        setTimeout(this.warUpdateHandler.bind(this), this._pollingInterval);
     }
     async runClanUpdate(tag) {
         if (this.inMaintenance)

package/dist/rest/RESTManager.d.ts

@@ -67,7 +67,7 @@ export declare class RESTManager extends EventEmitter {
     /** Get info about a CWL round by WarTag. */
     getClanWarLeagueRound(warTag: string, options?: OverrideOptions): Promise<import("../types").Response<APIClanWar>>;
     /** Retrieve clan's capital raid seasons. */
-    getCapitalRaidSeasons(tag: string, options?: OverrideOptions): Promise<import("../types").Response<APICapitalRaidSeasons>>;
+    getCapitalRaidSeasons(tag: string, options?: SearchOptions): Promise<import("../types").Response<APICapitalRaidSeasons>>;
     /** Get info about a player by tag. */
     getPlayer(playerTag: string, options?: OverrideOptions): Promise<import("../types").Response<APIPlayer>>;
     /** Verify Player API token that can be found from the Game settings. */

package/dist/rest/RequestHandler.js

@@ -145,7 +145,7 @@ class RequestHandler extends node_events_1.EventEmitter {
         for (const key of this.keys) {
             const res = await (0, node_fetch_1.default)(`${this.baseURL}/locations?limit=1`, {
                 method: 'GET',
-                timeout: 10000,
+                timeout: this.restRequestTimeout,
                 headers: { 'Authorization': `Bearer ${key}`, 'Content-Type': 'application/json' }
             }).catch(() => null);
             if (res?.status === 403) {
@@ -158,7 +158,7 @@ class RequestHandler extends node_events_1.EventEmitter {
     async login() {
         const res = await (0, node_fetch_1.default)(`${Constants_1.DevSiteAPIBaseURL}/login`, {
             method: 'POST',
-            timeout: 10000,
+            timeout: this.restRequestTimeout,
             headers: { 'Content-Type': 'application/json' },
             body: JSON.stringify({ email: this.email, password: this.password })
         });
@@ -173,7 +173,7 @@ class RequestHandler extends node_events_1.EventEmitter {
     async getKeys(cookie, ip) {
         const res = await (0, node_fetch_1.default)(`${Constants_1.DevSiteAPIBaseURL}/apikey/list`, {
             method: 'POST',
-            timeout: 10000,
+            timeout: this.restRequestTimeout,
             headers: { 'Content-Type': 'application/json', cookie }
         });
         const data = await res.json();
@@ -215,7 +215,7 @@ class RequestHandler extends node_events_1.EventEmitter {
     async revokeKey(keyId, cookie) {
         const res = await (0, node_fetch_1.default)(`${Constants_1.DevSiteAPIBaseURL}/apikey/revoke`, {
             method: 'POST',
-            timeout: 10000,
+            timeout: this.restRequestTimeout,
             body: JSON.stringify({ id: keyId }),
             headers: { 'Content-Type': 'application/json', cookie }
         });
@@ -224,7 +224,7 @@ class RequestHandler extends node_events_1.EventEmitter {
     async createKey(cookie, ip) {
         const res = await (0, node_fetch_1.default)(`${Constants_1.DevSiteAPIBaseURL}/apikey/create`, {
             method: 'POST',
-            timeout: 10000,
+            timeout: this.restRequestTimeout,
             headers: { 'Content-Type': 'application/json', cookie },
             body: JSON.stringify({
                 cidrRanges: [ip],
@@ -244,7 +244,7 @@ class RequestHandler extends node_events_1.EventEmitter {
             return props.cidrs[0].match(IP_REGEX)[0];
         }
         catch {
-            const body = await (0, node_fetch_1.default)('https://api.ipify.org', { timeout: 10000 }).then((res) => res.text());
+            const body = await (0, node_fetch_1.default)('https://api.ipify.org', { timeout: this.restRequestTimeout }).then((res) => res.text());
             return body.match(IP_REGEX)?.[0] ?? null;
         }
     }

package/dist/struct/Clan.js

@@ -34,7 +34,8 @@ class Clan {
         this.warLeague = data.warLeague ? new WarLeague_1.WarLeague(data.warLeague) : null;
         this.memberCount = data.members;
         this.labels = data.labels.map((label) => new Label_1.Label(label));
-        this.clanCapital = Object.keys(data.clanCapital).length > 0 ? new ClanCapital_1.ClanCapital(data.clanCapital) : null;
+        // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+        this.clanCapital = Object.keys(data.clanCapital ?? {}).length > 0 ? new ClanCapital_1.ClanCapital(data.clanCapital) : null;
         this.isFamilyFriendly = data.isFamilyFriendly;
         this.capitalPoints = data.clanCapitalPoints;
         this.capitalLeague = data.capitalLeague;

package/dist/types/api.d.ts

@@ -24,7 +24,7 @@ export interface APISeason {
 }
 /** /clans?name={name}&limit={limit} */
 export interface APIClanList {
-    items: Omit<APIClan, 'memberList'>[];
+    items: Omit<APIClan, 'memberList' | 'clanCapital'>[];
     paging: APIPaging;
 }
 export interface APIChatLanguage {

package/dist/types/lib.d.ts

@@ -43,6 +43,9 @@ export interface RESTOptions extends ClientOptions {
     /** Set this `false` to use `res.ok` property. */
     rejectIfNotValid?: boolean;
 }
+export interface PollingClientOptions extends ClientOptions {
+    pollingInterval?: number;
+}
 /** Options for a {@link RequestHandler} */
 export interface RequestHandlerOptions extends ClientOptions {
     /** Set this `false` to use `res.ok` property. */

package/dist/util/Constants.d.ts

@@ -28,7 +28,7 @@ export declare const PollingEvents: {
     readonly ClanLoopEnd: "clanLoopEnd";
     readonly PlayerLoopStart: "playerLoopStart";
     readonly PlayerLoopEnd: "playerLoopEnd";
-    readonly WarLoopStart: "warLoopEnd";
+    readonly WarLoopStart: "warLoopStart";
     readonly WarLoopEnd: "warLoopEnd";
     readonly NewSeasonStart: "newSeasonStart";
     readonly MaintenanceStart: "maintenanceStart";

package/dist/util/Constants.js

@@ -137,7 +137,7 @@ exports.PollingEvents = {
     ClanLoopEnd: 'clanLoopEnd',
     PlayerLoopStart: 'playerLoopStart',
     PlayerLoopEnd: 'playerLoopEnd',
-    WarLoopStart: 'warLoopEnd',
+    WarLoopStart: 'warLoopStart',
     WarLoopEnd: 'warLoopEnd',
     NewSeasonStart: 'newSeasonStart',
     MaintenanceStart: 'maintenanceStart',

package/package.json

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