clashofclans.js 2.0.0-dev.c0ee4c0 → 2.0.1-dev.82b84ba

package/dist/rest/RESTManager.d.ts

@@ -2,150 +2,55 @@ import { RequestHandler, SearchOptions, ClanSearchOptions, ClientOptions, Overri
 import { APIClan, APIClanList, APIClanMemberList, APIClanRankingList, APIClanVersusRankingList, APIClanWar, APIClanWarLeagueGroup, APIClanWarLog, APIGoldPassSeason, APILabelList, APILeague, APILeagueList, APILeagueSeasonList, APILocation, APILocationList, APIPlayer, APIPlayerRankingList, APIPlayerSeasonRankingList, APIPlayerVersusRankingList, APIVerifyToken, APIWarLeague, APIWarLeagueList } from '../types';
 /** Represents a REST Manager of the client. */
 export declare class RESTManager {
+    /** Request Handler for the RESTManager. */
     readonly handler: RequestHandler;
     constructor(options?: ClientOptions);
-    getClans(options: ClanSearchOptions): Promise<{
-        data: APIClanList;
-        maxAge: number;
-        status: number;
-        path: string;
-    }>;
-    getClan(clanTag: string, options?: OverrideOptions): Promise<{
-        data: APIClan;
-        maxAge: number;
-        status: number;
-        path: string;
-    }>;
-    getClanMembers(clanTag: string, options?: SearchOptions): Promise<{
-        data: APIClanMemberList;
-        maxAge: number;
-        status: number;
-        path: string;
-    }>;
-    getClanWarLog(clanTag: string, options?: SearchOptions): Promise<{
-        data: APIClanWarLog;
-        maxAge: number;
-        status: number;
-        path: string;
-    }>;
-    getCurrentWar(clanTag: string, options?: OverrideOptions): Promise<{
-        data: APIClanWar;
-        maxAge: number;
-        status: number;
-        path: string;
-    }>;
-    getClanWarLeagueGroup(clanTag: string, options?: OverrideOptions): Promise<{
-        data: APIClanWarLeagueGroup;
-        maxAge: number;
-        status: number;
-        path: string;
-    }>;
-    getClanWarLeagueRound(warTag: string, options?: OverrideOptions): Promise<{
-        data: APIClanWar;
-        maxAge: number;
-        status: number;
-        path: string;
-    }>;
-    getPlayer(playerTag: string, options?: OverrideOptions): Promise<{
-        data: APIPlayer;
-        maxAge: number;
-        status: number;
-        path: string;
-    }>;
-    postPlayerToken(playerTag: string, token: string, options?: OverrideOptions): Promise<{
-        data: APIVerifyToken;
-        maxAge: number;
-        status: number;
-        path: string;
-    }>;
-    getLeagues(options?: SearchOptions): Promise<{
-        data: APILeagueList;
-        maxAge: number;
-        status: number;
-        path: string;
-    }>;
-    getLeague(leagueId: string | number, options?: OverrideOptions): Promise<{
-        data: APILeague;
-        maxAge: number;
-        status: number;
-        path: string;
-    }>;
-    getLeagueSeasons(leagueId: number, options?: SearchOptions): Promise<{
-        data: APILeagueSeasonList;
-        maxAge: number;
-        status: number;
-        path: string;
-    }>;
-    getSeasonRankings(leagueId: number, seasonId: string, options?: SearchOptions): Promise<{
-        data: APIPlayerSeasonRankingList;
-        maxAge: number;
-        status: number;
-        path: string;
-    }>;
-    getWarLeagues(options?: SearchOptions): Promise<{
-        data: APIWarLeagueList;
-        maxAge: number;
-        status: number;
-        path: string;
-    }>;
-    getWarLeague(leagueId: number, options?: OverrideOptions): Promise<{
-        data: APIWarLeague;
-        maxAge: number;
-        status: number;
-        path: string;
-    }>;
-    getLocations(options?: SearchOptions): Promise<{
-        data: APILocationList;
-        maxAge: number;
-        status: number;
-        path: string;
-    }>;
-    getLocation(locationId: number, options?: OverrideOptions): Promise<{
-        data: APILocation;
-        maxAge: number;
-        status: number;
-        path: string;
-    }>;
-    getClanRanks(locationId: number | string, options?: SearchOptions): Promise<{
-        data: APIClanRankingList;
-        maxAge: number;
-        status: number;
-        path: string;
-    }>;
-    getPlayerRanks(locationId: number | string, options?: SearchOptions): Promise<{
-        data: APIPlayerRankingList;
-        maxAge: number;
-        status: number;
-        path: string;
-    }>;
-    getVersusClanRanks(locationId: number | string, options?: SearchOptions): Promise<{
-        data: APIClanVersusRankingList;
-        maxAge: number;
-        status: number;
-        path: string;
-    }>;
-    getVersusPlayerRanks(locationId: number | string, options?: SearchOptions): Promise<{
-        data: APIPlayerVersusRankingList;
-        maxAge: number;
-        status: number;
-        path: string;
-    }>;
-    getClanLabels(options?: SearchOptions): Promise<{
-        data: APILabelList;
-        maxAge: number;
-        status: number;
-        path: string;
-    }>;
-    getPlayerLabels(options?: SearchOptions): Promise<{
-        data: APILabelList;
-        maxAge: number;
-        status: number;
-        path: string;
-    }>;
-    getGoldPassSeason(options?: OverrideOptions): Promise<{
-        data: APIGoldPassSeason;
-        maxAge: number;
-        status: number;
-        path: string;
-    }>;
+    /** Search all clans by name and/or filtering the results using various criteria. */
+    getClans(options: ClanSearchOptions): Promise<import("./RequestHandler").Response<APIClanList>>;
+    /** Get information about a clan. */
+    getClan(clanTag: string, options?: OverrideOptions): Promise<import("./RequestHandler").Response<APIClan>>;
+    /** Get list of clan members. */
+    getClanMembers(clanTag: string, options?: SearchOptions): Promise<import("./RequestHandler").Response<APIClanMemberList>>;
+    /** Get clan war log. */
+    getClanWarLog(clanTag: string, options?: SearchOptions): Promise<import("./RequestHandler").Response<APIClanWarLog>>;
+    /** Get info about currently running war in the clan. */
+    getCurrentWar(clanTag: string, options?: OverrideOptions): Promise<import("./RequestHandler").Response<APIClanWar>>;
+    /** Get information about clan war league. */
+    getClanWarLeagueGroup(clanTag: string, options?: OverrideOptions): Promise<import("./RequestHandler").Response<APIClanWarLeagueGroup>>;
+    /** Get info about a CWL round by WarTag. */
+    getClanWarLeagueRound(warTag: string, options?: OverrideOptions): Promise<import("./RequestHandler").Response<APIClanWar>>;
+    /** Get information about a player by tag. */
+    getPlayer(playerTag: string, options?: OverrideOptions): Promise<import("./RequestHandler").Response<APIPlayer>>;
+    /** Verify Player API token that can be found from the Game settings. */
+    verifyPlayerToken(playerTag: string, token: string, options?: OverrideOptions): Promise<import("./RequestHandler").Response<APIVerifyToken>>;
+    /** Get list of Leagues. */
+    getLeagues(options?: SearchOptions): Promise<import("./RequestHandler").Response<APILeagueList>>;
+    /** Get a League info. */
+    getLeague(leagueId: string | number, options?: OverrideOptions): Promise<import("./RequestHandler").Response<APILeague>>;
+    /** Get Legend League season Ids. */
+    getLeagueSeasons(leagueId: number, options?: SearchOptions): Promise<import("./RequestHandler").Response<APILeagueSeasonList>>;
+    /** Get Legend League season rankings by season Id. */
+    getSeasonRankings(leagueId: number, seasonId: string, options?: SearchOptions): Promise<import("./RequestHandler").Response<APIPlayerSeasonRankingList>>;
+    /** Get list of Clan War Leagues. */
+    getWarLeagues(options?: SearchOptions): Promise<import("./RequestHandler").Response<APIWarLeagueList>>;
+    /** Get info about a Clan War League. */
+    getWarLeague(leagueId: number, options?: OverrideOptions): Promise<import("./RequestHandler").Response<APIWarLeague>>;
+    /** Get list of Locations. */
+    getLocations(options?: SearchOptions): Promise<import("./RequestHandler").Response<APILocationList>>;
+    /** Get info about a Location. */
+    getLocation(locationId: number, options?: OverrideOptions): Promise<import("./RequestHandler").Response<APILocation>>;
+    /** Get clan rankings for a specific location. */
+    getClanRanks(locationId: number | string, options?: SearchOptions): Promise<import("./RequestHandler").Response<APIClanRankingList>>;
+    /** Get player rankings for a specific location. */
+    getPlayerRanks(locationId: number | string, options?: SearchOptions): Promise<import("./RequestHandler").Response<APIPlayerRankingList>>;
+    /** Get clan versus rankings for a specific location. */
+    getVersusClanRanks(locationId: number | string, options?: SearchOptions): Promise<import("./RequestHandler").Response<APIClanVersusRankingList>>;
+    /** Get player versus rankings for a specific location. */
+    getVersusPlayerRanks(locationId: number | string, options?: SearchOptions): Promise<import("./RequestHandler").Response<APIPlayerVersusRankingList>>;
+    /** Get list of clan labels. */
+    getClanLabels(options?: SearchOptions): Promise<import("./RequestHandler").Response<APILabelList>>;
+    /** Get list of player labels. */
+    getPlayerLabels(options?: SearchOptions): Promise<import("./RequestHandler").Response<APILabelList>>;
+    /** Get info about gold pass season. */
+    getGoldPassSeason(options?: OverrideOptions): Promise<import("./RequestHandler").Response<APIGoldPassSeason>>;
 }

package/dist/rest/RESTManager.js

@@ -8,90 +8,114 @@ class RESTManager {
     constructor(options) {
         this.handler = new RequestHandler_1.RequestHandler(options);
     }
+    /** Search all clans by name and/or filtering the results using various criteria. */
     getClans(options) {
         const query = Util_1.Util.queryString(options);
         return this.handler.request(`/clans?${query}`);
     }
+    /** Get information about a clan. */
     getClan(clanTag, options) {
         return this.handler.request(`/clans/${Util_1.Util.encodeTag(clanTag)}`, options);
     }
+    /** Get list of clan members. */
     getClanMembers(clanTag, options) {
         const query = Util_1.Util.queryString(options);
         return this.handler.request(`/clans/${Util_1.Util.encodeTag(clanTag)}/members?${query}`, options);
     }
+    /** Get clan war log. */
     getClanWarLog(clanTag, options) {
         const query = Util_1.Util.queryString(options);
         return this.handler.request(`/clans/${Util_1.Util.encodeTag(clanTag)}/warlog?${query}`, options);
     }
+    /** Get info about currently running war in the clan. */
     getCurrentWar(clanTag, options) {
         return this.handler.request(`/clans/${Util_1.Util.encodeTag(clanTag)}/currentwar`, options);
     }
+    /** Get information about clan war league. */
     getClanWarLeagueGroup(clanTag, options) {
         return this.handler.request(`/clans/${Util_1.Util.encodeTag(clanTag)}/currentwar/leaguegroup`, options);
     }
+    /** Get info about a CWL round by WarTag. */
     getClanWarLeagueRound(warTag, options) {
         return this.handler.request(`/clanwarleagues/wars/${Util_1.Util.encodeTag(warTag)}`, options);
     }
+    /** Get information about a player by tag. */
     getPlayer(playerTag, options) {
         return this.handler.request(`/players/${Util_1.Util.encodeTag(playerTag)}`, options);
     }
-    postPlayerToken(playerTag, token, options) {
+    /** Verify Player API token that can be found from the Game settings. */
+    verifyPlayerToken(playerTag, token, options) {
         const opts = { method: 'POST', body: JSON.stringify({ token }), ...options };
         return this.handler.request(`/players/${Util_1.Util.encodeTag(playerTag)}/verifytoken`, opts);
     }
+    /** Get list of Leagues. */
     getLeagues(options) {
         const query = Util_1.Util.queryString(options);
         return this.handler.request(`/leagues?${query}`, options);
     }
+    /** Get a League info. */
     getLeague(leagueId, options) {
         return this.handler.request(`/leagues/${leagueId}`, options);
     }
+    /** Get Legend League season Ids. */
     getLeagueSeasons(leagueId, options) {
         const query = Util_1.Util.queryString(options);
         return this.handler.request(`/leagues/${leagueId}/seasons?${query}`, options);
     }
+    /** Get Legend League season rankings by season Id. */
     getSeasonRankings(leagueId, seasonId, options) {
         const query = Util_1.Util.queryString(options);
         return this.handler.request(`/leagues/${leagueId}/seasons/${seasonId}?${query}`, options);
     }
+    /** Get list of Clan War Leagues. */
     getWarLeagues(options) {
         const query = Util_1.Util.queryString(options);
         return this.handler.request(`/warleagues?${query}`, options);
     }
+    /** Get info about a Clan War League. */
     getWarLeague(leagueId, options) {
         return this.handler.request(`/warleagues/${leagueId}`, options);
     }
+    /** Get list of Locations. */
     getLocations(options) {
         const query = Util_1.Util.queryString(options);
         return this.handler.request(`/locations?${query}`, options);
     }
+    /** Get info about a Location. */
     getLocation(locationId, options) {
         return this.handler.request(`/locations/${locationId}`, options);
     }
+    /** Get clan rankings for a specific location. */
     getClanRanks(locationId, options) {
         const query = Util_1.Util.queryString(options);
         return this.handler.request(`/locations/${locationId}/rankings/clans?${query}`, options);
     }
+    /** Get player rankings for a specific location. */
     getPlayerRanks(locationId, options) {
         const query = Util_1.Util.queryString(options);
         return this.handler.request(`/locations/${locationId}/rankings/players?${query}`, options);
     }
+    /** Get clan versus rankings for a specific location. */
     getVersusClanRanks(locationId, options) {
         const query = Util_1.Util.queryString(options);
         return this.handler.request(`/locations/${locationId}/rankings/clans-versus?${query}`, options);
     }
+    /** Get player versus rankings for a specific location. */
     getVersusPlayerRanks(locationId, options) {
         const query = Util_1.Util.queryString(options);
         return this.handler.request(`/locations/${locationId}/rankings/players-versus?${query}`, options);
     }
+    /** Get list of clan labels. */
     getClanLabels(options) {
         const query = Util_1.Util.queryString(options);
         return this.handler.request(`/labels/clans?${query}`, options);
     }
+    /** Get list of player labels. */
     getPlayerLabels(options) {
         const query = Util_1.Util.queryString(options);
         return this.handler.request(`/labels/players?${query}`, options);
     }
+    /** Get info about gold pass season. */
     getGoldPassSeason(options) {
         return this.handler.request('/goldpass/seasons/current', options);
     }

package/dist/rest/RequestHandler.d.ts

@@ -11,19 +11,14 @@ export declare class RequestHandler {
     private keys;
     private readonly baseURL;
     private readonly retryLimit;
-    private readonly cached;
     private readonly restRequestTimeout;
     private readonly throttler?;
+    private readonly cached;
     constructor(options?: ClientOptions);
     private get _keys();
     private get _key();
     setKeys(keys: string[]): this;
-    request<T>(path: string, options?: RequestOptions): Promise<{
-        data: T;
-        maxAge: number;
-        status: number;
-        path: string;
-    }>;
+    request<T>(path: string, options?: RequestOptions): Promise<Response<T>>;
     private exec;
     init(options: InitOptions): Promise<string[]>;
     private reValidateKeys;
@@ -97,9 +92,21 @@ export interface OverrideOptions {
     restRequestTimeout?: number;
 }
 export interface RequestOptions extends OverrideOptions {
+    /** The request body. */
     body?: string;
+    /** The request method. */
     method?: string;
 }
+export interface Response<T> {
+    /** The response body. */
+    data: T;
+    /** Path of the request for this response. */
+    path: string;
+    /** HTTP status code of this response. */
+    status: number;
+    /** The maxAge of this response. */
+    maxAge: number;
+}
 /**
  * Clan search options for a request.
  *

package/dist/rest/RequestHandler.js

@@ -21,6 +21,7 @@ const HTTPError_1 = require("./HTTPError");
 const node_fetch_1 = __importDefault(require("node-fetch"));
 const https_1 = __importDefault(require("https"));
 const keyv_1 = __importDefault(require("keyv"));
+const IP_REGEX = /\d{1,3}.\d{1,3}.\d{1,3}.\d{1,3}/g;
 const agent = new https_1.default.Agent({ keepAlive: true });
 /** Represents a Request Handler. */
 class RequestHandler {
@@ -50,8 +51,9 @@ class RequestHandler {
     }
     async request(path, options = {}) {
         const cached = (await this.cached?.get(path)) ?? null;
-        if (cached && options.force !== true)
-            return { data: cached, maxAge: 0, status: 200, path };
+        if (cached && options.force !== true) {
+            return { data: cached.data, maxAge: cached.ttl - Date.now(), status: 200, path };
+        }
         if (!this.throttler || options.ignoreRateLimit)
             return this.exec(path, options);
         await this.throttler.wait();
@@ -74,16 +76,18 @@ class RequestHandler {
         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) {
-            await this.login();
-            return this.exec(path, options, ++retries);
+            const keys = await this.reValidateKeys().then(() => this.login());
+            if (keys.length)
+                return this.exec(path, options, ++retries);
         }
         const maxAge = Number(res?.headers.get('cache-control')?.split('=')?.[1] ?? 0) * 1000;
         if (res?.status === 403 && !data?.message)
-            throw new HTTPError_1.HTTPError(HTTPError_1.privateWarLogError, res.status, path, maxAge);
+            throw new HTTPError_1.HTTPError(HTTPError_1.PrivateWarLogError, res.status, path, maxAge);
         if (!res?.ok)
             throw new HTTPError_1.HTTPError(data, res?.status ?? 504, path, maxAge, options.method);
-        if (this.cached && maxAge > 0 && options.cache !== false)
-            await this.cached.set(path, data, maxAge);
+        if (this.cached && maxAge > 0 && options.cache !== false) {
+            await this.cached.set(path, { data, ttl: Date.now() + maxAge }, maxAge);
+        }
         return { data, maxAge, status: res.status, path };
     }
     async init(options) {
@@ -107,33 +111,38 @@ class RequestHandler {
             if (res?.status === 403) {
                 const index = this.keys.indexOf(key);
                 this.keys.splice(index, 1);
-                console.warn(`[WARN] Pre-defined key #${index + 1} is no longer valid. Removed from the key list.`);
+                process.emitWarning(`Pre-defined key #${index + 1} is no longer valid. Removed from the key list.`);
             }
         }
     }
     async login() {
         const res = await (0, node_fetch_1.default)(`${Constants_1.DEV_SITE_API_BASE_URL}/login`, {
             method: 'POST',
+            timeout: 10000,
             headers: { 'Content-Type': 'application/json' },
             body: JSON.stringify({ email: this.email, password: this.password })
         });
-        if (res.ok) {
-            return this.getKeys(res.headers.get('set-cookie'));
-        }
-        throw new ReferenceError('Invalid email or password.');
+        const data = await res.json();
+        if (!res.ok)
+            throw new Error(`Invalid email or password. ${JSON.stringify(data)}`);
+        const ip = await this.getIp(data.temporaryAPIToken);
+        if (!ip)
+            throw new Error('Failed to get the IP address.');
+        return this.getKeys(res.headers.get('set-cookie'), ip);
     }
-    async getKeys(cookie) {
-        const ip = await this.getIp();
+    async getKeys(cookie, ip) {
         const res = await (0, node_fetch_1.default)(`${Constants_1.DEV_SITE_API_BASE_URL}/apikey/list`, {
             method: 'POST',
+            timeout: 10000,
             headers: { 'Content-Type': 'application/json', cookie }
         });
         const data = await res.json();
+        if (!res.ok)
+            throw new Error(`Failed to retrieve the API Keys. ${JSON.stringify(data)}`);
         // Get all available keys from the developer site.
         const keys = (data.keys ?? []);
         // Revoke keys for specified key name but not matching current IP address.
-        const expiredKeys = keys.filter((key) => key.name === this.keyName && !key.cidrRanges.includes(ip));
-        for (const key of expiredKeys) {
+        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);
@@ -153,7 +162,7 @@ class RequestHandler {
             keys.push(key);
         }
         if (this.keys.length < this.keyCount && keys.length === 10) {
-            console.warn(`[WARN] ${this.keyCount} key(s) were requested but failed to create ${this.keyCount - this.keys.length} more key(s).`);
+            process.emitWarning(`${this.keyCount} key(s) were requested but failed to create ${this.keyCount - this.keys.length} more key(s).`);
         }
         if (!this.keys.length) {
             throw new Error([
@@ -166,6 +175,7 @@ class RequestHandler {
     async revokeKey(keyId, cookie) {
         const res = await (0, node_fetch_1.default)(`${Constants_1.DEV_SITE_API_BASE_URL}/apikey/revoke`, {
             method: 'POST',
+            timeout: 10000,
             body: JSON.stringify({ id: keyId }),
             headers: { 'Content-Type': 'application/json', cookie }
         });
@@ -174,6 +184,7 @@ class RequestHandler {
     async createKey(cookie, ip) {
         const res = await (0, node_fetch_1.default)(`${Constants_1.DEV_SITE_API_BASE_URL}/apikey/create`, {
             method: 'POST',
+            timeout: 10000,
             headers: { 'Content-Type': 'application/json', cookie },
             body: JSON.stringify({
                 cidrRanges: [ip],
@@ -182,10 +193,20 @@ class RequestHandler {
             })
         });
         const data = await res.json();
+        if (!res.ok)
+            throw new Error(`Failed to create API Key. ${JSON.stringify(data)}`);
         return data.key;
     }
-    async getIp() {
-        return (0, node_fetch_1.default)('https://api.ipify.org/').then((res) => res.text());
+    async getIp(token) {
+        try {
+            const decoded = JSON.parse(Buffer.from(token.split('.')[1], 'base64').toString());
+            const props = decoded.limits.find((limit) => limit.hasOwnProperty('cidrs'));
+            return props.cidrs[0].match(IP_REGEX)[0];
+        }
+        catch {
+            const body = await (0, node_fetch_1.default)('https://api.ipify.org', { timeout: 10000 }).then((res) => res.text());
+            return body.match(IP_REGEX)?.[0] ?? null;
+        }
     }
 }
 exports.RequestHandler = RequestHandler;

package/dist/rest/Throttler.d.ts

@@ -29,7 +29,3 @@ export declare class BatchThrottler {
     wait(): Promise<void>;
     throttle(): Promise<void>;
 }
-export interface DeferredPromise {
-    resolve(): void;
-    promise: Promise<void>;
-}

package/dist/struct/Clan.d.ts

@@ -1,3 +1,4 @@
+import { OverrideOptions } from '../rest/RequestHandler';
 import { ChatLanguage } from './ChatLanguage';
 import { ClanMember } from './ClanMember';
 import { Client } from '../client/Client';
@@ -59,5 +60,5 @@ export declare class Clan {
     members: ClanMember[];
     constructor(client: Client, data: APIClan);
     /** Get {@link Player} information for every Player in the clan. */
-    fetchMembers(): Promise<Player[]>;
+    fetchMembers(options?: OverrideOptions): Promise<Player[]>;
 }

package/dist/struct/Clan.js

@@ -35,8 +35,8 @@ class Clan {
         this.members = data.memberList?.map((mem) => new ClanMember_1.ClanMember(this.client, mem)) ?? []; // eslint-disable-line
     }
     /** Get {@link Player} information for every Player in the clan. */
-    async fetchMembers() {
-        return (await Promise.allSettled(this.members.map((m) => this.client.getPlayer(m.tag, { ignoreRateLimit: true }))))
+    async fetchMembers(options) {
+        return (await Promise.allSettled(this.members.map((m) => this.client.getPlayer(m.tag, { ...options, ignoreRateLimit: true }))))
             .filter((res) => res.status === 'fulfilled')
             .map((res) => res.value);
     }

package/dist/struct/ClanMember.d.ts

@@ -1,3 +1,4 @@
+import { OverrideOptions } from '../rest/RequestHandler';
 import { Client } from '../client/Client';
 import { APIClanMember } from '../types';
 import { League } from './League';
@@ -27,5 +28,5 @@ export declare class ClanMember {
     received: number;
     constructor(client: Client, data: APIClanMember);
     /** Fetch detailed clan info for the member's clan. */
-    fetch(): Promise<import("./Player").Player>;
+    fetch(options?: OverrideOptions): Promise<import("./Player").Player>;
 }

package/dist/struct/ClanMember.js

@@ -21,8 +21,8 @@ class ClanMember {
         this.received = data.donationsReceived;
     }
     /** Fetch detailed clan info for the member's clan. */
-    async fetch() {
-        return this.client.getPlayer(this.tag);
+    async fetch(options) {
+        return this.client.getPlayer(this.tag, options);
     }
 }
 exports.ClanMember = ClanMember;

package/dist/struct/ClanWar.d.ts

@@ -129,7 +129,9 @@ 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[];
-    /** Returns either `friendly`, `cwl` or `regular`. */
-    get type(): 'friendly' | 'cwl' | 'regular';
+    /** Returns either `friendly`, `cwl` or `normal`. */
+    get type(): "friendly" | "cwl" | "normal";
     private get _isFriendly();
+    /** Returns the war status, based off the home clan. */
+    get status(): "win" | "lose" | "tie" | "pending";
 }

package/dist/struct/ClanWar.js

@@ -168,17 +168,31 @@ class ClanWar {
         }
         return this.opponent.attacks.filter((atk) => atk.defenderTag === defenderTag);
     }
-    /** Returns either `friendly`, `cwl` or `regular`. */
+    /** Returns either `friendly`, `cwl` or `normal`. */
     get type() {
         if (this._isFriendly)
             return 'friendly';
         if (this.warTag)
             return 'cwl';
-        return 'regular';
+        return 'normal';
     }
     get _isFriendly() {
         const preparationTime = this.startTime.getTime() - this.preparationStartTime.getTime();
         return Constants_1.FRIENDLY_WAR_PREPARATION_TIMES.includes(preparationTime);
     }
+    /** Returns the war status, based off the home clan. */
+    get status() {
+        if (this.state === 'preparation')
+            return 'pending';
+        if (this.clan.stars > this.opponent.stars)
+            return 'win';
+        if (this.clan.stars === this.opponent.stars) {
+            if (this.clan.destruction > this.opponent.destruction)
+                return 'win';
+            if (this.clan.destruction === this.opponent.destruction)
+                return 'tie';
+        }
+        return 'lose';
+    }
 }
 exports.ClanWar = ClanWar;

package/dist/struct/ClanWarLeagueGroup.d.ts

@@ -1,4 +1,5 @@
 import { APIClanWarLeagueClan, APIClanWarLeagueClanMember, APIClanWarLeagueGroup, APIClanWarLeagueRound } from '../types';
+import { OverrideOptions } from '../rest/RequestHandler';
 import { Client } from '../client/Client';
 import { ClanWar } from './ClanWar';
 import { Player } from './Player';
@@ -28,7 +29,7 @@ export declare class ClanWarLeagueClan {
     members: ClanWarLeagueClanMember[];
     constructor(client: Client, data: APIClanWarLeagueClan);
     /** Get {@link Player} information for every members that are in the CWL group. */
-    fetchMembers(): Promise<Player[]>;
+    fetchMembers(options?: OverrideOptions): Promise<Player[]>;
 }
 /** Represents a Round of CWL Group. */
 export declare class ClanWarLeagueRound {
@@ -53,9 +54,10 @@ export declare class ClanWarLeagueGroup {
     /**
      * 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.
+     * @param options Override options for the request.
      */
-    getWars(clanTag?: string): Promise<ClanWar[]>;
+    getWars(clanTag?: string, options?: OverrideOptions): Promise<ClanWar[]>;
     private _getCurrentWars;
-    /** Returns # (1-7) of the round for the specified warTag. */
+    /** Returns the index of the round for this specified warTag. */
     getRoundIndex(warTag: string): number | null;
 }