clashofclans.js 3.0.0-dev.f6ce42f → 3.0.0

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/Player.d.ts

@@ -1,4 +1,4 @@
-import { APIPlayer, OverrideOptions } from '../types';
+import { APIPlayer, APIPlayerHouse, OverrideOptions } from '../types';
 import { Client } from '../client/Client';
 import { LegendStatistics } from './LegendStatistics';
 import { Achievement } from './Achievement';
@@ -63,6 +63,8 @@ export declare class Player {
     spells: Spell[];
     /** An array of player's heroes (both home base and build base). */
     heroes: Hero[];
+    /** The player's clan capital house details. */
+    playerHouse?: APIPlayerHouse | null;
     constructor(client: Client, data: APIPlayer);
     /** Whether this clan member is in the clan. */
     get inClan(): boolean;

package/dist/struct/Player.js

@@ -40,6 +40,7 @@ class Player {
         this.troops = data.troops.map((unit) => new Unit_1.Troop(data, unit));
         this.spells = data.spells.map((unit) => new Unit_1.Spell(data, unit));
         this.heroes = data.heroes.map((unit) => new Unit_1.Hero(data, unit));
+        this.playerHouse = data.playerHouse ?? null;
     }
     /** Whether this clan member is in the clan. */
     get inClan() {

package/dist/struct/Unit.d.ts

@@ -39,8 +39,6 @@ export declare class Unit {
     seasonal: boolean;
     /** Damage per second of this unit. */
     dps: number;
-    /** Resource type of this unit. */
-    resourceType: string;
     /** Training time of this unit. */
     trainingTime: number;
     /** @internal */

package/dist/struct/Unit.js

@@ -25,7 +25,6 @@ class Unit {
             this.unlockBuilding = original.unlock.building;
             this.unlockBuildingLevel = original.unlock.buildingLevel;
             this.dps = rawUnit.dps[this.level - 1];
-            this.resourceType = rawSuperUnit.resource;
             this.trainingTime = rawUnit.trainingTime;
             const origin = data.troops.find((troop) => troop.village === 'home' && troop.name === original.name);
             this.level = origin.level;
@@ -49,7 +48,6 @@ class Unit {
             this.upgradeCost = rawUnit.upgrade.cost[this.level - 1] ?? 0;
             this.upgradeTime = rawUnit.upgrade.time[this.level - 1] ?? 0;
             this.dps = rawUnit.dps[this.level - 1];
-            this.resourceType = rawUnit.resourceType;
             this.trainingTime = rawUnit.trainingTime;
             if (rawUnit.category === 'hero')
                 this.regenerationTime = rawUnit.regenerationTimes[this.level - 1];

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

@@ -58,6 +58,9 @@ export interface APIClan {
     labels: APILabel[];
     memberList: APIClanMember[];
     clanCapital: APIClanCapital;
+    isFamilyFriendly: boolean;
+    clanCapitalPoints: number;
+    capitalLeague?: APICapitalLeague;
 }
 export interface APIClanMember {
     name: string;
@@ -71,6 +74,13 @@ export interface APIClanMember {
     previousClanRank: number;
     donations: number;
     donationsReceived: number;
+    playerHouse?: APIPlayerHouse;
+}
+export interface APIPlayerHouse {
+    elements: {
+        type: string;
+        id: number;
+    }[];
 }
 export interface APIClanCapital {
     capitalHallLevel?: number;
@@ -169,6 +179,64 @@ export interface APIClanWarLeagueClanMember {
 export interface APIClanWarLeagueRound {
     warTags: string[];
 }
+export interface APICapitalRaidSeason {
+    state: 'ongoing' | 'ended';
+    startTime: string;
+    endTime: string;
+    capitalTotalLoot: number;
+    raidsCompleted: number;
+    totalAttacks: number;
+    enemyDistrictsDestroyed: number;
+    offensiveReward: number;
+    defensiveReward: number;
+    members?: APICapitalRaidSeasonMember[];
+    attackLog: APICapitalRaidSeasonAttackLog[];
+    defenseLog: APICapitalRaidSeasonDefenseLog[];
+}
+export interface APICapitalRaidSeasonMember {
+    tag: string;
+    name: string;
+    attacks: number;
+    attackLimit: number;
+    bonusAttackLimit: number;
+    capitalResourcesLooted: number;
+}
+export interface APICapitalRaidSeasonClan {
+    tag: string;
+    name: string;
+    level: number;
+    badgeUrls: {
+        small: string;
+        large: string;
+        medium: string;
+    };
+}
+export interface APICapitalRaidSeasonDistrict {
+    id: number;
+    name: string;
+    districtHallLevel: number;
+    destructionPercent: number;
+    attackCount: number;
+    totalLooted: number;
+}
+export interface APICapitalRaidSeasonAttackLog {
+    defender: APICapitalRaidSeasonClan;
+    attackCount: number;
+    districtCount: number;
+    districtsDestroyed: number;
+    districts: APICapitalRaidSeasonDistrict[];
+}
+export interface APICapitalRaidSeasonDefenseLog {
+    attacker: APICapitalRaidSeasonClan;
+    attackCount: number;
+    districtCount: number;
+    districtsDestroyed: number;
+    districts: APICapitalRaidSeasonDistrict[];
+}
+export interface APICapitalRaidSeasons {
+    items: APICapitalRaidSeason[];
+    paging: APIPaging;
+}
 /** /players/{playerTag} */
 export interface APIPlayer {
     name: string;
@@ -199,6 +267,7 @@ export interface APIPlayer {
     heroes: APIPlayerItem[];
     spells: APIPlayerItem[];
     labels: APILabel[];
+    playerHouse?: APIPlayerHouse;
 }
 export interface APILegendStatistics {
     previousSeason?: APISeason;
@@ -313,6 +382,22 @@ export interface APIPlayerVersusRanking {
     previousRank: number;
     clan?: APIPlayerClan;
 }
+export interface APIClanCapitalRanking {
+    clanLevel: number;
+    clanPoints: number;
+    location: APILocation;
+    members: number;
+    tag: string;
+    name: string;
+    rank: number;
+    previousRank: number;
+    badgeUrls: APIBadge;
+    clanCapitalPoints: number;
+}
+export interface APIClanCapitalRankingList {
+    items: APIClanCapitalRanking[];
+    paging: APIPaging;
+}
 /** /leagues */
 export interface APILeagueList {
     items: APILeague[];
@@ -346,6 +431,14 @@ export interface APIWarLeague {
     id: number;
     name: string;
 }
+export interface APICapitalLeague {
+    id: number;
+    name: string;
+}
+export interface APICapitalLeagueList {
+    items: APICapitalLeague[];
+    paging: APIPaging;
+}
 export interface APILabel {
     id: number;
     name: string;

package/dist/util/Constants.d.ts

@@ -24,21 +24,26 @@ 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 NewSeasonStart: "newSeasonStart";
     readonly MaintenanceStart: "maintenanceStart";
     readonly MaintenanceEnd: "maintenanceEnd";
     readonly Error: "error";
     readonly Debug: "debug";
 };
+export declare const ClientEvents: {
+    readonly Error: "error";
+    readonly Debug: "debug";
+};
 export declare const RestEvents: {
     readonly Error: "error";
     readonly Debug: "debug";
+    readonly RateLimited: "rateLimited";
 };
 export declare const CWLRounds: {
     readonly PreviousRound: "warEnded";
@@ -46,7 +51,33 @@ export declare const CWLRounds: {
     readonly NextRound: "preparation";
 };
 export declare const RawData: {
-    RawUnits: {
+    RawUnits: ({
+        id: number;
+        name: string;
+        housingSpace: number;
+        village: string;
+        category: string;
+        subCategory: string;
+        unlock: {
+            hall: number;
+            cost: number;
+            time: number;
+            resource: string;
+            building: string;
+            buildingLevel: number;
+        };
+        trainingTime: number;
+        regenerationTimes: number[];
+        dps: number[];
+        upgrade: {
+            cost: number[];
+            time: number[];
+            resource: string;
+        };
+        seasonal: boolean;
+        levels: number[];
+        resourceType?: undefined;
+    } | {
         id: number;
         name: string;
         housingSpace: number;
@@ -72,7 +103,7 @@ export declare const RawData: {
         };
         seasonal: boolean;
         levels: number[];
-    }[];
+    })[];
     RawSuperUnits: {
         name: string;
         id: number;

package/dist/util/Constants.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RawData = exports.CWLRounds = exports.RestEvents = 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;
+exports.RawData = exports.CWLRounds = exports.RestEvents = exports.ClientEvents = 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.APIBaseURL = 'https://api.clashofclans.com/v1';
 exports.DevSiteAPIBaseURL = 'https://developer.clashofclans.com/api';
@@ -22,11 +22,20 @@ exports.ElixirTroops = [
     'Miner',
     'Electro Dragon',
     'Yeti',
-    'Dragon Rider'
+    'Dragon Rider',
+    'Electro Titan'
 ];
 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.SiegeMachines = [
+    'Wall Wrecker',
+    'Battle Blimp',
+    'Stone Slammer',
+    'Siege Barracks',
+    'Log Launcher',
+    'Flame Flinger',
+    'Battle Drill'
+];
 exports.SuperTroops = [
     'Super Barbarian',
     'Super Archer',
@@ -50,7 +59,8 @@ exports.ElixirSpells = [
     'Jump Spell',
     'Freeze Spell',
     'Clone Spell',
-    'Invisibility Spell'
+    'Invisibility Spell',
+    'Recall Spell'
 ];
 exports.DarkElixirSpells = ['Poison Spell', 'Earthquake Spell', 'Haste Spell', 'Skeleton Spell', 'Bat Spell'];
 exports.Spells = [...exports.ElixirSpells, ...exports.DarkElixirSpells];
@@ -68,7 +78,7 @@ exports.BuilderTroops = [
     'Hog Glider'
 ];
 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.HeroPets = ['L.A.S.S.I', 'Electro Owl', 'Mighty Yak', 'Unicorn', 'Poison Lizard', 'Diggy', 'Frosty', 'Phoenix'];
 exports.UnrankedLeagueData = {
     id: 29000000,
     name: 'Unranked',
@@ -122,22 +132,27 @@ exports.FriendlyWarPreparationTimes = [
     1000 * 60 * 5
 ];
 exports.PollingEvents = {
-    NewSeasonStart: 'newSeasonStart',
     ClanLoopStart: 'clanLoopStart',
     ClanLoopEnd: 'clanLoopEnd',
     PlayerLoopStart: 'playerLoopStart',
     PlayerLoopEnd: 'playerLoopEnd',
     WarLoopStart: 'warLoopEnd',
     WarLoopEnd: 'warLoopEnd',
+    NewSeasonStart: 'newSeasonStart',
     MaintenanceStart: 'maintenanceStart',
     MaintenanceEnd: 'maintenanceEnd',
     Error: 'error',
     Debug: 'debug'
 };
-exports.RestEvents = {
+exports.ClientEvents = {
     Error: 'error',
     Debug: 'debug'
 };
+exports.RestEvents = {
+    Error: 'error',
+    Debug: 'debug',
+    RateLimited: 'rateLimited'
+};
 exports.CWLRounds = {
     PreviousRound: 'warEnded',
     CurrentRound: 'inWar',