clashofclans.js 2.6.0 → 2.6.1-dev.208c20e

package/CHANGELOG.md

@@ -2,7 +2,14 @@
 
 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.0
+# 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))
+
+## 2.6.0 (2022-01-29)
 
 ## Features
 

package/dist/client/Client.js

@@ -18,7 +18,7 @@ const struct_1 = require("../struct");
 class Client extends events_1.EventEmitter {
     constructor(options) {
         super();
-        this.rest = new RESTManager_1.RESTManager(options);
+        this.rest = new RESTManager_1.RESTManager({ ...options, rejectIfNotValid: true });
         this.events = new EventManager_1.EventManager(this);
     }
     /** Contains various general-purpose utility methods. */
@@ -150,7 +150,10 @@ class Client extends events_1.EventEmitter {
     }
     /** Get info about clan war league. */
     async getClanWarLeagueGroup(clanTag, options) {
-        const { data } = await this.rest.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);
+        }
         return new struct_1.ClanWarLeagueGroup(this, data);
     }
     /** Get info about a CWL round by WarTag. */

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

@@ -18,6 +18,7 @@ export declare class RequestHandler {
     private get _keys();
     private get _key();
     setKeys(keys: string[]): this;
+    private get creds();
     request<T>(path: string, options?: RequestOptions): Promise<Response<T>>;
     private exec;
     init(options: LoginOptions): Promise<string[]>;

package/dist/rest/RequestHandler.js

@@ -50,6 +50,9 @@ class RequestHandler {
         this.keys = keys;
         return this;
     }
+    get creds() {
+        return Boolean(this.email && this.password);
+    }
     async request(path, options = {}) {
         const cached = (await this.cached?.get(path)) ?? null;
         if (cached && options.force !== true) {
@@ -76,8 +79,11 @@ class RequestHandler {
         const data = await res?.json().catch(() => null);
         if (!res && retries < (options.retryLimit ?? this.retryLimit))
             return this.exec(path, options, ++retries);
-        if (res?.status === 403 && data?.reason === 'accessDenied.invalidIp' && this.email && this.password) {
-            const keys = await this.reValidateKeys().then(() => this.login());
+        if (this.creds &&
+            res?.status === 403 &&
+            data?.reason === 'accessDenied.invalidIp' &&
+            retries < (options.retryLimit ?? this.retryLimit)) {
+            const keys = await this.reValidateKeys().then(() => () => this.login());
             if (keys.length)
                 return this.exec(path, options, ++retries);
         }
@@ -114,7 +120,7 @@ class RequestHandler {
             if (res?.status === 403) {
                 const index = this.keys.indexOf(key);
                 this.keys.splice(index, 1);
-                process.emitWarning(`Pre-defined key #${index + 1} is no longer valid. Removed from the key list.`);
+                process.emitWarning(`Key #${index + 1} is no longer valid. Removed from the key list.`);
             }
         }
     }
@@ -145,14 +151,14 @@ class RequestHandler {
         // Get all available keys from the developer site.
         const keys = (data.keys ?? []);
         // Revoke keys for specified key name but not matching current IP address.
-        for (const key of keys.filter((key) => key.name === this.keyName && !key.cidrRanges.includes(ip))) {
+        for (const key of keys.filter((key) => key.name === this.keyName && !key.cidrRanges?.includes(ip))) {
             if (!(await this.revokeKey(key.id, cookie)))
                 continue;
             const index = keys.findIndex(({ id }) => id === key.id);
             keys.splice(index, 1);
         }
         // Filter keys for current IP address and specified key name.
-        for (const key of keys.filter((key) => key.name === this.keyName && key.cidrRanges.includes(ip))) {
+        for (const key of keys.filter((key) => key.name === this.keyName && key.cidrRanges?.includes(ip))) {
             if (this.keys.length >= this.keyCount)
                 break;
             if (!this.keys.includes(key.key))

package/dist/struct/Clan.d.ts

@@ -60,4 +60,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

@@ -40,5 +40,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/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 {

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. */

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 {

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. */
@@ -41,6 +49,7 @@ exports.ClanWarLeagueRound = ClanWarLeagueRound;
 class ClanWarLeagueGroup {
     constructor(client, data) {
         this.client = client;
+        // @ts-expect-error
         this.state = data.state;
         this.season = data.season;
         this.clans = data.clans.map((clan) => new ClanWarLeagueClan(client, 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;

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 {

package/dist/struct/Player.d.ts

@@ -74,4 +74,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

@@ -76,5 +76,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

@@ -139,7 +139,7 @@ export interface APIClanWarLog {
 }
 /** /clans/{clanTag}/currentwar/leaguegroup */
 export interface APIClanWarLeagueGroup {
-    state: 'preparation' | 'inWar' | 'ended';
+    state: 'notInWar' | 'preparation' | 'inWar' | 'ended';
     season: string;
     clans: APIClanWarLeagueClan[];
     rounds: APIClanWarLeagueRound[];

package/dist/types/lib.d.ts

@@ -67,7 +67,7 @@ export interface OverrideOptions {
     /** Whether to skip the cache check and request the API. */
     force?: boolean;
     /** How many times to retry on 5XX errors. */
-    retryLimit?: string;
+    retryLimit?: number;
     /** Whether to ignore throttlers. */
     ignoreRateLimit?: boolean;
     /** Time to wait before cancelling a REST request, in milliseconds. */

package/dist/util/Store.d.ts

@@ -15,9 +15,9 @@ export interface CacheOptions {
      */
     ttl?: number;
 }
-export declare class CacheStore<T = any> implements Store<T> {
+export declare class CacheStore<T> implements Store<T> {
     private readonly ttl;
-    private readonly sweepInterval?;
+    private readonly sweepInterval;
     private readonly store;
     constructor(options?: CacheOptions);
     private _sweep;

package/dist/util/Util.d.ts

@@ -1,3 +1,4 @@
+import { Clan, ClanMember } from '../struct';
 import { ClanSearchOptions, SearchOptions } from '../types';
 /** Contains various general-purpose utility methods. */
 export declare class Util extends null {
@@ -39,4 +40,6 @@ export declare class Util extends null {
     static getSeasonEndTime(timestamp?: Date): Date;
     static allSettled<T>(values: Promise<T>[]): Promise<T[]>;
     static delay(ms: number): Promise<unknown>;
+    static joinedMembers(oldClan: Clan, newClan: Clan): ClanMember[];
+    static leftMembers(oldClan: Clan, newClan: Clan): ClanMember[];
 }

package/dist/util/Util.js

@@ -28,7 +28,10 @@ class Util extends null {
     }
     /** @internal */
     static parseTag(tag) {
-        return `#${tag.toUpperCase().replace(/O/g, '0').replace(/^#/g, '').replace(/\s/g, '')}`;
+        if (tag && typeof tag === 'string') {
+            return `#${tag.toUpperCase().replace(/O/g, '0').replace(/^#/g, '').replace(/\s/g, '')}`;
+        }
+        throw new TypeError('The "tag" argument must be of type string.');
     }
     /** Encodes a tag as a valid component of a URI. */
     static encodeURI(tag) {
@@ -47,7 +50,7 @@ class Util extends null {
     static encodeTag(tag) {
         const formatted = this.formatTag(tag).substring(1);
         if (!this.isValidTag(formatted)) {
-            throw new Error(`Failed to encode tag ${formatted}. RegExp matching failed.`);
+            throw new TypeError(`Failed to encode tag ${formatted}. RegExp matching failed.`);
         }
         const result = formatted.split('').reduce((sum, char) => sum * BigInt(14) + BigInt(TAG_CHARACTERS.indexOf(char)), BigInt(0));
         return result.toString();
@@ -108,5 +111,17 @@ class Util extends null {
     static async delay(ms) {
         return new Promise((res) => setTimeout(res, ms));
     }
+    static joinedMembers(oldClan, newClan) {
+        const oldMembers = oldClan.members.map((member) => member.tag);
+        return newClan.members.filter((member) => {
+            return !oldMembers.includes(member.tag);
+        });
+    }
+    static leftMembers(oldClan, newClan) {
+        const newMembers = newClan.members.map((member) => member.tag);
+        return oldClan.members.filter((member) => {
+            return !newMembers.includes(member.tag);
+        });
+    }
 }
 exports.Util = Util;

package/package.json

@@ -1,13 +1,17 @@
 {
 	"name": "clashofclans.js",
-	"version": "2.6.0",
+	"version": "2.6.1-dev.208c20e",
 	"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"