clashofclans.js 2.0.0-dev.dc4d83a → 2.0.0-dev.dedb83d

package/dist/client/Client.d.ts

@@ -40,12 +40,38 @@ export declare class Client extends EventEmitter {
     getClanMembers(clanTag: string, options?: SearchOptions): Promise<ClanMember[]>;
     /** Get clan war log. */
     getClanWarLog(clanTag: string, options?: SearchOptions): Promise<ClanWarLog[]>;
-    /** Get info about currently running war (regular or friendly) in the clan. */
-    getClanWar(clanTag: string, options?: OverrideOptions): Promise<ClanWar | null>;
-    /** Get info about currently running war in the clan. */
-    getCurrentWar(clanTag: string, options?: OverrideOptions): Promise<ClanWar | null>;
-    /** Get info about currently running CWL round. */
-    getLeagueWar(clanTag: string, round?: keyof typeof CWL_ROUNDS): Promise<ClanWar | null>;
+    /** Get info about currently running war (normal or friendly) in the clan. */
+    getClanWar(clanTag: string, options?: OverrideOptions): Promise<ClanWar>;
+    /**
+     * Get info about currently running war in the clan.
+     * @example
+     * ```ts
+     * await client.getCurrentWar('#8QU8J9LP');
+     * ```
+     * @example
+     * ```ts
+     * await client.getCurrentWar({ clanTag: '#8QU8J9LP', round: 'PREVIOUS_ROUND' });
+     * ```
+     */
+    getCurrentWar(clanTag: string | {
+        clanTag: string;
+        round?: keyof typeof CWL_ROUNDS;
+    }, options?: OverrideOptions): Promise<ClanWar | null>;
+    /**
+     * Get info about currently running CWL round.
+     * @example
+     * ```ts
+     * await client.getLeagueWar('#8QU8J9LP');
+     * ```
+     * @example
+     * ```ts
+     * await client.getLeagueWar({ clanTag: '#8QU8J9LP', round: 'PREVIOUS_ROUND' });
+     * ```
+     */
+    getLeagueWar(clanTag: string | {
+        clanTag: string;
+        round?: keyof typeof CWL_ROUNDS;
+    }, options?: OverrideOptions): Promise<ClanWar | null>;
     private _getCurrentLeagueWars;
     private _getClanWars;
     /** Get information about clan war league. */
@@ -54,7 +80,7 @@ export declare class Client extends EventEmitter {
     getClanWarLeagueRound(warTag: string | {
         warTag: string;
         clanTag?: string;
-    }, options?: OverrideOptions): Promise<ClanWar | null>;
+    }, options?: OverrideOptions): Promise<ClanWar>;
     /** Get information about a player by tag. */
     getPlayer(playerTag: string, options?: OverrideOptions): Promise<Player>;
     /** Verify Player API token that can be found from the Game settings. */
