clashofclans.js 1.5.4 → 2.0.0-dev.2c5b083

package/dist/struct/ClanWarLog.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ClanWarLog = exports.WarLogClan = void 0;
+const Util_1 = require("../util/Util");
+const Badge_1 = require("./Badge");
+/**
+ * Represents War Log Clan.
+ *
+ * :::caution
+ * If this is called via {@link ClanWarLog.opponent}, then {@link WarLogClan.attackCount} and {@link WarLogClan.expEarned} will be `null`.
+ * For CWL entries {@link WarLogClan.name} and {@link WarLogClan.tag} are `null`.
+ * :::
+ */
+class WarLogClan {
+    constructor(data) {
+        this.name = data.name ?? null;
+        this.tag = data.tag ?? null;
+        this.badge = new Badge_1.Badge(data.badgeUrls);
+        this.level = data.clanLevel;
+        this.stars = data.stars;
+        this.attackCount = data.attacks ?? null;
+        this.destruction = data.destructionPercentage;
+        this.expEarned = data.expEarned ?? null;
+    }
+}
+exports.WarLogClan = WarLogClan;
+class ClanWarLog {
+    constructor(client, data) {
+        this.client = client;
+        this.result = data.result ?? null;
+        this.endTime = Util_1.Util.parseDate(data.endTime);
+        this.teamSize = data.teamSize;
+        this.attacksPerMember = data.attacksPerMember ?? null;
+        this.clan = new WarLogClan(data.clan);
+        this.opponent = new WarLogClan(data.opponent);
+    }
+    /** Returns either `friendly`, `cwl` or `normal`. */
+    get type() {
+        if (!this.clan.expEarned)
+            return 'friendly';
+        if (!this.opponent.tag)
+            return 'cwl';
+        return 'normal';
+    }
+}
+exports.ClanWarLog = ClanWarLog;

package/dist/struct/Icon.d.ts

@@ -0,0 +1,16 @@
+import { APIIcon } from '../types';
+/** Represents a Clash of Clans Icon. */
+export declare class Icon {
+    private readonly _data;
+    /** The default icon URL. */
+    url: string;
+    constructor(data: APIIcon);
+    /** The medium icon URL. */
+    get medium(): string;
+    /** The tiny icon URL. */
+    get tiny(): string;
+    /** The small icon URL. */
+    get small(): string;
+    /** Get unique hash of this Badge. */
+    get hash(): string;
+}

package/dist/struct/Icon.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Icon = void 0;
+/** Represents a Clash of Clans Icon. */
+class Icon {
+    constructor(data) {
+        Object.defineProperty(this, '_data', { value: data });
+        this.url = data.medium ?? data.small;
+    }
+    /** The medium icon URL. */
+    get medium() {
+        return this._data.medium ?? this._data.small;
+    }
+    /** The tiny icon URL. */
+    get tiny() {
+        return this._data.tiny ?? this._data.small;
+    }
+    /** The small icon URL. */
+    get small() {
+        return this._data.small;
+    }
+    /** Get unique hash of this Badge. */
+    get hash() {
+        return this.url.split('/').pop();
+    }
+}
+exports.Icon = Icon;

package/dist/struct/Label.d.ts

@@ -0,0 +1,12 @@
+import { APILabel } from '../types';
+import { Icon } from './Icon';
+/** Represents a Clan or Player Label. */
+export declare class Label {
+    /** The label's unique Id. */
+    id: number;
+    /** The label's name. */
+    name: string;
+    /** The label's icon. */
+    icon: Icon;
+    constructor(data: APILabel);
+}

package/dist/struct/Label.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Label = void 0;
+const Icon_1 = require("./Icon");
+/** Represents a Clan or Player Label. */
+class Label {
+    constructor(data) {
+        this.id = data.id;
+        this.name = data.name;
+        this.icon = new Icon_1.Icon(data.iconUrls);
+    }
+}
+exports.Label = Label;

package/dist/struct/League.d.ts

