clashofclans.js 2.6.1-dev.a42d488 → 2.7.0-dev.31f642e

package/dist/client/Client.d.ts

@@ -34,8 +34,8 @@ export declare class Client extends EventEmitter {
     login(options: LoginOptions): Promise<string[]>;
     /** Set Clash of Clans API keys. */
     setKeys(keys: string[]): this;
-    /** Search all clans by name and/or filtering the results using various criteria. */
-    getClans(query: ClanSearchOptions, options?: OverrideOptions): Promise<Clan[]>;
+    /** Search clans by name and/or filtering parameters or get clans by their tags (fetches in parallel). */
+    getClans(query: ClanSearchOptions | string[], options?: OverrideOptions): Promise<Clan[]>;
     /** Get info about a clan. */
     getClan(clanTag: string, options?: OverrideOptions): Promise<Clan>;
     /** Get list of clan members. */
@@ -85,6 +85,8 @@ export declare class Client extends EventEmitter {
     }, options?: OverrideOptions): Promise<ClanWar>;
     /** Get info about a player by tag. */
     getPlayer(playerTag: string, options?: OverrideOptions): Promise<Player>;
+    /** Get info about some players by their tags (fetches in parallel). */
+    getPlayers(playerTags: string[], options?: OverrideOptions): Promise<Player[]>;
     /** Verify Player API token that can be found from the Game settings. */
     verifyPlayerToken(playerTag: string, token: string, options?: OverrideOptions): Promise<boolean>;
     /** Get list of Leagues. */

package/dist/client/Client.js

@@ -46,8 +46,13 @@ class Client extends events_1.EventEmitter {
         this.rest.handler.setKeys(keys);
         return this;
     }
