clashofclans.js 2.6.1 → 2.7.0

package/CHANGELOG.md

@@ -2,9 +2,15 @@
 
 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.
 
-# 2.6.1 (2022-02-03)
+## 2.7.0 (2022-05-22)
 
-Bug Fixes
+### Features
+
+- Some useful QOL methods have been added. ([#106](https://github.com/clashperk/clashofclans.js/pull/106))
+
+## 2.6.1 (2022-02-03)
+
+### Bug Fixes
 
 -   New value and typings `notInWar` added for `ClanWarLeagueGroup#state` ([#101](https://github.com/clashperk/clashofclans.js/pull/101))
 -   Throw error if `Util.formatTag` / `Util.parseTag` is called with invalid argument ([#102](https://github.com/clashperk/clashofclans.js/pull/101))

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. */
@@ -60,4 +62,6 @@ export declare class Clan {
     constructor(client: Client, data: APIClan);
     /** Get {@link Player} info for every Player in the clan. */
     fetchMembers(options?: OverrideOptions): Promise<Player[]>;
+    /** Get clan's formatted link to open clan in-game. */
+    get shareLink(): string;
 }

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;
@@ -40,5 +41,9 @@ class Clan {
             .filter((res) => res.status === 'fulfilled')
             .map((res) => res.value);
     }
+    /** Get clan's formatted link to open clan in-game. */
+    get shareLink() {
+        return `https://link.clashofclans.com/en?action=OpenClanProfile&tag=${this.tag.replace(/#/g, '')}`;
+    }
 }
 exports.Clan = Clan;

package/dist/struct/ClanMember.d.ts

@@ -26,6 +26,14 @@ export declare class ClanMember {
     /** The member's donation received count for this season. */
     received: number;
     constructor(client: Client, data: APIClanMember);
+    /** Whether this clan member is in the clan. */
+    get isMember(): boolean;
+    /** Whether this clan member is an Elder. */
+    get isElder(): boolean;
+    /** Whether this clan member is a Co-Leader. */
+    get isCoLeader(): boolean;
+    /** Whether this clan member is a Leader. */
+    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,22 @@ class ClanMember {
         this.donations = data.donations;
         this.received = data.donationsReceived;
     }
+    /** Whether this clan member is in the clan. */
+    get isMember() {
+        return this.role === 'member';
+    }
+    /** Whether this clan member is an Elder. */
+    get isElder() {
+        return this.role === 'elder';
+    }
+    /** Whether this clan member is a Co-Leader. */
+    get isCoLeader() {
+        return this.role === 'coLeader';
+    }
+    /** Whether this clan member is a Leader. */
+    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

@@ -58,6 +58,8 @@ export declare class ClanWarMember {
     get defenses(): ClanWarAttack[];
     /** Best opponent attack on this base. */
     get bestOpponentAttack(): ClanWarAttack | null;
+    /** Get member's formatted link to open member in-game. */
+    get shareLink(): string;
     /**
      * Returns the previous best opponent attack on this village.
      * This is useful for calculating the new stars or destruction for new attacks.
@@ -96,6 +98,8 @@ export declare class WarClan {
     get defenses(): ClanWarAttack[];
     /** Get a member of the clan for the given tag, or `null` if not found. */
     getMember(tag: string): ClanWarMember | null;
+    /** Get clan's formatted link to open clan in-game. */
+    get shareLink(): string;
 }
 /** Represents a Clan War in Clash of Clans. */
 export declare class ClanWar {
@@ -131,12 +135,20 @@ 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 this is a Battle Day. */
+    get isBattleDay(): boolean;
+    /** Whether this is a Preparation Day. */
+    get isPreparationDay(): boolean;
+    /** Whether this War has Ended. */
+    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

@@ -72,6 +72,10 @@ class ClanWarMember {
             return null;
         return this.war.getAttack(this._bestOpponentAttackerTag, this.tag);
     }
+    /** Get member's formatted link to open member in-game. */
+    get shareLink() {
+        return `https://link.clashofclans.com/en?action=OpenPlayerProfile&tag=${this.tag.replace(/#/g, '')}`;
+    }
     /**
      * Returns the previous best opponent attack on this village.
      * This is useful for calculating the new stars or destruction for new attacks.
@@ -127,6 +131,10 @@ class WarClan {
     getMember(tag) {
         return this.members.find((m) => m.tag === tag) ?? null;
     }
+    /** Get clan's formatted link to open clan in-game. */
+    get shareLink() {
+        return `https://link.clashofclans.com/en?action=OpenClanProfile&tag=${this.tag.replace(/#/g, '')}`;
+    }
 }
 exports.WarClan = WarClan;
 /** Represents a Clan War in Clash of Clans. */
@@ -170,6 +178,18 @@ class ClanWar {
         }
         return this.opponent.attacks.filter((atk) => atk.defenderTag === defenderTag);
     }
+    /** Whether this is a Battle Day. */
+    get isBattleDay() {
+        return this.state === 'inWar';
+    }
+    /** Whether this is a Preparation Day. */
+    get isPreparationDay() {
+        return this.state === 'preparation';
+    }
+    /** Whether this War has Ended. */
+    get isWarEnded() {
+        return this.state === 'warEnded';
+    }
     /** Returns either `friendly`, `cwl` or `normal`. */
     get type() {
         if (this.isFriendly)
@@ -187,6 +207,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

@@ -12,6 +12,8 @@ export declare class ClanWarLeagueClanMember {
     /** The member's town hall level. */
     townHallLevel: number;
     constructor(data: APIClanWarLeagueClanMember);
+    /** Get member's formatted link to open member in-game. */
+    get shareLink(): string;
 }
 /** Represents a Clan of CWL Group. */
 export declare class ClanWarLeagueClan {
@@ -29,6 +31,8 @@ export declare class ClanWarLeagueClan {
     constructor(client: Client, data: APIClanWarLeagueClan);
     /** Get {@link Player} info for every members that are in the CWL group. */
     fetchMembers(options?: OverrideOptions): Promise<Player[]>;
+    /** Get clan's formatted link to open clan in-game. */
+    get shareLink(): string;
 }
 /** Represents a Round of CWL Group. */
 export declare class ClanWarLeagueRound {
@@ -50,6 +54,8 @@ export declare class ClanWarLeagueGroup {
     /** An array containing all war tags for each round. */
     rounds: ClanWarLeagueRound[];
     constructor(client: Client, data: APIClanWarLeagueGroup);
+    /** Total number of rounds for this CWL. */
+    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

@@ -9,6 +9,10 @@ class ClanWarLeagueClanMember {
         this.tag = data.tag;
         this.townHallLevel = data.townHallLevel;
     }
+    /** Get member's formatted link to open member in-game. */
+    get shareLink() {
+        return `https://link.clashofclans.com/en?action=OpenPlayerProfile&tag=${this.tag.replace(/#/g, '')}`;
+    }
 }
 exports.ClanWarLeagueClanMember = ClanWarLeagueClanMember;
 /** Represents a Clan of CWL Group. */
@@ -27,6 +31,10 @@ class ClanWarLeagueClan {
             .filter((res) => res.status === 'fulfilled')
             .map((res) => res.value);
     }
+    /** Get clan's formatted link to open clan in-game. */
+    get shareLink() {
+        return `https://link.clashofclans.com/en?action=OpenClanProfile&tag=${this.tag.replace(/#/g, '')}`;
+    }
 }
 exports.ClanWarLeagueClan = ClanWarLeagueClan;
 /** Represents a Round of CWL Group. */
@@ -47,6 +55,10 @@ class ClanWarLeagueGroup {
         this.clans = data.clans.map((clan) => new ClanWarLeagueClan(client, clan));
         this.rounds = data.rounds.map((round, i) => new ClanWarLeagueRound(round, i));
     }
+    /** Total number of rounds for this CWL. */
+    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

@@ -31,6 +31,8 @@ export declare class WarLogClan {
      */
     attackCount: number | null;
     constructor(data: APIWarLogClan);
+    /** Get clan's formatted link to open clan in-game. */
+    get shareLink(): string | null;
 }
 export declare class ClanWarLog {
     client: Client;
@@ -49,4 +51,10 @@ export declare class ClanWarLog {
     constructor(client: Client, data: APIClanWarLogEntry);
     /** 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;
 }

package/dist/struct/ClanWarLog.js

@@ -20,6 +20,10 @@ class WarLogClan {
         this.destruction = data.destructionPercentage;
         this.expEarned = data.expEarned ?? null;
     }
+    /** Get clan's formatted link to open clan in-game. */
+    get shareLink() {
+        return this.tag ? `https://link.clashofclans.com/en?action=OpenClanProfile&tag=${this.tag.replace(/#/g, '')}` : null;
+    }
 }
 exports.WarLogClan = WarLogClan;
 class ClanWarLog {
@@ -40,5 +44,17 @@ class ClanWarLog {
             return 'cwl';
         return 'normal';
     }
+    /** Whether this is a friendly war. */
+    get isFriendly() {
+        return this.type === 'friendly';
+    }
+    /** Whether this is a CWL. */
+    get isCWL() {
+        return this.type === 'cwl';
+    }
+    /** Whether this is a normal war. */
+    get isNormal() {
+        return this.type === 'normal';
+    }
 }
 exports.ClanWarLog = ClanWarLog;

package/dist/struct/Player.d.ts

@@ -62,6 +62,16 @@ export declare class Player {
     /** An array of player's heroes (both home base and build base). */
     heroes: Hero[];
     constructor(client: Client, data: APIPlayer);
+    /** Whether this clan member is in the clan. */
+    get inClan(): boolean;
+    /** Whether this clan member is in the clan. */
+    get isMember(): boolean | null;
+    /** Whether this clan member is a Leader. */
+    get isLeader(): boolean | null;
+    /** Whether this clan member is a Co-Leader. */
+    get isCoLeader(): boolean | null;
+    /** Whether this clan member is an Elder. */
+    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. */
@@ -74,4 +84,6 @@ export declare class Player {
     get heroPets(): Troop[];
     /** An array of the player's siege machines. */
     get siegeMachines(): Troop[];
+    /** Get player's formatted link to open player in-game. */
+    get shareLink(): string;
 }

package/dist/struct/Player.js

@@ -40,6 +40,26 @@ 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));
     }
+    /** Whether this clan member is in the clan. */
+    get inClan() {
+        return this.clan !== null;
+    }
+    /** Whether this clan member is in the clan. */
+    get isMember() {
+        return this.clan ? this.role === 'member' : null;
+    }
+    /** Whether this clan member is a Leader. */
+    get isLeader() {
+        return this.clan ? this.role === 'leader' : null;
+    }
+    /** Whether this clan member is a Co-Leader. */
+    get isCoLeader() {
+        return this.clan ? this.role === 'coLeader' : null;
+    }
+    /** Whether this clan member is an Elder. */
+    get isElder() {
+        return this.clan ? this.role === 'elder' : null;
+    }
     /** Fetch detailed clan info for the player's clan. */
     async fetchClan(options) {
         if (!this.clan)
@@ -76,5 +96,9 @@ class Player {
             .filter((entry) => Constants_1.SIEGE_MACHINES.includes(entry.name))
             .sort((a, b) => Constants_1.SIEGE_MACHINES.indexOf(a.name) - Constants_1.SIEGE_MACHINES.indexOf(b.name));
     }
+    /** Get player's formatted link to open player in-game. */
+    get shareLink() {
+        return `https://link.clashofclans.com/en?action=OpenPlayerProfile&tag=${this.tag.replace(/#/g, '')}`;
+    }
 }
 exports.Player = Player;

package/dist/struct/PlayerClan.d.ts

@@ -19,4 +19,6 @@ export declare class PlayerClan {
     constructor(_client: Client, data: APIPlayerClan);
     /** Fetch detailed clan info for the player's clan. */
     fetch(options?: OverrideOptions): Promise<import("./Clan").Clan>;
+    /** Get clan's formatted link to open clan in-game. */
+    get shareLink(): string;
 }

package/dist/struct/PlayerClan.js

@@ -15,5 +15,9 @@ class PlayerClan {
     fetch(options) {
         return this._client.getClan(this.tag, options);
     }
+    /** Get clan's formatted link to open clan in-game. */
+    get shareLink() {
+        return `https://link.clashofclans.com/en?action=OpenClanProfile&tag=${this.tag.replace(/#/g, '')}`;
+    }
 }
 exports.PlayerClan = PlayerClan;

package/dist/struct/Ranking.d.ts

@@ -23,6 +23,8 @@ export declare class SeasonRankedPlayer {
     /** The player's clan. */
     clan: PlayerClan | null;
     constructor(client: Client, data: Omit<APIPlayerRanking, 'league'>);
+    /** Get player's formatted link to open player in-game. */
+    get shareLink(): string;
 }
 /** Represents the Player of location based leader-board ranking. */
 export declare class RankedPlayer {
@@ -51,6 +53,8 @@ export declare class RankedPlayer {
     /** The player's league. If retrieving info for versus leader-boards, this will be `null`. */
     league: League | null;
     constructor(client: Client, data: APIPlayerRanking | APIPlayerVersusRanking);
+    /** Get player's formatted link to open player in-game. */
+    get shareLink(): string;
 }
 /** Represents the Clan of location based leader-board ranking. */
 export declare class RankedClan {
@@ -75,4 +79,6 @@ export declare class RankedClan {
     /** The clan's badge. */
     badge: Badge;
     constructor(data: APIClanRanking | APIClanVersusRanking);
+    /** Get clan's formatted link to open clan in-game. */
+    get shareLink(): string;
 }

package/dist/struct/Ranking.js

@@ -19,6 +19,10 @@ class SeasonRankedPlayer {
         // @ts-expect-error
         this.clan = data.clan ? new PlayerClan_1.PlayerClan(client, data.clan) : null;
     }
+    /** Get player's formatted link to open player in-game. */
+    get shareLink() {
+        return `https://link.clashofclans.com/en?action=OpenPlayerProfile&tag=${this.tag.replace(/#/g, '')}`;
+    }
 }
 exports.SeasonRankedPlayer = SeasonRankedPlayer;
 /** Represents the Player of location based leader-board ranking. */
@@ -44,6 +48,10 @@ class RankedPlayer {
         // @ts-expect-error
         this.league = data.trophies ? new League_1.League(data.league ?? Constants_1.UNRANKED_LEAGUE_DATA) : null; // eslint-disable-line
     }
+    /** Get player's formatted link to open player in-game. */
+    get shareLink() {
+        return `https://link.clashofclans.com/en?action=OpenPlayerProfile&tag=${this.tag.replace(/#/g, '')}`;
+    }
 }
 exports.RankedPlayer = RankedPlayer;
 /** Represents the Clan of location based leader-board ranking. */
@@ -62,5 +70,9 @@ class RankedClan {
         this.previousRank = data.previousRank;
         this.badge = new Badge_1.Badge(data.badgeUrls);
     }
+    /** Get clan's formatted link to open clan in-game. */
+    get shareLink() {
+        return `https://link.clashofclans.com/en?action=OpenClanProfile&tag=${this.tag.replace(/#/g, '')}`;
+    }
 }
 exports.RankedClan = RankedClan;

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",
+	"version": "2.7.0",
 	"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"