@@ -0,0 +1,14 @@
+import { APILeague } from '../types';
+import { Icon } from './Icon';
+/** Represents a Player's League. */
+export declare class League {
+    /** The league Id. */
+    id: number;
+    /** The league name. */
+    name: string;
+    /** The League Icon. */
+    icon: Icon;
+    constructor(data: APILeague);
+    /** Position of this League. Starting from 0 (Un-ranked) */
+    get position(): number;
+}

package/dist/struct/League.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.League = void 0;
+const Constants_1 = require("../util/Constants");
+const Icon_1 = require("./Icon");
+/** Represents a Player's League. */
+class League {
+    constructor(data) {
+        this.id = data.id;
+        this.name = data.name;
+        this.icon = new Icon_1.Icon(data.iconUrls);
+    }
+    /** Position of this League. Starting from 0 (Un-ranked) */
+    get position() {
+        return Constants_1.LEAGUES.indexOf(this.id);
+    }
+}
+exports.League = League;

package/dist/struct/LegendStatistics.d.ts

@@ -0,0 +1,18 @@
+import { APILegendStatistics } from '../types';
+import { Season } from './Season';
+/** Represents the Legend Statistics. */
+export declare class LegendStatistics {
+    /** The player's legend trophies. */
+    legendTrophies: number;
+    /** Legend statistics for previous season. */
+    previousSeason: Season | null;
+    /** Legend statistics for this season. */
+    currentSeason: Season | null;
+    /** Legend statistics for this player's best season. */
+    bestSeason: Season | null;
+    /** Versus Legend statistics for previous season. */
+    previousVersusSeason: Season | null;
+    /** Versus Legend statistics for this player's best season. */
+    bestVersusSeason: Season | null;
+    constructor(data: APILegendStatistics);
+}

package/dist/struct/LegendStatistics.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LegendStatistics = void 0;
+const Season_1 = require("./Season");
+/** Represents the Legend Statistics. */
+class LegendStatistics {
+    constructor(data) {
+        this.legendTrophies = data.legendTrophies;
+        this.previousSeason = data.previousSeason ? new Season_1.Season(data.previousSeason) : null;
+        // #blame-supercell
+        this.currentSeason = data.currentSeason?.rank ? new Season_1.Season(data.currentSeason) : null;
+        this.bestSeason = data.bestSeason ? new Season_1.Season(data.bestSeason) : null;
+        this.previousVersusSeason = data.previousVersusSeason ? new Season_1.Season(data.previousVersusSeason) : null;
+        this.bestVersusSeason = data.bestVersusSeason ? new Season_1.Season(data.bestVersusSeason) : null;
+    }
+}
+exports.LegendStatistics = LegendStatistics;

package/dist/struct/Location.d.ts

@@ -0,0 +1,15 @@
+import { APILocation } from '../types';
+/** Represents a Clash of Clans Location. */
+export declare class Location {
+    /** The location Id. */
+    id: number;
+    /** The location name. */
+    name: string;
+    /** A localized name of the location. */
+    localizedName: string | null;
+    /** Indicates whether the location is a country. */
+    isCountry: boolean;
+    /** The country code of the location. */
+    countryCode: string | null;
+    constructor(data: APILocation);
+}

package/dist/struct/Location.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Location = void 0;
+/** Represents a Clash of Clans Location. */
+class Location {
+    constructor(data) {
+        this.id = data.id;
+        this.name = data.name;
+        this.localizedName = data.localizedName ?? null;
+        this.isCountry = data.isCountry;
+        this.countryCode = data.countryCode ?? null;
+    }
+}
+exports.Location = Location;

package/dist/struct/Player.d.ts