@@ -88,8 +114,8 @@ export declare class Client extends EventEmitter {
      *
      * **Parameters**
      *
-     * | Name | Type | Description |
-     * | :--: | :--: | :---------: |
+     * | Name |   Type   | Description           |
+     * | :--: | :------: | :-------------------: |
      * | `id` | `string` | Id of the new season. |
      * @public
      * @event
@@ -106,8 +132,8 @@ export declare class Client extends EventEmitter {
      *
      * **Parameters**
      *
-     * | Name | Type | Description |
-     * | :--: | :--: | :---------: |
+     * |    Name    |   Type   |                    Description                     |
+     * | :--------: | :------: | :------------------------------------------------: |
      * | `duration` | `number` | Duration of the maintenance break in milliseconds. |
      * @public
      * @event
@@ -115,15 +141,21 @@ export declare class Client extends EventEmitter {
     private static maintenanceEnd;
     /** @internal */
     on<K extends keyof ClientEvents>(event: K, listeners: (...args: ClientEvents[K]) => void): this;
+    /** @internal */
+    on<S extends keyof CustomEvents>(event: Exclude<S, keyof ClientEvents>, listeners: (...args: CustomEvents[S]) => void): this;
     /** @internal */ on<S extends string | symbol>(event: Exclude<S, keyof ClientEvents>, listeners: (...args: any[]) => void): this;
     /** @internal */
     once<K extends keyof ClientEvents>(event: K, listeners: (...args: ClientEvents[K]) => void): this;
+    /** @internal */
+    once<S extends keyof CustomEvents>(event: Exclude<S, keyof ClientEvents>, listeners: (...args: CustomEvents[S]) => void): this;
     /** @internal */ once<S extends string | symbol>(event: Exclude<S, keyof ClientEvents>, listeners: (...args: any[]) => void): this;
     /** @internal */
     emit<K extends keyof ClientEvents>(event: K, ...args: ClientEvents[K]): boolean;
+    /** @internal */
+    emit<S extends keyof CustomEvents>(event: Exclude<S, keyof ClientEvents>, ...args: CustomEvents[S]): this;
     /** @internal */ emit<S extends string | symbol>(event: Exclude<S, keyof ClientEvents>, ...args: any[]): boolean;
 }
-export interface ClientEvents {
+interface ClientEvents {
     [EVENTS.NEW_SEASON_START]: [id: string];
     [EVENTS.MAINTENANCE_START]: [];
     [EVENTS.MAINTENANCE_END]: [duration: number];
@@ -135,3 +167,9 @@ export interface ClientEvents {
     [EVENTS.WAR_LOOP_END]: [];
     [EVENTS.ERROR]: [error: unknown];
 }
+interface CustomEvents {
+    [key: `clan${string}`]: [oldClan: Clan, newClan: Clan];
+    [key: `war${string}`]: [oldWar: ClanWar, newWar: ClanWar];
+    [key: `player${string}`]: [oldPlayer: Player, newPlayer: Player];
+}
+export {};

package/dist/client/Client.js

@@ -2,9 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Client = void 0;
 const Constants_1 = require("../util/Constants");
+const HTTPError_1 = require("../rest/HTTPError");
 const RESTManager_1 = require("../rest/RESTManager");
 const EventManager_1 = require("./EventManager");
-const HTTPError_1 = require("../rest/HTTPError");
 const events_1 = require("events");
 const Util_1 = require("../util/Util");
 const struct_1 = require("../struct");
@@ -62,30 +62,52 @@ class Client extends events_1.EventEmitter {
         const { data } = await this.rest.getClanWarLog(clanTag, options);
         return data.items.map((entry) => new struct_1.ClanWarLog(this, entry));
     }
-    /** Get info about currently running war (regular or friendly) in the clan. */
+    /** Get info about currently running war (normal or friendly) in the clan. */
     async getClanWar(clanTag, options) {
-        const { data, maxAge } = await this.rest.getCurrentWar(clanTag, options);
-        if (data.state === 'notInWar')
-            return null;
+        const { data, maxAge, path, status } = await this.rest.getCurrentWar(clanTag, options);
+        if (data.state === 'notInWar') {
+            throw new HTTPError_1.HTTPError(HTTPError_1.NotInWarError, status, path, maxAge);
+        }
         return new struct_1.ClanWar(this, data, { clanTag, maxAge });
     }
-    /** Get info about currently running war in the clan. */
+    /**
+     * Get info about currently running war in the clan.
+     * @example
+     * ```ts
+     * await client.getCurrentWar('#8QU8J9LP');
+     * ```
+     * @example
+     * ```ts
+     * await client.getCurrentWar({ clanTag: '#8QU8J9LP', round: 'PREVIOUS_ROUND' });
+     * ```
+     */
     async getCurrentWar(clanTag, options) {
+        const args = typeof clanTag === 'string' ? { clanTag } : { clanTag: clanTag.clanTag, round: clanTag.round };
         try {
-            const data = await this.getClanWar(clanTag, options);
-            return data ?? (await this.getLeagueWar(clanTag));
+            return await this.getClanWar(args.clanTag, options);
         }
         catch (e) {
-            if (e instanceof HTTPError_1.HTTPError && e.status === 403) {
-                return this.getLeagueWar(clanTag);
+            if (e instanceof HTTPError_1.HTTPError && [200, 403].includes(e.status)) {
+                return this.getLeagueWar({ clanTag: args.clanTag, round: args.round });
             }
+            throw e;
         }
-        return null;
     }
-    /** Get info about currently running CWL round. */
-    async getLeagueWar(clanTag, round) {
-        const state = (round && Constants_1.CWL_ROUNDS[round]) ?? 'inWar'; // eslint-disable-line
-        const data = await this.getClanWarLeagueGroup(clanTag);
+    /**
+     * Get info about currently running CWL round.
+     * @example
+     * ```ts
+     * await client.getLeagueWar('#8QU8J9LP');
+     * ```
+     * @example
+     * ```ts
+     * await client.getLeagueWar({ clanTag: '#8QU8J9LP', round: 'PREVIOUS_ROUND' });
+     * ```
+     */
+    async getLeagueWar(clanTag, options) {
+        const args = typeof clanTag === 'string' ? { clanTag } : { clanTag: clanTag.clanTag, round: clanTag.round };
+        const state = (args.round && Constants_1.CWL_ROUNDS[args.round]) ?? 'inWar'; // eslint-disable-line
+        const data = await this.getClanWarLeagueGroup(args.clanTag, options);
         const rounds = data.rounds.filter((round) => !round.warTags.includes('#0'));
         if (!rounds.length)
             return null;
@@ -95,8 +117,11 @@ class Client extends events_1.EventEmitter {
             .map((round) => round.warTags)
             .flat()
             .reverse();
-        const wars = await this.util.allSettled(warTags.map((warTag) => this.getClanWarLeagueRound({ warTag, clanTag }, { ignoreRateLimit: true })));
-        return wars.find((war) => war?.state === state) ?? wars.at(0) ?? null;
+        const wars = await this.util.allSettled(warTags.map((warTag) => this.getClanWarLeagueRound({ warTag, clanTag: args.clanTag }, { ignoreRateLimit: true })));
+        if (args.round && args.round in Constants_1.CWL_ROUNDS) {
+            return wars.find((war) => war.state === state) ?? null;
+        }
+        return wars.find((war) => war.state === state) ?? wars.at(0) ?? null;
     }
     async _getCurrentLeagueWars(clanTag, options) {
         const data = await this.getClanWarLeagueGroup(clanTag, options);
@@ -104,20 +129,18 @@ class Client extends events_1.EventEmitter {
         return data._getCurrentWars(clanTag);
     }
     async _getClanWars(clanTag, options) {
-        const date = new Date().getDate();
+        const date = new Date().getUTCDate();
+        if (!(date >= 1 && date <= 10)) {
+            return [await this.getClanWar(clanTag, options)];
+        }
         try {
-            const data = await this.getClanWar(clanTag, options);
-            if (!(date >= 1 && date <= 10))
-                return data ? [data] : [];
-            return data ? [data] : await this._getCurrentLeagueWars(clanTag);
+            return this._getCurrentLeagueWars(clanTag);
         }
         catch (e) {
-            if (!(date >= 1 && date <= 10))
-                return [];
-            if (e instanceof HTTPError_1.HTTPError && e.status === 403) {
-                return this._getCurrentLeagueWars(clanTag);
+            if (e instanceof HTTPError_1.HTTPError && [404].includes(e.status)) {
+                return [await this.getClanWar(clanTag)];
             }
-            return [];
+            throw e;
         }
     }
     /** Get information about clan war league. */
@@ -128,9 +151,10 @@ class Client extends events_1.EventEmitter {
     /** Get information about CWL round by WarTag. */
     async getClanWarLeagueRound(warTag, options) {
         const args = typeof warTag === 'string' ? { warTag } : { warTag: warTag.warTag, clanTag: warTag.clanTag };
-        const { data, maxAge } = await this.rest.getClanWarLeagueRound(args.warTag, options);
-        if (data.state === 'notInWar')
-            return null;
+        const { data, maxAge, status, path } = await this.rest.getClanWarLeagueRound(args.warTag, options);
+        if (data.state === 'notInWar') {
+            throw new HTTPError_1.HTTPError(HTTPError_1.NotInWarError, status, path, maxAge);
+        }
         return new struct_1.ClanWar(this, data, { warTag: args.warTag, clanTag: args.clanTag, maxAge });
     }
     /** Get information about a player by tag. */

package/dist/client/EventManager.d.ts

@@ -1,6 +1,6 @@
 import { Clan, ClanWar, Player } from '../struct';
 import { Client } from './Client';
-/** Represents Event Manager of the {@link Client} class. */
+/** Represents Event Manager of the {@link Client}. */
 export declare class EventManager {
     private readonly client;
     private readonly _clanTags;
@@ -14,7 +14,7 @@ export declare class EventManager {
     private _maintenanceStartTime;
     constructor(client: Client);
     /** Initialize the Event Manager to start pulling. */
-    init(): Promise<(string | symbol)[]>;
+    init(): Promise<string[]>;
     /** Add a clan tag to clan events. */
     addClans(...tags: string[]): this;
     /** Delete a clan tag from clan events. */
@@ -30,6 +30,8 @@ export declare class EventManager {
     /**
      * Set your own custom clan event.
      *
+     * In order to emit the custom event, you must have this filter function that returns a boolean.
+     *
      * @example
      * ```js
      * client.events.addClans(['#2PP', '#8QU8J9LP']);
@@ -57,6 +59,8 @@ export declare class EventManager {
     }): this;
     /**
      * Set your own custom war event.
+     *
+     * In order to emit the custom event, you must have this filter function that returns a boolean.
      */
     setWarEvent(event: {
         name: string;
@@ -64,6 +68,8 @@ export declare class EventManager {
     }): this;
     /**
      * Set your own custom player event.
+     *
+     * In order to emit the custom event, you must have this filter function that returns a boolean.
      */
     setPlayerEvent(event: {
         name: string;
@@ -78,8 +84,3 @@ export declare class EventManager {
     private runPlayerUpdate;
     private runWarUpdate;
 }
-export interface EventTypes {
-    CLAN: [oldClan: Clan, newClan: Clan];
-    PLAYER: [oldPlayer: Player, newPlayer: Player];
-    CLAN_WAR: [oldWar: ClanWar, newWar: ClanWar];
-}

package/dist/client/EventManager.js

@@ -4,7 +4,7 @@ exports.EventManager = void 0;
 const HTTPError_1 = require("../rest/HTTPError");
 const Constants_1 = require("../util/Constants");
 const Util_1 = require("../util/Util");
-/** Represents Event Manager of the {@link Client} class. */
+/** Represents Event Manager of the {@link Client}. */
 class EventManager {
     constructor(client) {
         this.client = client;
@@ -76,6 +76,8 @@ class EventManager {
     /**
      * Set your own custom clan event.
      *
+     * In order to emit the custom event, you must have this filter function that returns a boolean.
+     *
      * @example
      * ```js
      * client.events.addClans(['#2PP', '#8QU8J9LP']);
@@ -98,21 +100,25 @@ class EventManager {
      * @returns
      */
     setClanEvent(event) {
-        this._events.clans.push({ name: event.name, fn: event.filter });
+        this._events.clans.push(event);
         return this;
     }
     /**
      * Set your own custom war event.
+     *
+     * In order to emit the custom event, you must have this filter function that returns a boolean.
      */
     setWarEvent(event) {
-        this._events.wars.push({ name: event.name, fn: event.filter });
+        this._events.wars.push(event);
         return this;
     }
     /**
      * Set your own custom player event.
+     *
+     * In order to emit the custom event, you must have this filter function that returns a boolean.
      */
     setPlayerEvent(event) {
-        this._events.players.push({ name: event.name, fn: event.filter });
+        this._events.players.push(event);
         return this;
     }
     async maintenanceHandler() {
@@ -158,7 +164,7 @@ class EventManager {
         for (const tag of this._playerTags)
             await this.runPlayerUpdate(tag);
         this.client.emit(Constants_1.EVENTS.PLAYER_LOOP_END);
-        setTimeout(this.playerUpdateHandler.bind(this), 100000);
+        setTimeout(this.playerUpdateHandler.bind(this), 10000);
     }
     async warUpdateHandler() {
         this.client.emit(Constants_1.EVENTS.WAR_LOOP_START);
@@ -176,9 +182,9 @@ class EventManager {
         const cached = this._clans.get(clan.tag);
         if (!cached)
             return this._clans.set(clan.tag, clan);
-        for (const { name, fn } of this._events.clans) {
+        for (const { name, filter } of this._events.clans) {
             try {
-                if (!fn(cached, clan))
+                if (!filter(cached, clan))
                     continue;
                 this.client.emit(name, cached, clan);
             }
@@ -197,9 +203,9 @@ class EventManager {
         const cached = this._players.get(player.tag);
         if (!cached)
             return this._players.set(player.tag, player);
-        for (const { name, fn } of this._events.players) {
+        for (const { name, filter } of this._events.players) {
             try {
-                if (!fn(cached, player))
+                if (!filter(cached, player))
                     continue;
                 this.client.emit(name, cached, player);
             }
@@ -216,14 +222,14 @@ class EventManager {
         const clanWars = await this.client._getClanWars(tag).catch(() => null);
         if (!clanWars?.length)
             return null;
-        clanWars.forEach((war, i) => {
-            const key = `WAR:${i}:${tag}`;
+        clanWars.forEach(async (war, state) => {
+            const key = `${tag}:${state}`;
             const cached = this._wars.get(key);
             if (!cached)
                 return this._wars.set(key, war);
-            for (const { name, fn } of this._events.wars) {
+            for (const { name, filter } of this._events.wars) {
                 try {
-                    if (!fn(cached, war))
+                    if (!filter(cached, war))
                         continue;
                     this.client.emit(name, cached, war);
                 }
@@ -231,6 +237,22 @@ class EventManager {
                     this.client.emit(Constants_1.EVENTS.ERROR, error);
                 }
             }
+            // check for war end
+            if (state === 1 && cached.warTag !== war.warTag) {
+                const data = await this.client.getLeagueWar({ clanTag: tag, round: 'PREVIOUS_ROUND' }).catch(() => null);
+                if (data && data.warTag === cached.warTag) {
+                    for (const { name, filter } of this._events.wars) {
+                        try {
+                            if (!filter(cached, data))
+                                continue;
+                            this.client.emit(name, cached, data);
+                        }
+                        catch (error) {
+                            this.client.emit(Constants_1.EVENTS.ERROR, error);
+                        }
+                    }
+                }
+            }
             return this._wars.set(key, war);
         });
     }

package/dist/rest/HTTPError.d.ts

@@ -1,8 +1,26 @@
-/** Represents an HTTP Error. */
+/**
+ * Represents an HTTP Error.
+ */
 export declare class HTTPError extends Error {
+    /** The message of this error. */
+    message: string;
+    /** The HTTP method of this request. */
     method: string;
+    /** The reason of this error. */
     reason: string;
+    /** The HTTP status code of this request. */
     status: number;
+    /** The path of this request. */
     path: string;
-    constructor(error: any, status: number, path: string, method?: string);
+    /** Maximum number of milliseconds the results can be cached. */
+    maxAge: number;
+    constructor(error: any, status: number, path: string, maxAge: number, method?: string);
 }
+export declare const NotInWarError: {
+    message: string;
+    reason: string;
+};
+export declare const PrivateWarLogError: {
+    message: string;
+    reason: string;
+};

package/dist/rest/HTTPError.js

@@ -1,10 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.HTTPError = void 0;
+exports.PrivateWarLogError = exports.NotInWarError = exports.HTTPError = void 0;
 const messages = {
     500: 'Unknown error happened when handling the request.',
-    504: 'The user aborted a request.',
-    404: 'Resource was not found.',
+    504: 'The user aborted this request.',
+    404: 'Requested resource was not found.',
     400: 'Client provided incorrect parameters for the request.',
     503: 'Service is temporarily unavailable because of maintenance.',
     429: 'Request was throttled, because amount of requests was above the threshold defined for the used API token.',
@@ -19,15 +19,26 @@ const reasons = {
     404: 'notFound',
     504: 'requestAborted'
 };
-/** Represents an HTTP Error. */
+/**
+ * Represents an HTTP Error.
+ */
 class HTTPError extends Error {
-    constructor(error, status, path, method = 'GET') {
+    constructor(error, status, path, maxAge, method) {
         super();
         this.message = error?.message ?? messages[status];
         this.reason = error?.reason ?? reasons[status];
         this.path = path;
-        this.method = method;
+        this.method = method ?? 'GET';
         this.status = status;
+        this.maxAge = maxAge;
     }
 }
 exports.HTTPError = HTTPError;
+exports.NotInWarError = {
+    message: 'Clan is not in war at this moment.',
+    reason: 'notInWar'
+};
+exports.PrivateWarLogError = {
+    message: 'Access denied, clan war log is private.',
+    reason: 'privateWarLog'
+};

package/dist/rest/RESTManager.d.ts

@@ -8,120 +8,144 @@ export declare class RESTManager {
         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;
     }>;
 }

package/dist/rest/RequestHandler.d.ts

@@ -22,6 +22,7 @@ export declare class RequestHandler {
         data: T;
         maxAge: number;
         status: number;
+        path: string;
     }>;
     private exec;
     init(options: InitOptions): Promise<string[]>;

package/dist/rest/RequestHandler.js

@@ -51,7 +51,7 @@ 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 };
+            return { data: cached, maxAge: 0, status: 200, path };
         if (!this.throttler || options.ignoreRateLimit)
             return this.exec(path, options);
         await this.throttler.wait();
@@ -77,12 +77,14 @@ class RequestHandler {
             await this.login();
             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);
         if (!res?.ok)
-            throw new HTTPError_1.HTTPError(data, res?.status ?? 504, path, options.method);
-        const maxAge = Number(res.headers.get('cache-control')?.split('=')?.[1] ?? 0) * 1000;
+            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);
-        return { data, maxAge, status: res.status };
+        return { data, maxAge, status: res.status, path };
     }
     async init(options) {
         if (!(options.email && options.password))

package/dist/struct/ClanWar.d.ts

@@ -116,12 +116,12 @@ export declare class ClanWar {
     opponent: WarClan;
     /** The war's unique tag. This is `null` unless this is a CWL.  */
     warTag: string | null;
-    /** The timestamp when a fresh version of this data will be available again. */
+    /** Maximum number of milliseconds the results can be cached. */
     maxAge: number;
     constructor(client: Client, data: APIClanWar, extra: {
         clanTag?: string;
         warTag?: string;
-        maxAge?: number;
+        maxAge: number;
     });
     /** Return a {@link ClanWarMember} with the tag provided. */
     getMember(tag: string): ClanWarMember | null;
@@ -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

@@ -147,7 +147,7 @@ class ClanWar {
         }
         this.clan = new WarClan(this, clan);
         this.opponent = new WarClan(this, opponent);
-        this.maxAge = Date.now() + (extra.maxAge ?? 0);
+        this.maxAge = extra.maxAge;
     }
     /** Return a {@link ClanWarMember} with the tag provided. */
     getMember(tag) {
@@ -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.js

@@ -57,7 +57,7 @@ class ClanWarLeagueGroup {
         const warTags = rounds.map((round) => round.warTags).flat();
         const wars = await Promise.allSettled(warTags.map((warTag) => this.client.getClanWarLeagueRound({ warTag, clanTag }, { ignoreRateLimit: true })));
         return wars
-            .filter((res) => res.status === 'fulfilled' && res.value)
+            .filter((res) => res.status === 'fulfilled')
             .map((res) => res.value)
             .filter((war) => (clanTag ? war.clan.tag === clanTag : true));
     }
@@ -68,10 +68,11 @@ class ClanWarLeagueGroup {
         const warTags = rounds
             .slice(-2)
             .map((round) => round.warTags)
-            .flat();
+            .flat()
+            .reverse();
         const wars = await Promise.allSettled(warTags.map((warTag) => this.client.getClanWarLeagueRound({ warTag, clanTag }, { ignoreRateLimit: true })));
         return wars
-            .filter((res) => res.status === 'fulfilled' && res.value)
+            .filter((res) => res.status === 'fulfilled')
             .map((res) => res.value)
             .filter((war) => war.clan.tag === clanTag);
     }

package/dist/struct/ClanWarLog.d.ts

@@ -49,6 +49,6 @@ export declare class ClanWarLog {
     /** The opposition clan. */
     opponent: WarLogClan;
     constructor(client: Client, data: APIClanWarLogEntry);
-    /** Returns either `friendly`, `cwl` or `regular`. */
-    get type(): "friendly" | "cwl" | "regular";
+    /** Returns either `friendly`, `cwl` or `normal`. */
+    get type(): "friendly" | "cwl" | "normal";
 }

package/dist/struct/ClanWarLog.js

@@ -34,13 +34,13 @@ class ClanWarLog {
         this.clan = new WarLogClan(data.clan);
         this.opponent = new WarLogClan(data.opponent);
     }
-    /** Returns either `friendly`, `cwl` or `regular`. */
+    /** Returns either `friendly`, `cwl` or `normal`. */
     get type() {
         if (!this.clan.expEarned)
             return 'friendly';
         if (!this.opponent.tag)
             return 'cwl';
-        return 'regular';
+        return 'normal';
     }
 }
 exports.ClanWarLog = ClanWarLog;

package/dist/util/Util.js

@@ -18,6 +18,8 @@ class Util extends null {
     /** Get URL search params. */
     static queryString(options = {}) {
         const query = new URLSearchParams(options);
+        for (const key of ['cache', 'force', 'retryLimit', 'ignoreRateLimit', 'restRequestTimeout'])
+            query.delete(key);
         return query.toString();
     }
     static getSeasonEnd(month, autoFix = true) {
@@ -41,7 +43,7 @@ class Util extends null {
     }
     static async allSettled(values) {
         return (await Promise.allSettled(values))
-            .filter((res) => res.status === 'fulfilled' && res.value)
+            .filter((res) => res.status === 'fulfilled')
             .map((res) => res.value);
     }
     static async delay(ms) {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "clashofclans.js",
-	"version": "2.0.0-dev.dc4d83a",
+	"version": "2.0.0-dev.dedb83d",
 	"description": "JavaScript library for interacting with the Clash of Clans API",
 	"author": "SUVAJIT <suvajit.me@gmail.com>",
 	"license": "MIT",
@@ -95,15 +95,15 @@
 		"@types/keyv": "^3.1.3",
 		"@types/node": "^16.10.3",
 		"@types/node-fetch": "^2.5.12",
-		"@typescript-eslint/eslint-plugin": "^5.0.0",
-		"@typescript-eslint/parser": "^5.0.0",
-		"eslint": "^7.28.0",
+		"@typescript-eslint/eslint-plugin": "^5.4.0",
+		"@typescript-eslint/parser": "^5.4.0",
+		"eslint": "^8.3.0",
 		"eslint-config-marine": "^9.0.6",
 		"eslint-config-prettier": "^8.3.0",
 		"eslint-plugin-prettier": "^4.0.0",
 		"prettier": "^2.4.1",
 		"rimraf": "^3.0.2",
-		"typescript": "^4.4.3"
+		"typescript": "^4.5.2"
 	},
 	"engines": {
 		"node": ">=14.x"