-    /** Search all clans by name and/or filtering the results using various criteria. */
+    /** Search clans by name and/or filtering parameters or get clans by their tags (fetches in parallel). */
     async getClans(query, options) {
+        if (Array.isArray(query)) {
+            return (await Promise.allSettled(query.map((tag) => this.getClan(tag, options))))
+                .filter((res) => res.status === 'fulfilled')
+                .map((res) => res.value);
+        }
         const { data } = await this.rest.getClans(query, options);
         // @ts-expect-error
         return data.items.map((clan) => new struct_1.Clan(this, clan));
@@ -170,6 +175,12 @@ class Client extends events_1.EventEmitter {
         const { data } = await this.rest.getPlayer(playerTag, options);
         return new struct_1.Player(this, data);
     }
+    /** Get info about some players by their tags (fetches in parallel). */
+    async getPlayers(playerTags, options) {
+        return (await Promise.allSettled(playerTags.map((tag) => this.getPlayer(tag, options))))
+            .filter((res) => res.status === 'fulfilled')
+            .map((res) => res.value);
+    }
     /** Verify Player API token that can be found from the Game settings. */
     async verifyPlayerToken(playerTag, token, options) {
         const { data } = await this.rest.verifyPlayerToken(playerTag, token, options);

package/dist/index.mjs

@@ -0,0 +1,66 @@
+import mod from "./index.js";
+
+export default mod;
+export const API_BASE_URL = mod.API_BASE_URL;
+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 CacheStore = mod.CacheStore;
+export const ChatLanguage = mod.ChatLanguage;
+export const Clan = mod.Clan;
+export const ClanMember = mod.ClanMember;
+export const ClanWar = mod.ClanWar;
+export const ClanWarAttack = mod.ClanWarAttack;
+export const ClanWarLeagueClan = mod.ClanWarLeagueClan;
+export const ClanWarLeagueClanMember = mod.ClanWarLeagueClanMember;
+export const ClanWarLeagueGroup = mod.ClanWarLeagueGroup;
+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 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 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 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 PrivateWarLogError = mod.PrivateWarLogError;
+export const QueueThrottler = mod.QueueThrottler;
+export const RESTManager = mod.RESTManager;
+export const RankedClan = mod.RankedClan;
+export const RankedPlayer = mod.RankedPlayer;
+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 Spell = mod.Spell;
+export const Troop = mod.Troop;
+export const UNRANKED_LEAGUE_DATA = mod.UNRANKED_LEAGUE_DATA;
+export const Unit = mod.Unit;
+export const Util = mod.Util;
+export const WAR_LEAGUES = mod.WAR_LEAGUES;
+export const WarClan = mod.WarClan;
+export const WarLeague = mod.WarLeague;
+export const WarLogClan = mod.WarLogClan;

package/dist/struct/Clan.d.ts

@@ -32,6 +32,8 @@ export declare class Clan {
     versusPoints: number;
     /** The minimum trophies required to apply to this clan. */
     requiredTrophies: number;
+    /** The minimum versus trophies required to apply to this clan. */
+    requiredVersusTrophies: number | null;
     /** The minimum hall level required to apply to this clan. */
     requiredTownHallLevel: number | null;
     /** The frequency for when this clan goes to war. */

package/dist/struct/Clan.js

@@ -23,6 +23,7 @@ class Clan {
         this.versusPoints = data.clanVersusPoints;
         this.requiredTrophies = data.requiredTrophies;
         this.requiredTownHallLevel = data.requiredTownhallLevel ?? null;
+        this.requiredVersusTrophies = data.requiredVersusTrophies ?? null;
         this.warFrequency = data.warFrequency;
         this.warWinStreak = data.warWinStreak;
         this.warWins = data.warWins;

package/dist/struct/ClanMember.d.ts

@@ -26,6 +26,10 @@ export declare class ClanMember {
     /** The member's donation received count for this season. */
     received: number;
     constructor(client: Client, data: APIClanMember);
+    get isMember(): boolean;
+    get isElder(): boolean;
+    get isCoLeader(): boolean;
+    get isLeader(): boolean;
     /** Fetch detailed clan info for the member's clan. */
     fetch(options?: OverrideOptions): Promise<import("./Player").Player>;
 }

package/dist/struct/ClanMember.js

@@ -20,6 +20,18 @@ class ClanMember {
         this.donations = data.donations;
         this.received = data.donationsReceived;
     }
+    get isMember() {
+        return this.role === 'member';
+    }
+    get isElder() {
+        return this.role === 'elder';
+    }
+    get isCoLeader() {
+        return this.role === 'coLeader';
+    }
+    get isLeader() {
+        return this.role === 'leader';
+    }
     /** Fetch detailed clan info for the member's clan. */
     async fetch(options) {
         return this.client.getPlayer(this.tag, options);

package/dist/struct/ClanWar.d.ts

@@ -135,12 +135,17 @@ 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[];
+    get isBattleDay(): boolean;
+    get isPreparationDay(): boolean;
+    get isWarEnded(): boolean;
     /** Returns either `friendly`, `cwl` or `normal`. */
     get type(): "friendly" | "cwl" | "normal";
     /** Whether this is a friendly war. */
     get isFriendly(): boolean;
     /** Whether this is a CWL. */
     get isCWL(): boolean;
+    /** Whether this is a normal war. */
+    get isNormal(): boolean;
     /** Returns the war status, based off the home clan. */
     get status(): "win" | "lose" | "tie" | "pending";
     /** Returns the Clan War League Group. */

package/dist/struct/ClanWar.js

@@ -178,6 +178,15 @@ class ClanWar {
         }
         return this.opponent.attacks.filter((atk) => atk.defenderTag === defenderTag);
     }
+    get isBattleDay() {
+        return this.state === 'inWar';
+    }
+    get isPreparationDay() {
+        return this.state === 'preparation';
+    }
+    get isWarEnded() {
+        return this.state === 'warEnded';
+    }
     /** Returns either `friendly`, `cwl` or `normal`. */
     get type() {
         if (this.isFriendly)
@@ -195,6 +204,10 @@ class ClanWar {
     get isCWL() {
         return typeof this.warTag === 'string';
     }
+    /** Whether this is a normal war. */
+    get isNormal() {
+        return !this.isCWL && !this.isFriendly;
+    }
     /** Returns the war status, based off the home clan. */
     get status() {
         if (this.state === 'preparation')

package/dist/struct/ClanWarLeagueGroup.d.ts

@@ -54,6 +54,7 @@ export declare class ClanWarLeagueGroup {
     /** An array containing all war tags for each round. */
     rounds: ClanWarLeagueRound[];
     constructor(client: Client, data: APIClanWarLeagueGroup);
+    get totalRounds(): number;
     /**
      * This returns an array of {@link ClanWar} which fetches all wars in parallel.
      * @param clanTag Optional clan tag. If present, this will only return wars which belong to this clan.

package/dist/struct/ClanWarLeagueGroup.js

@@ -55,6 +55,9 @@ class ClanWarLeagueGroup {
         this.clans = data.clans.map((clan) => new ClanWarLeagueClan(client, clan));
         this.rounds = data.rounds.map((round, i) => new ClanWarLeagueRound(round, i));
     }
+    get totalRounds() {
+        return this.clans.length - 1;
+    }
     /**
      * This returns an array of {@link ClanWar} which fetches all wars in parallel.
      * @param clanTag Optional clan tag. If present, this will only return wars which belong to this clan.

package/dist/struct/ClanWarLog.d.ts

@@ -51,4 +51,7 @@ export declare class ClanWarLog {
     constructor(client: Client, data: APIClanWarLogEntry);
     /** Returns either `friendly`, `cwl` or `normal`. */
     get type(): "friendly" | "cwl" | "normal";
+    get isFriendly(): boolean;
+    get isCWL(): boolean;
+    get isNormal(): boolean;
 }

package/dist/struct/ClanWarLog.js

@@ -44,5 +44,14 @@ class ClanWarLog {
             return 'cwl';
         return 'normal';
     }
+    get isFriendly() {
+        return this.type === 'friendly';
+    }
+    get isCWL() {
+        return this.type === 'cwl';
+    }
+    get isNormal() {
+        return this.type === 'normal';
+    }
 }
 exports.ClanWarLog = ClanWarLog;

package/dist/struct/Player.d.ts

@@ -62,6 +62,11 @@ export declare class Player {
     /** An array of player's heroes (both home base and build base). */
     heroes: Hero[];
     constructor(client: Client, data: APIPlayer);
+    get inClan(): boolean;
+    get isMember(): boolean | null;
+    get isLeader(): boolean | null;
+    get isCoLeader(): boolean | null;
+    get isElder(): boolean | null;
     /** 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. */

package/dist/struct/Player.js

@@ -40,6 +40,21 @@ class Player {
         this.spells = data.spells.map((unit) => new Unit_1.Spell(data, unit));
         this.heroes = data.heroes.map((unit) => new Unit_1.Hero(data, unit));
     }
+    get inClan() {
+        return this.clan !== null;
+    }
+    get isMember() {
+        return this.clan ? this.role === 'member' : null;
+    }
+    get isLeader() {
+        return this.clan ? this.role === 'leader' : null;
+    }
+    get isCoLeader() {
+        return this.clan ? this.role === 'coLeader' : null;
+    }
+    get isElder() {
+        return this.clan ? this.role === 'elder' : null;
+    }
     /** Fetch detailed clan info for the player's clan. */
     async fetchClan(options) {
         if (!this.clan)

package/dist/types/api.d.ts

@@ -46,6 +46,7 @@ export interface APIClan {
     clanVersusPoints: number;
     requiredTrophies: number;
     requiredTownhallLevel?: number;
+    requiredVersusTrophies?: number;
     warFrequency: 'always' | 'moreThanOncePerWeek' | 'oncePerWeek' | 'lessThanOncePerWeek' | 'never' | 'unknown';
     warWinStreak: number;
     warWins: number;
@@ -175,6 +176,7 @@ export interface APIPlayer {
     versusTrophies?: number;
     bestVersusTrophies?: number;
     versusBattleWins?: number;
+    versusBattleWinCount?: number;
     donations: number;
     donationsReceived: number;
     role?: string;

package/package.json

@@ -1,13 +1,17 @@
 {
 	"name": "clashofclans.js",
-	"version": "2.6.1-dev.a42d488",
+	"version": "2.7.0-dev.31f642e",
 	"description": "JavaScript library for interacting with the Clash of Clans API",
 	"author": "SUVAJIT <suvajit.me@gmail.com>",
 	"license": "MIT",
 	"main": "dist/index.js",
-	"types": "dist/index.d.ts",
+	"exports": {
+		"import": "./dist/index.mjs",
+		"require": "./dist/index.js",
+		"types": "./dist/index.d.ts"
+	},
 	"scripts": {
-		"build": "tsc",
+		"build": "tsc && gen-esm-wrapper dist/index.js dist/index.mjs",
 		"prepare": "rimraf dist && npm run build",
 		"test": "eslint --ext .ts --ignore-path .gitignore .",
 		"lint": "eslint --fix --ext .ts --ignore-path .gitignore ."
@@ -104,6 +108,7 @@
 		"eslint-config-marine": "^9.0.6",
 		"eslint-config-prettier": "^8.3.0",
 		"eslint-plugin-prettier": "^4.0.0",
+		"gen-esm-wrapper": "^1.1.3",
 		"prettier": "^2.4.1",
 		"rimraf": "^3.0.2",
 		"typescript": "^4.5.2"