@@ -0,0 +1,78 @@
+import { OverrideOptions } from '../rest/RequestHandler';
+import { LegendStatistics } from './LegendStatistics';
+import { Achievement } from './Achievement';
+import { Hero, Spell, Troop } from './Unit';
+import { PlayerClan } from './PlayerClan';
+import { Client } from '../client/Client';
+import { APIPlayer } from '../types';
+import { League } from './League';
+import { Label } from './Label';
+/** Represents a Clash of Clans Player. */
+export declare class Player {
+    client: Client;
+    /** The player's name. */
+    name: string;
+    /** The player's tag. */
+    tag: string;
+    /** The player's Town Hall level.. */
+    townHallLevel: number;
+    /** The player's Town Hall weapon level. */
+    townHallWeaponLevel: number | null;
+    /** The player's experience level. */
+    expLevel: number;
+    /** The player's trophy count. */
+    trophies: number;
+    /** The player's best trophies. */
+    bestTrophies: number;
+    /** The player's war stars. */
+    warStars: number;
+    /** The number of attacks the player has won this season. */
+    attackWins: number;
+    /** The number of defenses the player has won this season. */
+    defenseWins: number;
+    /** The player's builder hall level, or 0 if it hasn't been unlocked. */
+    builderHallLevel: number | null;
+    /** The player's versus trophy count. */
+    versusTrophies: number | null;
+    /** The player's best versus trophies. */
+    bestVersusTrophies: number | null;
+    /** The number of total versus attacks the player has won. */
+    versusBattleWins: number | null;
+    /** The player's donation count for this season. */
+    donations: number;
+    /** The player's donation received count for this season. */
+    received: number;
+    /** The player's role in the clan or `null` if not in a clan. */
+    role: 'member' | 'elder' | 'coLeader' | 'leader' | null;
+    /** Whether the player has selected that they are opted in. This will be `null` if the player is not in a clan. */
+    warOptedIn: boolean | null;
+    /** The player's clan. */
+    clan: PlayerClan | null;
+    /** The player's current League. */
+    league: League;
+    /** The player's legend statistics, or `null` if they have never been in the legend league. */
+    legendStatistics: LegendStatistics | null;
+    /** An array of the player's achievements. */
+    achievements: Achievement[];
+    /** An array of player's labels. */
+    labels: Label[];
+    /** An array of player's troops. */
+    troops: Troop[];
+    /** An array of player's spells. */
+    spells: Spell[];
+    /** An array of player's heroes. */
+    heroes: Hero[];
+    constructor(client: Client, data: APIPlayer);
+    /** Fetch detailed clan info for the player's clan. */
+    fetchClan(options?: OverrideOptions): Promise<import("./Clan").Clan | null>;
+    /** An array of the player's home base troops. */
+    get homeTroops(): Troop[];
+    /** An array of the player's builder base troops. */
+    get builderTroops(): Troop[];
+    /** An array of the player's super troops. */
+    get superTroops(): Troop[];
+    /** An array of the player's hero pets. */
+    get heroPets(): Troop[];
+    /** An array of the player's siege machines. */
+    get siegeMachines(): Troop[];
+}

