clashofclans.js 3.0.0-dev.5d2e14a → 3.0.0-dev.70cb1c7

package/README.md

@@ -37,7 +37,7 @@ const client = new Client();
 
 ### Custom Polling Event
 
-> **Warning** <br>
+> **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

package/dist/client/Client.js

@@ -66,7 +66,7 @@ class Client extends node_events_1.EventEmitter {
     /** 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(entry));
+        return data.items.map((entry) => new CapitalRaidSeason_1.CapitalRaidSeason(this, entry));
     }
     /** Get clan war log. */
     async getClanWarLog(clanTag, options) {
@@ -75,10 +75,7 @@ class Client extends node_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 });
     }
     /**
@@ -159,19 +156,13 @@ class Client extends node_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. */

package/dist/client/PollingClient.d.ts

@@ -3,7 +3,7 @@ import { ClientOptions } from '../types';
 import { PollingEvents } from '../util/Constants';
 import { Client } from './Client';
 /**
- * Represents Clash of Clans Polling Event Client.
+ * Represents a Polling Event Client.
  * ```js
  * const { PollingClient } = require('clashofclans.js');
  * const pollingClient = new PollingClient({ keys: ['***'] });

package/dist/client/PollingClient.js

@@ -5,7 +5,7 @@ const HTTPError_1 = require("../rest/HTTPError");
 const Constants_1 = require("../util/Constants");
 const Client_1 = require("./Client");
 /**
- * Represents Clash of Clans Polling Event Client.
+ * Represents a Polling Event Client.
  * ```js
  * const { PollingClient } = require('clashofclans.js');
  * const pollingClient = new PollingClient({ keys: ['***'] });
@@ -148,6 +148,8 @@ class PollingClient extends Client_1.Client {
     }
     async maintenanceHandler() {
         setTimeout(this.maintenanceHandler.bind(this), 10000).unref();
+        if (!(this.listenerCount(Constants_1.PollingEvents.MaintenanceStart) && this.listenerCount(Constants_1.PollingEvents.MaintenanceEnd)))
+            return;
         try {
             const res = await this.rest.getClans({ maxMembers: Math.floor(Math.random() * 40) + 10, limit: 1 });
             if (res.status === 200 && this.inMaintenance) {

package/dist/index.mjs

@@ -8,8 +8,11 @@ export const BatchThrottler = mod.BatchThrottler;
 export const BuilderTroops = mod.BuilderTroops;
 export const CWLRounds = mod.CWLRounds;
 export const CacheStore = mod.CacheStore;
+export const CapitalRaidSeason = mod.CapitalRaidSeason;
+export const CapitalRaidSeasonMember = mod.CapitalRaidSeasonMember;
 export const ChatLanguage = mod.ChatLanguage;
 export const Clan = mod.Clan;
+export const ClanCapital = mod.ClanCapital;
 export const ClanMember = mod.ClanMember;
 export const ClanWar = mod.ClanWar;
 export const ClanWarAttack = mod.ClanWarAttack;
@@ -40,7 +43,6 @@ 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;

package/dist/rest/HTTPError.d.ts

@@ -19,10 +19,6 @@ export declare class HTTPError extends Error {
     maxAge: number;
     constructor(error: any, status: number, path: string, maxAge: number, method?: string);
 }
-export declare const NotInWarError: {
-    message: string;
-    reason: string;
-};
 export declare const PrivateWarLogError: {
     message: string;
     reason: string;

package/dist/rest/HTTPError.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PrivateWarLogError = exports.NotInWarError = exports.HTTPError = void 0;
+exports.PrivateWarLogError = exports.HTTPError = void 0;
 const messages = {
     500: 'Unknown error happened when handling the request.',
     504: 'The user aborted this request.',
@@ -32,10 +32,6 @@ class HTTPError extends Error {
     }
 }
 exports.HTTPError = HTTPError;
-exports.NotInWarError = {
-    message: 'Clan is not in war at this moment.',
-    reason: 'notInWar'
-};
 exports.PrivateWarLogError = {
     message: 'Access denied, clan war log is private.',
     reason: 'privateWarLog'

package/dist/struct/CapitalRaidSeason.d.ts

@@ -1,6 +1,24 @@
-import { APICapitalRaidSeason, APICapitalRaidSeasonAttackLog, APICapitalRaidSeasonDefenseLog, APICapitalRaidSeasonMember } from '../types';
+import { Client } from '../client/Client';
+import { APICapitalRaidSeason, APICapitalRaidSeasonAttackLog, APICapitalRaidSeasonDefenseLog, APICapitalRaidSeasonMember, OverrideOptions } from '../types';
+import { Player } from './Player';
+export declare class CapitalRaidSeasonMember {
+    /** The player's tag. */
+    name: string;
+    /** The player's name. */
+    tag: string;
+    /** The number of attacks the player has made. */
+    attacks: number;
+    /** The number of attacks the player can make. */
+    attackLimit: number;
+    /** The number of bonus attacks the player can make. */
+    bonusAttackLimit: number;
+    /** The number of capital resources the player has looted. */
+    capitalResourcesLooted: number;
+    constructor(data: APICapitalRaidSeasonMember);
+}
 /** Represents a Capital Raid Season. */
 export declare class CapitalRaidSeason {
+    private readonly client;
     /** The state of the raid season. */
     state: 'ongoing' | 'ended';
     /** The start time of the raid season. */
@@ -25,5 +43,7 @@ export declare class CapitalRaidSeason {
     attackLog: APICapitalRaidSeasonAttackLog[];
     /** The defense log of the raid season. */
     defenseLog: APICapitalRaidSeasonDefenseLog[];
-    constructor(data: APICapitalRaidSeason);
+    constructor(client: Client, data: APICapitalRaidSeason);
+    /** Get {@link Player} info for every Player in the clan. */
+    fetchMembers(options?: OverrideOptions): Promise<Player[]>;
 }

package/dist/struct/CapitalRaidSeason.js

@@ -1,10 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CapitalRaidSeason = void 0;
+exports.CapitalRaidSeason = exports.CapitalRaidSeasonMember = void 0;
 const Util_1 = require("../util/Util");
+class CapitalRaidSeasonMember {
+    constructor(data) {
+        this.tag = data.tag;
+        this.name = data.name;
+        this.attacks = data.attacks;
+        this.attackLimit = data.attackLimit;
+        this.bonusAttackLimit = data.bonusAttackLimit;
+        this.capitalResourcesLooted = data.capitalResourcesLooted;
+    }
+}
+exports.CapitalRaidSeasonMember = CapitalRaidSeasonMember;
 /** Represents a Capital Raid Season. */
 class CapitalRaidSeason {
-    constructor(data) {
+    constructor(client, data) {
+        this.client = client;
         this.state = data.state;
         this.startTime = Util_1.Util.formatDate(data.startTime);
         this.endTime = Util_1.Util.formatDate(data.endTime);
@@ -14,9 +26,15 @@ class CapitalRaidSeason {
         this.enemyDistrictsDestroyed = data.enemyDistrictsDestroyed;
         this.offensiveReward = data.offensiveReward;
         this.defensiveReward = data.defensiveReward;
-        this.members = data.members ?? [];
         this.attackLog = data.attackLog;
         this.defenseLog = data.defenseLog;
+        this.members = (data.members ?? []).map((member) => new CapitalRaidSeasonMember(member));
+    }
+    /** Get {@link Player} info for every Player in the clan. */
+    async fetchMembers(options) {
+        return (await Promise.allSettled(this.members.map((m) => this.client.getPlayer(m.tag, { ...options, ignoreRateLimit: true }))))
+            .filter((res) => res.status === 'fulfilled')
+            .map((res) => res.value);
     }
 }
 exports.CapitalRaidSeason = CapitalRaidSeason;

package/dist/struct/ClanWar.d.ts

@@ -101,11 +101,21 @@ export declare class WarClan {
     /** Get clan's formatted link to open clan in-game. */
     get shareLink(): string;
 }
-/** Represents a Clan War in Clash of Clans. */
+/**
+ * Represents a Clan War in Clash of Clans.
+ *
+ * :::caution
+ * It's recommended to see if ClanWar#state is `notInWar` available before performing operations or reading data from it. You can check this with data.ok property.
+ * :::
+ */
 export declare class ClanWar {
     client: Client;
-    /** The clan's current war state. */
-    state: 'preparation' | 'inWar' | 'warEnded';
+    /**
+     * The clan's current war state.
+     *
+     * :warning: Other properties won't be available if the state is `notInWar`.
+     */
+    state: 'preparation' | 'inWar' | 'warEnded' | 'notInWar';
     /** The number of players on each side. */
     teamSize: number;
     /** The number of attacks each member has. */
@@ -135,6 +145,8 @@ export declare class ClanWar {
     getAttack(attackerTag: string, defenderTag: string): ClanWarAttack | null;
     /** Return a list of {@link ClanWarAttack} for the defenderTag provided. */
     getDefenses(defenderTag: string): ClanWarAttack[];
+    /** Whether the clan is not in war. */
+    get isNotInWar(): boolean;
     /** Whether this is a Battle Day. */
     get isBattleDay(): boolean;
     /** Whether this is a Preparation Day. */

package/dist/struct/ClanWar.js

@@ -137,26 +137,33 @@ class WarClan {
     }
 }
 exports.WarClan = WarClan;
-/** Represents a Clan War in Clash of Clans. */
+/**
+ * Represents a Clan War in Clash of Clans.
+ *
+ * :::caution
+ * It's recommended to see if ClanWar#state is `notInWar` available before performing operations or reading data from it. You can check this with data.ok property.
+ * :::
+ */
 class ClanWar {
     constructor(client, data, extra) {
         Object.defineProperty(this, 'client', { value: client });
-        // @ts-expect-error
         this.state = data.state;
-        this.teamSize = data.teamSize;
-        this.attacksPerMember = data.attacksPerMember ?? (extra.warTag ? 1 : 2);
-        this.preparationStartTime = client.util.formatDate(data.preparationStartTime);
-        this.startTime = client.util.formatDate(data.startTime);
-        this.endTime = client.util.formatDate(data.endTime);
-        this.warTag = extra.warTag ?? null;
-        let [clan, opponent] = [data.clan, data.opponent];
-        const clanTag = extra.clanTag && client.util.formatTag(extra.clanTag);
-        if (clanTag && [data.clan.tag, data.opponent.tag].includes(clanTag)) {
-            clan = data.clan.tag === clanTag ? data.clan : data.opponent;
-            opponent = data.clan.tag === clan.tag ? data.opponent : data.clan;
+        if (this.state !== 'notInWar') {
+            this.teamSize = data.teamSize;
+            this.attacksPerMember = data.attacksPerMember ?? (extra.warTag ? 1 : 2);
+            this.preparationStartTime = client.util.formatDate(data.preparationStartTime);
+            this.startTime = client.util.formatDate(data.startTime);
+            this.endTime = client.util.formatDate(data.endTime);
+            this.warTag = extra.warTag ?? null;
+            let [clan, opponent] = [data.clan, data.opponent];
+            const clanTag = extra.clanTag && client.util.formatTag(extra.clanTag);
+            if (clanTag && [data.clan.tag, data.opponent.tag].includes(clanTag)) {
+                clan = data.clan.tag === clanTag ? data.clan : data.opponent;
+                opponent = data.clan.tag === clan.tag ? data.opponent : data.clan;
+            }
+            this.clan = new WarClan(this, clan);
+            this.opponent = new WarClan(this, opponent);
         }
-        this.clan = new WarClan(this, clan);
-        this.opponent = new WarClan(this, opponent);
         this.maxAge = extra.maxAge;
     }
     /** Return a {@link ClanWarMember} with the tag provided. */
@@ -178,6 +185,10 @@ class ClanWar {
         }
         return this.opponent.attacks.filter((atk) => atk.defenderTag === defenderTag);
     }
+    /** Whether the clan is not in war. */
+    get isNotInWar() {
+        return this.state === 'notInWar';
+    }
     /** Whether this is a Battle Day. */
     get isBattleDay() {
         return this.state === 'inWar';

package/dist/struct/index.d.ts

@@ -17,3 +17,5 @@ export * from './Ranking';
 export * from './Season';
 export * from './Unit';
 export * from './WarLeague';
+export * from './ClanCapital';
+export * from './CapitalRaidSeason';

package/dist/struct/index.js

@@ -33,3 +33,5 @@ __exportStar(require("./Ranking"), exports);
 __exportStar(require("./Season"), exports);
 __exportStar(require("./Unit"), exports);
 __exportStar(require("./WarLeague"), exports);
+__exportStar(require("./ClanCapital"), exports);
+__exportStar(require("./CapitalRaidSeason"), exports);

package/dist/types/api.d.ts

@@ -211,16 +211,16 @@ export interface APICapitalRaidSeasonDistrict {
 }
 export interface APICapitalRaidSeasonAttackLog {
     defender: APICapitalRaidSeasonClan;
-    attackCount: 27;
-    districtCount: 7;
-    districtsDestroyed: 7;
+    attackCount: number;
+    districtCount: number;
+    districtsDestroyed: number;
     districts: APICapitalRaidSeasonDistrict[];
 }
 export interface APICapitalRaidSeasonDefenseLog {
     attacker: APICapitalRaidSeasonClan;
-    attackCount: 27;
-    districtCount: 7;
-    districtsDestroyed: 7;
+    attackCount: number;
+    districtCount: number;
+    districtsDestroyed: number;
     districts: APICapitalRaidSeasonDistrict[];
 }
 export interface APICapitalRaidSeasons {

package/package.json

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