clashofclans.js 2.3.0 → 2.4.0-dev.e127930

package/CHANGELOG.md

@@ -2,6 +2,19 @@
 
 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.4.0 (2021-12-28)
+
+### Features
+
+-   `ClanWar#getClanWarLeagueGroup`, `ClanWar#isCWL` and `ClanWar#isFriendly` are now available. ([#87](https://github.com/clashperk/clashofclans.js/pull/87))
+-   `RESTOptions#rejectIfNotValid` added to perform `res.ok` operations over `RESTManager` methods. [Know more?](https://clashofclans.js.org/guide/access-raw-data#easy-access) ([#87](https://github.com/clashperk/clashofclans.js/pull/87))
+-   `Icon#fileName` and `Icon#sizes` are now available in `Icon` class. ([#87](https://github.com/clashperk/clashofclans.js/pull/87))
+-   `Badge#fileName` and `Badge#sizes` are now available in `Badge` class. ([#87](https://github.com/clashperk/clashofclans.js/pull/87))
+
+### Deprecations
+
+-   `ClanWarMember#previousBestOpponentAttack` has been deprecated. Use `ClanWarAttack#previousBestAttack` instead. ([#87](https://github.com/clashperk/clashofclans.js/pull/87))
+
 ## 2.3.0 (2021-12-17)
 
 ### Features

package/LICENSE

@@ -1,7 +1,6 @@
 MIT License
 
-Copyright (c) 2020 - 2021 csuvajit
-Copyright (c) 2020 - 2021 TheLearneer
+Copyright (c) 2020 - 2021 ClashPerk
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/dist/client/Client.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { ClanSearchOptions, SearchOptions, ClientOptions, InitOptions, OverrideOptions } from '../rest/RequestHandler';
+import { ClanSearchOptions, SearchOptions, ClientOptions, LoginOptions, OverrideOptions } from '../types';
 import { EVENTS, CWL_ROUNDS } from '../util/Constants';
 import { RESTManager } from '../rest/RESTManager';
 import { EventManager } from './EventManager';
@@ -31,7 +31,7 @@ export declare class Client extends EventEmitter {
      * client.login({ email: 'developer@email.com', password: '***' });
      * ```
      */
-    login(options: InitOptions): Promise<string[]>;
+    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. */

package/dist/rest/HTTPError.d.ts

@@ -8,7 +8,7 @@ export declare class HTTPError extends Error {
      * The reason of this errored request.
      *
      * Expected values are `notFound`, `notInWar`, `accessDenied`, `accessDenied.invalidIp`, `privateWarLog`,
-     * `badRequest`, `requestThrottled`, `serviceUnavailable`, `requestAborted` and `unknownException`.
+     * `badRequest`, `requestThrottled`, `inMaintenance`, `requestAborted` and `unknownException`.
      */
     reason: string;
     /** The HTTP status code of this request. */

package/dist/rest/RESTManager.d.ts

@@ -1,56 +1,70 @@
-import { RequestHandler, SearchOptions, ClanSearchOptions, ClientOptions, OverrideOptions } from './RequestHandler';
-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';
+import { RequestHandler } from './RequestHandler';
+import { Util } from '../util/Util';
+import { APIClan, APIClanList, APIClanMemberList, APIClanRankingList, APIClanVersusRankingList, APIClanWar, APIClanWarLeagueGroup, APIClanWarLog, APIGoldPassSeason, APILabelList, APILeague, APILeagueList, APILeagueSeasonList, APILocation, APILocationList, APIPlayer, APIPlayerRankingList, APIPlayerSeasonRankingList, APIPlayerVersusRankingList, APIVerifyToken, APIWarLeague, APIWarLeagueList, SearchOptions, ClanSearchOptions, RESTOptions, OverrideOptions, LoginOptions } from '../types';
 /** Represents a REST Manager of the client. */
 export declare class RESTManager {
     /** Request Handler for the RESTManager. */
     readonly handler: RequestHandler;
-    constructor(options?: ClientOptions);
+    constructor(options?: RESTOptions);
+    /** Contains various general-purpose utility methods. */
+    get util(): typeof Util;
+    /**
+     * Initialize the client to create keys.
+     * @example
+     * ```
+     * const rest = new RESTManager();
+     * rest.login({ email: 'developer@email.com', password: '***' });
+     * ```
+     */
+    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<import("./RequestHandler").Response<APIClanList>>;
+    getClans(query: ClanSearchOptions, options?: OverrideOptions): Promise<import("../types").Response<APIClanList>>;
     /** Get info about a clan. */
-    getClan(clanTag: string, options?: OverrideOptions): Promise<import("./RequestHandler").Response<APIClan>>;
+    getClan(clanTag: string, options?: OverrideOptions): Promise<import("../types").Response<APIClan>>;
     /** Get list of clan members. */
-    getClanMembers(clanTag: string, options?: SearchOptions): Promise<import("./RequestHandler").Response<APIClanMemberList>>;
+    getClanMembers(clanTag: string, options?: SearchOptions): Promise<import("../types").Response<APIClanMemberList>>;
     /** Get clan war log. */
-    getClanWarLog(clanTag: string, options?: SearchOptions): Promise<import("./RequestHandler").Response<APIClanWarLog>>;
+    getClanWarLog(clanTag: string, options?: SearchOptions): Promise<import("../types").Response<APIClanWarLog>>;
     /** Get info about currently running war in the clan. */
-    getCurrentWar(clanTag: string, options?: OverrideOptions): Promise<import("./RequestHandler").Response<APIClanWar>>;
+    getCurrentWar(clanTag: string, options?: OverrideOptions): Promise<import("../types").Response<APIClanWar>>;
     /** Get info about clan war league. */
-    getClanWarLeagueGroup(clanTag: string, options?: OverrideOptions): Promise<import("./RequestHandler").Response<APIClanWarLeagueGroup>>;
+    getClanWarLeagueGroup(clanTag: string, options?: OverrideOptions): Promise<import("../types").Response<APIClanWarLeagueGroup>>;
     /** Get info about a CWL round by WarTag. */
-    getClanWarLeagueRound(warTag: string, options?: OverrideOptions): Promise<import("./RequestHandler").Response<APIClanWar>>;
+    getClanWarLeagueRound(warTag: string, options?: OverrideOptions): Promise<import("../types").Response<APIClanWar>>;
     /** Get info about a player by tag. */
-    getPlayer(playerTag: string, options?: OverrideOptions): Promise<import("./RequestHandler").Response<APIPlayer>>;
+    getPlayer(playerTag: string, options?: OverrideOptions): Promise<import("../types").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>>;
+    verifyPlayerToken(playerTag: string, token: string, options?: OverrideOptions): Promise<import("../types").Response<APIVerifyToken>>;
     /** Get list of Leagues. */
-    getLeagues(options?: SearchOptions): Promise<import("./RequestHandler").Response<APILeagueList>>;
+    getLeagues(options?: SearchOptions): Promise<import("../types").Response<APILeagueList>>;
     /** Get a League info. */
-    getLeague(leagueId: string | number, options?: OverrideOptions): Promise<import("./RequestHandler").Response<APILeague>>;
+    getLeague(leagueId: string | number, options?: OverrideOptions): Promise<import("../types").Response<APILeague>>;
     /** Get Legend League season Ids. */
-    getLeagueSeasons(leagueId: number, options?: SearchOptions): Promise<import("./RequestHandler").Response<APILeagueSeasonList>>;
+    getLeagueSeasons(leagueId: number, options?: SearchOptions): Promise<import("../types").Response<APILeagueSeasonList>>;
     /** Get Legend League season rankings by season Id. */
-    getSeasonRankings(leagueId: number, seasonId: string, options?: SearchOptions): Promise<import("./RequestHandler").Response<APIPlayerSeasonRankingList>>;
+    getSeasonRankings(leagueId: number, seasonId: string, options?: SearchOptions): Promise<import("../types").Response<APIPlayerSeasonRankingList>>;
     /** Get list of Clan War Leagues. */
-    getWarLeagues(options?: SearchOptions): Promise<import("./RequestHandler").Response<APIWarLeagueList>>;
+    getWarLeagues(options?: SearchOptions): Promise<import("../types").Response<APIWarLeagueList>>;
     /** Get info about a Clan War League. */
-    getWarLeague(leagueId: number, options?: OverrideOptions): Promise<import("./RequestHandler").Response<APIWarLeague>>;
+    getWarLeague(leagueId: number, options?: OverrideOptions): Promise<import("../types").Response<APIWarLeague>>;
     /** Get list of Locations. */
-    getLocations(options?: SearchOptions): Promise<import("./RequestHandler").Response<APILocationList>>;
+    getLocations(options?: SearchOptions): Promise<import("../types").Response<APILocationList>>;
     /** Get info about a Location. */
-    getLocation(locationId: number, options?: OverrideOptions): Promise<import("./RequestHandler").Response<APILocation>>;
+    getLocation(locationId: number, options?: OverrideOptions): Promise<import("../types").Response<APILocation>>;
     /** Get clan rankings for a specific location. */
-    getClanRanks(locationId: number | string, options?: SearchOptions): Promise<import("./RequestHandler").Response<APIClanRankingList>>;
+    getClanRanks(locationId: number | string, options?: SearchOptions): Promise<import("../types").Response<APIClanRankingList>>;
     /** Get player rankings for a specific location. */
-    getPlayerRanks(locationId: number | string, options?: SearchOptions): Promise<import("./RequestHandler").Response<APIPlayerRankingList>>;
+    getPlayerRanks(locationId: number | string, options?: SearchOptions): Promise<import("../types").Response<APIPlayerRankingList>>;
     /** Get clan versus rankings for a specific location. */
-    getVersusClanRanks(locationId: number | string, options?: SearchOptions): Promise<import("./RequestHandler").Response<APIClanVersusRankingList>>;
+    getVersusClanRanks(locationId: number | string, options?: SearchOptions): Promise<import("../types").Response<APIClanVersusRankingList>>;
     /** Get player versus rankings for a specific location. */
-    getVersusPlayerRanks(locationId: number | string, options?: SearchOptions): Promise<import("./RequestHandler").Response<APIPlayerVersusRankingList>>;
+    getVersusPlayerRanks(locationId: number | string, options?: SearchOptions): Promise<import("../types").Response<APIPlayerVersusRankingList>>;
     /** Get list of clan labels. */
-    getClanLabels(options?: SearchOptions): Promise<import("./RequestHandler").Response<APILabelList>>;
+    getClanLabels(options?: SearchOptions): Promise<import("../types").Response<APILabelList>>;
     /** Get list of player labels. */
-    getPlayerLabels(options?: SearchOptions): Promise<import("./RequestHandler").Response<APILabelList>>;
+    getPlayerLabels(options?: SearchOptions): Promise<import("../types").Response<APILabelList>>;
     /** Get info about gold pass season. */
-    getGoldPassSeason(options?: OverrideOptions): Promise<import("./RequestHandler").Response<APIGoldPassSeason>>;
+    getGoldPassSeason(options?: OverrideOptions): Promise<import("../types").Response<APIGoldPassSeason>>;
 }

package/dist/rest/RESTManager.js

@@ -8,9 +8,29 @@ class RESTManager {
     constructor(options) {
         this.handler = new RequestHandler_1.RequestHandler(options);
     }
+    /** Contains various general-purpose utility methods. */
+    get util() {
+        return Util_1.Util;
+    }
+    /**
+     * Initialize the client to create keys.
+     * @example
+     * ```
+     * const rest = new RESTManager();
+     * rest.login({ email: 'developer@email.com', password: '***' });
+     * ```
+     */
+    login(options) {
+        return this.handler.init(options);
+    }
+    /** Set Clash of Clans API keys. */
+    setKeys(keys) {
+        this.handler.setKeys(keys);
+        return this;
+    }
     /** Search all clans by name and/or filtering the results using various criteria. */
     getClans(query, options) {
-        return this.handler.request(`/clans?${Util_1.Util.queryString(query)}`, options);
+        return this.handler.request(`/clans${Util_1.Util.queryString(query)}`, options);
     }
     /** Get info about a clan. */
     getClan(clanTag, options) {
@@ -19,12 +39,12 @@ class RESTManager {
     /** Get list of clan members. */
     getClanMembers(clanTag, options) {
         const query = Util_1.Util.queryString(options);
-        return this.handler.request(`/clans/${Util_1.Util.encodeURI(clanTag)}/members?${query}`, options);
+        return this.handler.request(`/clans/${Util_1.Util.encodeURI(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.encodeURI(clanTag)}/warlog?${query}`, options);
+        return this.handler.request(`/clans/${Util_1.Util.encodeURI(clanTag)}/warlog${query}`, options);
     }
     /** Get info about currently running war in the clan. */
     getCurrentWar(clanTag, options) {
@@ -50,7 +70,7 @@ class RESTManager {
     /** Get list of Leagues. */
     getLeagues(options) {
         const query = Util_1.Util.queryString(options);
-        return this.handler.request(`/leagues?${query}`, options);
+        return this.handler.request(`/leagues${query}`, options);
     }
     /** Get a League info. */
     getLeague(leagueId, options) {
@@ -59,17 +79,17 @@ class RESTManager {
     /** Get Legend League season Ids. */
     getLeagueSeasons(leagueId, options) {
         const query = Util_1.Util.queryString(options);
-        return this.handler.request(`/leagues/${leagueId}/seasons?${query}`, 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);
+        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);
+        return this.handler.request(`/warleagues${query}`, options);
     }
     /** Get info about a Clan War League. */
     getWarLeague(leagueId, options) {
@@ -78,7 +98,7 @@ class RESTManager {
     /** Get list of Locations. */
     getLocations(options) {
         const query = Util_1.Util.queryString(options);
-        return this.handler.request(`/locations?${query}`, options);
+        return this.handler.request(`/locations${query}`, options);
     }
     /** Get info about a Location. */
     getLocation(locationId, options) {
@@ -87,32 +107,32 @@ class RESTManager {
     /** 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);
+        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);
+        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);
+        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);
+        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);
+        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);
+        return this.handler.request(`/labels/players${query}`, options);
     }
     /** Get info about gold pass season. */
     getGoldPassSeason(options) {

package/dist/rest/RequestHandler.d.ts

@@ -1,5 +1,4 @@
-import { QueueThrottler, BatchThrottler } from './Throttler';
-import Keyv from 'keyv';
+import { RESTOptions, Response, RequestOptions, LoginOptions } from '../types';
 /** Represents a Request Handler. */
 export declare class RequestHandler {
     #private;
@@ -10,17 +9,18 @@ export declare class RequestHandler {
     private keyDescription?;
     private keys;
     private readonly baseURL;
+    private readonly rejectIfNotValid;
     private readonly retryLimit;
     private readonly restRequestTimeout;
     private readonly throttler?;
     private readonly cached;
-    constructor(options?: ClientOptions);
+    constructor(options?: RESTOptions);
     private get _keys();
     private get _key();
     setKeys(keys: string[]): this;
     request<T>(path: string, options?: RequestOptions): Promise<Response<T>>;
     private exec;
-    init(options: InitOptions): Promise<string[]>;
+    init(options: LoginOptions): Promise<string[]>;
     private reValidateKeys;
     private login;
     private getKeys;
@@ -28,135 +28,3 @@ export declare class RequestHandler {
     private createKey;
     private getIp;
 }
-/** Options for a client. */
-export interface ClientOptions {
-    /** Keys from Clash of Clans API developer site. */
-    keys?: string[];
-    /** Base URL of the Clash of Clans API. */
-    baseURL?: string;
-    /**
-     * How many times to retry on 5XX errors.
-     */
-    retryLimit?: number;
-    /**
-     * Whether enable or disable internal caching.
-     * @example
-     * ```ts
-     * const client = new Client({ cache: true });
-     * ```
-     */
-    cache?: boolean | Keyv;
-    /** Time to wait before cancelling a REST request, in milliseconds. */
-    restRequestTimeout?: number;
-    /**
-     * Throttler class which handles rate-limit
-     * @example
-     * ```ts
-     * const client = new Client({ throttler: new QueueThrottler(1000 / 10) });
-     * ```
-     * @example
-     * ```ts
-     * const client = new Client({ throttler: new BatchThrottler(30) });
-     * ```
-     */
-    throttler?: QueueThrottler | BatchThrottler;
-}
-/** Search options for request. */
-export interface SearchOptions extends OverrideOptions {
-    /** Limit the number of items returned in the response. */
-    limit?: number;
-    /**
-     * Return only items that occur after this marker.
-     * Before marker can be found from the response, inside the 'paging' property.
-     * Note that only after or before can be specified for a request, not both.
-     */
-    after?: string;
-    /**
-     * Return only items that occur before this marker.
-     * Before marker can be found from the response, inside the 'paging' property.
-     * Note that only after or before can be specified for a request, not both.
-     */
-    before?: string;
-}
-/** Override options for a request. */
-export interface OverrideOptions {
-    /** Whether to cache this response. */
-    cache?: boolean;
-    /** Whether to skip the cache check and request the API. */
-    force?: boolean;
-    /** How many times to retry on 5XX errors. */
-    retryLimit?: string;
-    /** Whether to ignore throttlers. */
-    ignoreRateLimit?: boolean;
-    /** Time to wait before cancelling a REST request, in milliseconds. */
-    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.
- *
- * ::info
- * If name is used as part of search query, it needs to be at least three characters long.
- * Name search parameter is interpreted as wild card search, so it may appear anywhere in the clan name.
- * :::
- */
-export interface ClanSearchOptions {
-    /** Search clans by name. */
-    name?: string;
-    /** Filter by minimum number of clan members. */
-    minMembers?: number;
-    /** Filter by maximum number of clan members. */
-    maxMembers?: number;
-    /** Filter by minimum amount of clan points. */
-    minClanPoints?: number;
-    /** Filter by minimum clan level. */
-    minClanLevel?: number;
-    /** Filter by clan war frequency. */
-    warFrequency?: string;
-    /** Filter by clan location identifier. For list of available locations, refer to getLocations operation. */
-    locationId?: string;
-    /** Comma separated list of label IDs to use for filtering results. */
-    labelIds?: string;
-    /** Limit the number of items returned in the response. */
-    limit?: number;
-    /**
-     * Return only items that occur after this marker.
-     * Before marker can be found from the response, inside the 'paging' property.
-     * Note that only after or before can be specified for a request, not both.
-     */
-    after?: string;
-    /**
-     * Return only items that occur before this marker.
-     * Before marker can be found from the response, inside the 'paging' property.
-     * Note that only after or before can be specified for a request, not both.
-     */
-    before?: string;
-}
-/** Login options for a client. */
-export interface InitOptions {
-    /** Developer site email address. */
-    email: string;
-    /** Developer site password. */
-    password: string;
-    /** Name of API key(s). */
-    keyName?: string;
-    /** Number of allowed API keys. */
-    keyCount?: number;
-    /** Description of API key(s). */
-    keyDescription?: string;
-}

package/dist/rest/RequestHandler.js

@@ -32,6 +32,7 @@ class RequestHandler {
         this.throttler = options?.throttler ?? null;
         this.baseURL = options?.baseURL ?? Constants_1.API_BASE_URL;
         this.restRequestTimeout = options?.restRequestTimeout ?? 0;
+        this.rejectIfNotValid = options?.rejectIfNotValid ?? true;
         if (options?.cache instanceof keyv_1.default)
             this.cached = options.cache;
         else
@@ -52,7 +53,7 @@ class RequestHandler {
     async request(path, options = {}) {
         const cached = (await this.cached?.get(path)) ?? null;
         if (cached && options.force !== true) {
-            return { data: cached.data, maxAge: cached.ttl - Date.now(), status: 200, path };
+            return { data: cached.data, maxAge: cached.ttl - Date.now(), status: cached.status, path, ok: cached.status === 200 };
         }
         if (!this.throttler || options.ignoreRateLimit)
             return this.exec(path, options);
@@ -81,14 +82,16 @@ class RequestHandler {
                 return this.exec(path, options, ++retries);
         }
         const maxAge = Number(res?.headers.get('cache-control')?.split('=')?.[1] ?? 0) * 1000;
-        if (res?.status === 403 && !data?.message)
+        if (res?.status === 403 && !data?.message && this.rejectIfNotValid) {
             throw new HTTPError_1.HTTPError(HTTPError_1.PrivateWarLogError, res.status, path, maxAge);
-        if (!res?.ok)
+        }
+        if (!res?.ok && this.rejectIfNotValid) {
             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, ttl: Date.now() + maxAge }, maxAge);
+            await this.cached.set(path, { data, ttl: Date.now() + maxAge, status: res?.status ?? 504 }, maxAge);
         }
-        return { data, maxAge, status: res.status, path };
+        return { data, maxAge, status: res?.status ?? 504, path, ok: res?.status === 200 };
     }
     async init(options) {
         if (!(options.email && options.password))

package/dist/struct/Badge.d.ts

@@ -1,16 +1,17 @@
 import { APIBadge } from '../types';
 /** Represents a Clash of Clans Badge. */
 export declare class Badge {
-    private readonly _data;
     /** The default badge URL. */
     url: string;
-    constructor(data: APIBadge);
     /** The large badge URL. */
-    get large(): string;
+    large: string;
     /** The medium badge URL. */
-    get medium(): string;
+    medium: string;
     /** The small badge URL. */
-    get small(): string;
-    /** Get unique hash of this Badge. */
-    get hash(): string;
+    small: string;
+    constructor(data: APIBadge);
+    /** Get unique file name of this Badge. */
+    get fileName(): string;
+    /** Sizes of this Badge. */
+    get sizes(): string[];
 }

package/dist/struct/Badge.js

@@ -4,24 +4,18 @@ exports.Badge = void 0;
 /** Represents a Clash of Clans Badge. */
 class Badge {
     constructor(data) {
-        Object.defineProperty(this, '_data', { value: data });
         this.url = data.large;
+        Object.defineProperty(this, 'large', { value: data.large });
+        Object.defineProperty(this, 'medium', { value: data.medium });
+        Object.defineProperty(this, 'small', { value: data.small });
     }
-    /** The large badge URL. */
-    get large() {
-        return this._data.large;
-    }
-    /** The medium badge URL. */
-    get medium() {
-        return this._data.medium;
-    }
-    /** The small badge URL. */
-    get small() {
-        return this._data.small;
-    }
-    /** Get unique hash of this Badge. */
-    get hash() {
+    /** Get unique file name of this Badge. */
+    get fileName() {
         return this.url.split('/').pop();
     }
+    /** Sizes of this Badge. */
+    get sizes() {
+        return [this.large, this.medium, this.small].map((url) => /\/(\d+)\//g.exec(url)[1]);
+    }
 }
 exports.Badge = Badge;

package/dist/struct/Clan.d.ts

@@ -1,11 +1,10 @@
-import { OverrideOptions } from '../rest/RequestHandler';
+import { APIClan, OverrideOptions } from '../types';
 import { ChatLanguage } from './ChatLanguage';
 import { ClanMember } from './ClanMember';
 import { Client } from '../client/Client';
 import { WarLeague } from './WarLeague';
 import type { Player } from './Player';
 import { Location } from './Location';
-import { APIClan } from '../types';
 import { Label } from './Label';
 import { Badge } from './Badge';
 /** Represents a Clan. */

package/dist/struct/ClanMember.d.ts

@@ -1,6 +1,5 @@
-import { OverrideOptions } from '../rest/RequestHandler';
+import { APIClanMember, OverrideOptions } from '../types';
 import { Client } from '../client/Client';
-import { APIClanMember } from '../types';
 import { League } from './League';
 export declare class ClanMember {
     client: Client;

package/dist/struct/ClanWar.d.ts

@@ -61,6 +61,8 @@ export declare class ClanWarMember {
     /**
      * Returns the previous best opponent attack on this village.
      * This is useful for calculating the new stars or destruction for new attacks.
+     *
+     * @deprecated `order` is affecting this method. Use {@link ClanWarAttack#previousBestAttack} instead.
      */
     previousBestOpponentAttack(): ClanWarAttack | null;
 }
@@ -131,7 +133,12 @@ export declare class ClanWar {
     getDefenses(defenderTag: string): ClanWarAttack[];
     /** Returns either `friendly`, `cwl` or `normal`. */
     get type(): "friendly" | "cwl" | "normal";
-    private get _isFriendly();
+    /** Whether this is a friendly war. */
+    get isFriendly(): boolean;
+    /** Whether this is a CWL. */
+    get isCWL(): boolean;
     /** Returns the war status, based off the home clan. */
     get status(): "win" | "lose" | "tie" | "pending";
+    /** Returns the Clan War League Group. */
+    getClanWarLeagueGroup(): Promise<import("./ClanWarLeagueGroup").ClanWarLeagueGroup> | null;
 }

package/dist/struct/ClanWar.js

@@ -75,6 +75,8 @@ class ClanWarMember {
     /**
      * Returns the previous best opponent attack on this village.
      * This is useful for calculating the new stars or destruction for new attacks.
+     *
+     * @deprecated `order` is affecting this method. Use {@link ClanWarAttack#previousBestAttack} instead.
      */
     previousBestOpponentAttack() {
         return (
@@ -170,16 +172,21 @@ class ClanWar {
     }
     /** Returns either `friendly`, `cwl` or `normal`. */
     get type() {
-        if (this._isFriendly)
+        if (this.isFriendly)
             return 'friendly';
         if (this.warTag)
             return 'cwl';
         return 'normal';
     }
-    get _isFriendly() {
+    /** Whether this is a friendly war. */
+    get isFriendly() {
         const preparationTime = this.startTime.getTime() - this.preparationStartTime.getTime();
         return Constants_1.FRIENDLY_WAR_PREPARATION_TIMES.includes(preparationTime);
     }
+    /** Whether this is a CWL. */
+    get isCWL() {
+        return typeof this.warTag === 'string';
+    }
     /** Returns the war status, based off the home clan. */
     get status() {
         if (this.state === 'preparation')
@@ -194,5 +201,11 @@ class ClanWar {
         }
         return 'lose';
     }
+    /** Returns the Clan War League Group. */
+    getClanWarLeagueGroup() {
+        if (!this.isCWL)
+            return null;
+        return this.client.getClanWarLeagueGroup(this.clan.tag);
+    }
 }
 exports.ClanWar = ClanWar;

package/dist/struct/ClanWarLeagueGroup.d.ts

@@ -1,5 +1,4 @@
-import { APIClanWarLeagueClan, APIClanWarLeagueClanMember, APIClanWarLeagueGroup, APIClanWarLeagueRound } from '../types';
-import { OverrideOptions } from '../rest/RequestHandler';
+import { APIClanWarLeagueClan, APIClanWarLeagueClanMember, APIClanWarLeagueGroup, APIClanWarLeagueRound, OverrideOptions } from '../types';
 import { Client } from '../client/Client';
 import { ClanWar } from './ClanWar';
 import { Player } from './Player';