package/dist/struct/Player.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Player = void 0;
+const Constants_1 = require("../util/Constants");
+const raw_json_1 = require("../util/raw.json");
+const LegendStatistics_1 = require("./LegendStatistics");
+const Achievement_1 = require("./Achievement");
+const Unit_1 = require("./Unit");
+const PlayerClan_1 = require("./PlayerClan");
+const League_1 = require("./League");
+const Label_1 = require("./Label");
+const UNIT_NAMES = [...raw_json_1.RAW_UNITS.map((unit) => unit.name), ...raw_json_1.RAW_SUPER_UNITS.map((unit) => unit.name)];
+/** Represents a Clash of Clans Player. */
+class Player {
+    constructor(client, data) {
+        this.client = client;
+        this.name = data.name;
+        this.tag = data.tag;
+        this.townHallLevel = data.townHallLevel;
+        this.townHallWeaponLevel = data.townHallWeaponLevel ?? null;
+        this.expLevel = data.expLevel;
+        this.trophies = data.trophies;
+        this.bestTrophies = data.bestTrophies;
+        this.warStars = data.warStars;
+        this.attackWins = data.attackWins;
+        this.defenseWins = data.defenseWins;
+        this.builderHallLevel = data.builderHallLevel ?? null;
+        this.versusTrophies = data.versusTrophies ?? null;
+        this.bestVersusTrophies = data.bestVersusTrophies ?? null;
+        this.versusBattleWins = data.versusBattleWins ?? null;
+        this.donations = data.donations;
+        this.received = data.donationsReceived;
+        // @ts-expect-error
+        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.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));
+        this.troops = data.troops.filter((unit) => UNIT_NAMES.includes(unit.name)).map((unit) => new Unit_1.Troop(data, unit));
+        this.spells = data.spells.filter((unit) => UNIT_NAMES.includes(unit.name)).map((unit) => new Unit_1.Spell(data, unit));
+        this.heroes = data.heroes.filter((unit) => UNIT_NAMES.includes(unit.name)).map((unit) => new Unit_1.Hero(data, unit));
+    }
+    /** Fetch detailed clan info for the player's clan. */
+    async fetchClan(options) {
+        if (!this.clan)
+            return null;
+        return this.client.getClan(this.clan.tag, options);
+    }
+    /** An array of the player's home base troops. */
+    get homeTroops() {
+        return this.troops.filter((entry) => entry.isHomeBase);
+    }
+    /** An array of the player's builder base troops. */
+    get builderTroops() {
+        return this.troops.filter((entry) => entry.isBuilderBase);
+    }
+    /** An array of the player's super troops. */
+    get superTroops() {
+        return this.troops.filter((entry) => entry.isSuperTroop);
+    }
+    /** An array of the player's hero pets. */
+    get heroPets() {
+        return this.troops.filter((entry) => entry.isHomeBase && Constants_1.HERO_PETS.includes(entry.name));
+    }
+    /** An array of the player's siege machines. */
+    get siegeMachines() {
+        return this.troops.filter((entry) => entry.isHomeBase && Constants_1.SIEGE_MACHINES.includes(entry.name));
+    }
+}
+exports.Player = Player;

package/dist/struct/PlayerClan.d.ts

@@ -0,0 +1,19 @@
+import { OverrideOptions } from '../rest/RequestHandler';
+import { Client } from '../client/Client';
+import { APIPlayerClan } from '../types';
+import { Badge } from './Badge';
+/** Represents a player's clan. */
+export declare class PlayerClan {
+    private readonly _client;
+    /** Name of the clan. */
+    name: string;
+    /** Tag of the clan. */
+    tag: string;
+    /** Level of this clan. */
+    level: number;
+    /** Badge of this clan. */
+    badge: Badge;
+    constructor(_client: Client, data: APIPlayerClan);
+    /** Fetch detailed clan info for the player's clan. */
+    fetch(options?: OverrideOptions): Promise<import("./Clan").Clan>;
+}

package/dist/struct/PlayerClan.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PlayerClan = void 0;
+const Badge_1 = require("./Badge");
+/** Represents a player's clan. */
+class PlayerClan {
+    constructor(_client, data) {
+        this._client = _client;
+        this.name = data.name;
+        this.tag = data.tag;
+        this.level = data.clanLevel;
+        this.badge = new Badge_1.Badge(data.badgeUrls);
+    }
+    /** Fetch detailed clan info for the player's clan. */
+    fetch(options) {
+        return this._client.getClan(this.tag, options);
+    }
+}
+exports.PlayerClan = PlayerClan;

package/dist/struct/Ranking.d.ts

