clashofclans.js 2.0.0-dev.30ea324 → 2.0.0-dev.7768cb1

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;
@@ -31,54 +31,65 @@ class EventManager {
         this.warUpdateHandler();
         return Promise.resolve(this.client.eventNames());
     }
-    addClans(...tags) {
-        for (const tag of tags) {
+    /** Add clan tags to clan events. */
+    addClans(tags) {
+        for (const tag of Array.isArray(tags) ? tags : [tags]) {
             this._clanTags.add(this.client.util.parseTag(tag));
         }
         return this;
     }
-    deleteClans(...tags) {
-        for (const tag of tags) {
-            this._warTags.delete(this.client.util.parseTag(tag));
+    /** Delete clan tags from clan events. */
+    deleteClans(tags) {
+        for (const tag of Array.isArray(tags) ? tags : [tags]) {
+            const key = this.client.util.parseTag(tag);
+            this._clans.delete(key);
+            this._clanTags.delete(key);
         }
         return this;
     }
-    addPlayers(...tags) {
-        for (const tag of tags) {
+    /** Add player tags for player events. */
+    addPlayers(tags) {
+        for (const tag of Array.isArray(tags) ? tags : [tags]) {
             this._playerTags.add(this.client.util.parseTag(tag));
         }
         return this;
     }
-    deletePlayers(...tags) {
-        for (const tag of tags) {
-            this._warTags.delete(this.client.util.parseTag(tag));
+    /** Delete player tags from player events. */
+    deletePlayers(tags) {
+        for (const tag of Array.isArray(tags) ? tags : [tags]) {
+            const key = this.client.util.parseTag(tag);
+            this._players.delete(key);
+            this._playerTags.delete(key);
         }
         return this;
     }
-    addWars(...tags) {
-        for (const tag of tags) {
+    /** Add clan tags for war events. */
+    addWars(tags) {
+        for (const tag of Array.isArray(tags) ? tags : [tags]) {
             this._warTags.add(this.client.util.parseTag(tag));
         }
         return this;
     }
-    deleteWars(...tags) {
-        for (const tag of tags) {
-            this._warTags.delete(this.client.util.parseTag(tag));
+    /** Delete clan tags from war events. */
+    deleteWars(tags) {
+        for (const tag of Array.isArray(tags) ? tags : [tags]) {
+            const key = this.client.util.parseTag(tag);
+            this._wars.delete(`${key}:${1}`);
+            this._wars.delete(`${key}:${2}`);
+            this._warTags.delete(key);
         }
         return this;
     }
     /**
-     * Set your own custom event.
-     * @param event.type - `CLAN` | `PLAYER` | `CLAN_WAR`
-     * @param event.name - Name of the event.
-     * @param event.filter - Filter of this event. Must return a boolean value.
+     * 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', '']);
+     * client.events.addClans(['#2PP', '#8QU8J9LP']);
      *
-     * client.events.setEvent({
-     *   type: 'CLAN',
+     * client.events.setClanEvent({
      *   name: 'clanMemberUpdate',
      *   filter: (oldClan, newClan) => {
      *     return oldClan.memberCount !== newClan.memberCount;
@@ -87,27 +98,46 @@ class EventManager {
      *
      * client.on('clanMemberUpdate', (oldClan, newClan) => {
      *   console.log(oldClan.memberCount, newClan.memberCount);
-     * })
+     * });
+     *
+     * (async function () {
+     *   await client.events.init();
+     * })();
      * ```
      * @returns
      */
-    setEvent(event) {
-        switch (event.type) {
-            case 'CLAN':
-                // @ts-expect-error
-                this._events.clans.push(event);
-                break;
-            case 'PLAYER':
-                // @ts-expect-error
-                this._events.players.push(event);
-                break;
-            case 'CLAN_WAR':
-                // @ts-expect-error
-                this._events.wars.push(event);
-                break;
-            default:
-                break;
-        }
+    setClanEvent(event) {
+        if (!event.name)
+            throw new Error('Event name is required.');
+        if (typeof event.filter !== 'function')
+            throw new Error('Filter function is required.');
+        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) {
+        if (!event.name)
+            throw new Error('Event name is required.');
+        if (typeof event.filter !== 'function')
+            throw new Error('Filter function is required.');
+        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) {
+        if (!event.name)
+            throw new Error('Event name is required.');
+        if (typeof event.filter !== 'function')
+            throw new Error('Filter function is required.');
+        this._events.players.push(event);
         return this;
     }
     async maintenanceHandler() {
@@ -116,7 +146,7 @@ class EventManager {
             const res = await this.client.rest.getClans({ maxMembers: Math.floor(Math.random() * 40) + 10, limit: 1 });
             if (res.status === 200 && this._inMaintenance) {
                 this._inMaintenance = Boolean(false);
-                const duration = this._maintenanceStartTime.getTime() - Date.now();
+                const duration = Date.now() - this._maintenanceStartTime.getTime();
                 this._maintenanceStartTime = null;
                 this.client.emit(Constants_1.EVENTS.MAINTENANCE_END, duration);
             }
@@ -153,7 +183,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);
@@ -171,9 +201,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);
             }
@@ -192,9 +222,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);
             }
@@ -211,14 +241,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, index) => {
+            const key = `${tag}:${index}`;
             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);
                 }
@@ -226,6 +256,22 @@ class EventManager {
                     this.client.emit(Constants_1.EVENTS.ERROR, error);
                 }
             }
+            // check for war end
+            if (index === 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,24 @@
 /** 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,23 +1,42 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.HTTPError = void 0;
+exports.PrivateWarLogError = exports.NotInWarError = exports.HTTPError = void 0;
 const messages = {
-    504: 'The user aborted a request.',
-    404: 'Resource was not found.'
+    500: 'Unknown error happened when handling the request.',
+    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.',
+    403: 'Access denied, either because of missing/incorrect credentials or used API token does not grant access to the requested resource.'
 };
 const reasons = {
-    504: 'networkTimeout',
-    404: 'notFound'
+    503: 'serviceUnavailable',
+    429: 'tooManyRequests',
+    400: 'badRequest',
+    403: 'forbidden',
+    500: 'unknownError',
+    404: 'notFound',
+    504: 'requestAborted'
 };
 /** 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

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

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);
     }