@@ -0,0 +1,58 @@
+import { APIClanRanking, APIClanVersusRanking, APIPlayerRanking, APIPlayerVersusRanking } from '../types';
+import { PlayerClan } from './PlayerClan';
+import { Client } from '../client/Client';
+import { Location } from './Location';
+import { League } from './League';
+import { Badge } from './Badge';
+/** Represents the player of leader-board ranking. */
+export declare class RankedPlayer {
+    /** The player's name. */
+    name: string;
+    /** The player's tag. */
+    tag: string;
+    /** The player's experience level. */
+    expLevel: number;
+    /** The player's trophy count. If retrieving info for versus leader-boards, this will be `null`. */
+    trophies: number | null;
+    /** The player's attack wins. If retrieving info for versus leader-boards, this will be `null`. */
+    attackWins: number | null;
+    /** The player's defense wins. If retrieving info for versus leader-boards, this will be `null`. */
+    defenseWins: number | null;
+    /** The player's versus trophy count. If retrieving info for regular leader-boards, this will be `null`. */
+    versusTrophies: number | null;
+    /** The number of total versus attacks the player has won. If retrieving info for regular leader-boards, this will be `null`. */
+    versusBattleWins: number | null;
+    /** The player's rank in the clan leader-board. */
+    rank: number;
+    /** The player's rank before the last leader-board change. */
+    previousRank: number;
+    /** The player's clan. */
+    clan: PlayerClan;
+    /** The player's league. If retrieving info for versus leader-boards, this will be `null`. */
+    league: League | null;
+    constructor(client: Client, data: APIPlayerRanking | APIPlayerVersusRanking);
+}
+/** Represents the clan of leader-board ranking. */
+export declare class RankedClan {
+    /** The clan's name. */
+    name: string;
+    /** The clan's tag. */
+    tag: string;
+    /** The clan's level. */
+    level: number;
+    /** The clan's trophy count. If retrieving info for versus leader-boards, this will be `null`.  */
+    points: number | null;
+    /** The clan's versus trophy count. If retrieving info for regular leader boards, this will be `null`. */
+    versusPoints: number | null;
+    /** The clan's location. */
+    location: Location;
+    /** The number of members in the clan. */
+    memberCount: number;
+    /** The clan's rank in the leader board. */
+    rank: number;
+    /** The clan's rank in the previous season's leader-board. */
+    previousRank: number;
+    /** The clan's badge. */
+    badge: Badge;
+    constructor(data: APIClanRanking | APIClanVersusRanking);
+}

package/dist/struct/Ranking.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RankedClan = exports.RankedPlayer = void 0;
+const Constants_1 = require("../util/Constants");
+const PlayerClan_1 = require("./PlayerClan");
+const Location_1 = require("./Location");
+const League_1 = require("./League");
+const Badge_1 = require("./Badge");
+/** Represents the player of leader-board ranking. */
+class RankedPlayer {
+    constructor(client, data) {
+        this.name = data.name;
+        this.tag = data.tag;
+        this.expLevel = data.expLevel;
+        // @ts-expect-error
+        this.trophies = data.trophies ?? null;
+        // @ts-expect-error
+        this.attackWins = data.attackWins ?? null;
+        // @ts-expect-error
+        this.defenseWins = data.defenseWins ?? null;
+        // @ts-expect-error
+        this.versusTrophies = data.versusTrophies ?? null;
+        // @ts-expect-error
+        this.versusBattleWins = data.versusBattleWins ?? null;
+        this.rank = data.rank;
+        this.previousRank = data.previousRank;
+        this.clan = new PlayerClan_1.PlayerClan(client, data.clan);
+        // @ts-expect-error
+        this.league = data.trophies ? new League_1.League(data.league ?? Constants_1.UNRANKED_LEAGUE_DATA) : null; // eslint-disable-line
+    }
+}
+exports.RankedPlayer = RankedPlayer;
+/** Represents the clan of leader-board ranking. */
+class RankedClan {
+    constructor(data) {
+        this.name = data.name;
+        this.tag = data.tag;
+        this.level = data.clanLevel;
+        // @ts-expect-error
+        this.points = data.clanPoints ?? null;
+        // @ts-expect-error
+        this.versusPoints = data.clanVersusPoints ?? null;
+        this.location = new Location_1.Location(data.location);
+        this.memberCount = data.members;
+        this.rank = data.rank;
+        this.previousRank = data.previousRank;
+        this.badge = new Badge_1.Badge(data.badgeUrls);
+    }
+}
+exports.RankedClan = RankedClan;

package/dist/struct/Season.d.ts

@@ -0,0 +1,19 @@
+import { APIGoldPassSeason, APISeason } from '../types';
+/** Represents a player's trophy season. */
+export declare class Season {
+    /** The season's Id. */
+    id: string;
+    /** The player's rank. */
+    rank: number;
+    /** The player's trophy count. */
+    trophies: number;
+    constructor(data: APISeason);
+}
+/** Represents a gold pass season. */
+export declare class GoldPassSeason {
+    /** The start time of the gold pass season. */
+    startTime: Date;
+    /** The end time of this gold pass season. */
+    endTime: Date;
+    constructor(data: APIGoldPassSeason);
+}

package/dist/struct/Season.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GoldPassSeason = exports.Season = void 0;
+const Util_1 = require("../util/Util");
+/** Represents a player's trophy season. */
+class Season {
+    constructor(data) {
+        this.id = data.id || Util_1.Util.getSeasonId();
+        this.rank = data.rank;
+        this.trophies = data.trophies;
+    }
+}
+exports.Season = Season;
+/** Represents a gold pass season. */
+class GoldPassSeason {
+    constructor(data) {
+        this.startTime = Util_1.Util.parseDate(data.startTime);
+        this.endTime = Util_1.Util.parseDate(data.endTime);
+    }
+}
+exports.GoldPassSeason = GoldPassSeason;

package/dist/struct/Unit.d.ts

@@ -0,0 +1,68 @@
+import { APIPlayerItem, APIPlayer } from '../types';
+/** Represents a player's unit. */
+export declare class Unit {
+    /** The name of this unit. */
+    name: string;
+    /** The level of this unit. */
+    level: number;
+    /** The max level of this unit. */
+    maxLevel: number;
+    /** The village type of this unit. */
+    village: 'home' | 'builderBase';
+    /** Id of this unit. */
+    id: number;
+    /** Housing space of this unit. */
+    housingSpace: number;
+    /** Town/Builder hall's max level of this unit. */
+    hallMaxLevel: number;
+    /** Unlock Town/Builder Hall level of this unit. */
+    unlockHallLevel: number;
+    /** Unlock cost of this unit. */
+    unlockCost: number;
+    /** Unlock time of this unit. */
+    unlockTime: number;
+    /** Unlock resource of this unit. */
+    unlockResource: string;
+    /** Unlock building of this unit. */
+    unlockBuilding: string;
+    /** Unlock building level of this unit. */
+    unlockBuildingLevel: number;
+    /** Upgrade cost of this unit. */
+    upgradeCost: number;
+    /** Upgrade resource of this unit. */
+    upgradeResource: string;
+    /** Upgrade time of this unit. */
+    upgradeTime: number;
+    /** @internal */
+    minOriginalLevel: number | null;
+    /** @internal */
+    originalName: string | null;
+    constructor(data: APIPlayer, unit: APIPlayerItem);
+    /** Whether the unit belongs to the home base. */
+    get isHomeBase(): boolean;
+    /** Whether the unit belongs to the builder base. */
+    get isBuilderBase(): boolean;
+    /** Whether the unit is at max level. */
+    get isMax(): boolean;
+    /** Icon of this unit. */
+    get iconURL(): string;
+}
+/** Represents a player's troop. */
+export declare class Troop extends Unit {
+    name: string;
+    /** Whether this troop is currently active of boosted. */
+    isActive: boolean;
+    /** Origin troop's minimum level of this super troop. */
+    minOriginalLevel: number | null;
+    /** Origin troop's name of this super troop. */
+    originalName: string | null;
+    constructor(data: APIPlayer, unit: APIPlayerItem);
+    /** Whether this troop is a Super Troop. */
+    get isSuperTroop(): boolean;
+}
+/** Represents a player's spell. */
+export declare class Spell extends Unit {
+}
+/** Represents a player's hero. */
+export declare class Hero extends Unit {
+}