clashofclans.js 2.0.0-dev.dedb83d → 2.0.1-dev.ba82327

package/CHANGELOG.md

@@ -2,15 +2,23 @@
 
 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.0.0
+## 2.0.1 (2021-11-27)
+
+### Bug Fixes
+
+-   IP retrieval method and Event Loop ([#70](https://github.com/clashperk/clashofclans.js/issues/70)) ([82b84ba](https://github.com/clashperk/clashofclans.js/commit/82b84ba5d96505c43b75e53aa07f547ef0b77778))
+
+## 2.0.0 (2021-11-26)
 
 This new version is a complete TypeScript rewrite to convert everything from plain (literal JSON) objects to class (constructor) objects and support a lot more features.
 
 ### Features
 
--   EventManager and Custom Events ([#37](https://github.com/clashperk/clashofclans.js/issues/37)) ([5027ae6](https://github.com/clashperk/clashofclans.js/commit/5027ae663a8e07175e17384c7e5706f4a1a7afb4)) ([984451d](https://github.com/clashperk/clashofclans.js/commit/30ea3240c11866008d0dae514468c0fdbb34ffd0))
--   Internal Caching Options ([#53](https://github.com/clashperk/clashofclans.js/issues/53))
+-   HTTP Request Request Retries ([#26](https://github.com/clashperk/clashofclans.js/issues/26)) ([94585f3](https://github.com/clashperk/clashofclans.js/commit/94585f3a84a7175b2d07872f9eb9e42372b95e12))
+-   Event Manager and Custom Events ([#37](https://github.com/clashperk/clashofclans.js/issues/37)) ([5027ae6](https://github.com/clashperk/clashofclans.js/commit/5027ae663a8e07175e17384c7e5706f4a1a7afb4))
 -   Email Password Login ([#31](https://github.com/clashperk/clashofclans.js/issues/31)) ([4153cd3](https://github.com/clashperk/clashofclans.js/commit/4153cd37ea0e1c71550b9e892105b84d5a407e23))
--   API Date Parser and Request Retries ([#26](https://github.com/clashperk/clashofclans.js/issues/26)) ([94585f3](https://github.com/clashperk/clashofclans.js/commit/94585f3a84a7175b2d07872f9eb9e42372b95e12))
+-   Queue Throttler and Batch Throttler ([#34](https://github.com/clashperk/clashofclans.js/issues/34)) ([3a8f051](https://github.com/clashperk/clashofclans.js/commit/3a8f051552e93b98f89bc7d524acdecddf242718))
 -   Override Request Options ([#36](https://github.com/clashperk/clashofclans.js/issues/36)) ([42d7fdd](https://github.com/clashperk/clashofclans.js/commit/42d7fdd36262cc46f23b731f8cffb9daea19d3b0))
--   QueueThrottler and BatchThrottler ([#34](https://github.com/clashperk/clashofclans.js/issues/34)) ([3a8f051](https://github.com/clashperk/clashofclans.js/commit/3a8f051552e93b98f89bc7d524acdecddf242718))
+-   Internal Caching Options ([#53](https://github.com/clashperk/clashofclans.js/issues/53)) ([984451d](https://github.com/clashperk/clashofclans.js/commit/30ea3240c11866008d0dae514468c0fdbb34ffd0))
+-   Additional Properties for Player Units ([#65](https://github.com/clashperk/clashofclans.js/pull/65)) ([aa1696](https://github.com/clashperk/clashofclans.js/commit/aa1696243d96d4fed0250b4282c60522a6482343))
+

package/README.md

@@ -39,12 +39,13 @@ const client = new Client();
 ```js
 const { Client, BatchThrottler } = require('clashofclans.js');
 const client = new Client({
+    cache: true,
     retryLimit: 1,
-    restRequestTimeout: 3000,
-    throttler: new BatchThrottler(30)
+    restRequestTimeout: 5000,
+    throttler: new BatchThrottler(20)
 });
 
-client.events.addClans(['#8P2QG08P']);
+client.events.addClans(['#8QU8J9LP', '#8P2QG08P']);
 client.events.setClanEvent({
     name: 'clanDescriptionChange',
     filter: (oldClan, newClan) => {

package/dist/client/Client.d.ts

@@ -5,7 +5,7 @@ import { RESTManager } from '../rest/RESTManager';
 import { EventManager } from './EventManager';
 import { EventEmitter } from 'events';
 import { Util } from '../util/Util';
-import { Clan, ClanMember, ClanWar, ClanWarLog, League, Location, Player, WarLeague, RankedClan, RankedPlayer, Label, GoldPassSeason, ClanWarLeagueGroup } from '../struct';
+import { Clan, ClanMember, ClanWar, ClanWarLog, League, Location, Player, WarLeague, RankedClan, RankedPlayer, Label, SeasonRankedPlayer, GoldPassSeason, ClanWarLeagueGroup } from '../struct';
 /**
  * Represents Clash of Clans API Client.
  * ```js
@@ -21,6 +21,8 @@ export declare class Client extends EventEmitter {
     constructor(options?: ClientOptions);
     /** Contains various general-purpose utility methods. */
     get util(): typeof Util;
+    /** Whether the API is in maintenance break. */
+    get inMaintenance(): boolean;
     /**
      * Initialize the client to create keys.
      * @example
@@ -33,8 +35,8 @@ export declare class Client extends EventEmitter {
     /** Set Clash of Clans API keys. */
     setKeys(keys: string[]): this;
     /** Search all clans by name and/or filtering the results using various criteria. */
-    getClans(options: ClanSearchOptions): Promise<Clan[]>;
-    /** Get information about a clan. */
+    getClans(query: ClanSearchOptions, options?: OverrideOptions): Promise<Clan[]>;
+    /** Get info about a clan. */
     getClan(clanTag: string, options?: OverrideOptions): Promise<Clan>;
     /** Get list of clan members. */
     getClanMembers(clanTag: string, options?: SearchOptions): Promise<ClanMember[]>;
@@ -74,14 +76,14 @@ export declare class Client extends EventEmitter {
     }, options?: OverrideOptions): Promise<ClanWar | null>;
     private _getCurrentLeagueWars;
     private _getClanWars;
-    /** Get information about clan war league. */
+    /** Get info about clan war league. */
     getClanWarLeagueGroup(clanTag: string, options?: OverrideOptions): Promise<ClanWarLeagueGroup>;
-    /** Get information about CWL round by WarTag. */
+    /** Get info about a CWL round by WarTag. */
     getClanWarLeagueRound(warTag: string | {
         warTag: string;
         clanTag?: string;
     }, options?: OverrideOptions): Promise<ClanWar>;
-    /** Get information about a player by tag. */
+    /** Get info about a player by tag. */
     getPlayer(playerTag: string, options?: OverrideOptions): Promise<Player>;
     /** Verify Player API token that can be found from the Game settings. */
     verifyPlayerToken(playerTag: string, token: string, options?: OverrideOptions): Promise<boolean>;
@@ -90,18 +92,34 @@ export declare class Client extends EventEmitter {
     /** Get Legend League season Ids. */
     getLeagueSeasons(options?: SearchOptions): Promise<string[]>;
     /** Get Legend League season rankings by season Id. */
-    getSeasonRankings(seasonId: string, options?: SearchOptions): Promise<RankedPlayer[]>;
+    getSeasonRankings(seasonId: string, options?: SearchOptions): Promise<SeasonRankedPlayer[]>;
     /** Get list of Clan War Leagues. */
     getWarLeagues(options?: SearchOptions): Promise<WarLeague[]>;
     /** Get list of Locations. */
     getLocations(options?: SearchOptions): Promise<Location[]>;
-    /** Get clan rankings for a specific location. */
+    /**
+     * Get clan rankings for a specific location.
+     *
+     * For global ranking, use `global` as `locationId`.
+     */
     getClanRanks(locationId: number | 'global', options?: SearchOptions): Promise<RankedClan[]>;
-    /** Get player rankings for a specific location. */
+    /**
+     * Get player rankings for a specific location.
+     *
+     * For global ranking, use `global` as `locationId`.
+     */
     getPlayerRanks(locationId: number | 'global', options?: SearchOptions): Promise<RankedPlayer[]>;
-    /** Get clan versus rankings for a specific location */
+    /**
+     * Get clan versus rankings for a specific location.
+     *
+     * For global ranking, use `global` as `locationId`.
+     */
     getVersusClanRanks(locationId: number | 'global', options?: SearchOptions): Promise<RankedClan[]>;
-    /** Get player versus rankings for a specific location */
+    /**
+     * Get player versus rankings for a specific location.
+     *
+     * For global ranking, use `global` as `locationId`.
+     */
     getVersusPlayerRanks(locationId: number | 'global', options?: SearchOptions): Promise<RankedPlayer[]>;
     /** Get list of clan labels. */
     getClanLabels(options?: SearchOptions): Promise<Label[]>;

package/dist/client/Client.js

@@ -25,6 +25,11 @@ class Client extends events_1.EventEmitter {
     get util() {
         return Util_1.Util;
     }
+    /** Whether the API is in maintenance break. */
+    get inMaintenance() {
+        // @ts-expect-error
+        return this.events._inMaintenance;
+    }
     /**
      * Initialize the client to create keys.
      * @example
@@ -42,12 +47,12 @@ class Client extends events_1.EventEmitter {
         return this;
     }
     /** Search all clans by name and/or filtering the results using various criteria. */
-    async getClans(options) {
-        const { data } = await this.rest.getClans(options);
+    async getClans(query, options) {
+        const { data } = await this.rest.getClans(query, options);
         // @ts-expect-error
         return data.items.map((clan) => new struct_1.Clan(this, clan));
     }
-    /** Get information about a clan. */
+    /** Get info about a clan. */
     async getClan(clanTag, options) {
         const { data } = await this.rest.getClan(clanTag, options);
         return new struct_1.Clan(this, data);
@@ -88,7 +93,7 @@ class Client extends events_1.EventEmitter {
         }
         catch (e) {
             if (e instanceof HTTPError_1.HTTPError && [200, 403].includes(e.status)) {
-                return this.getLeagueWar({ clanTag: args.clanTag, round: args.round });
+                return this.getLeagueWar({ clanTag: args.clanTag, round: args.round }, options);
             }
             throw e;
         }
@@ -117,7 +122,7 @@ 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: args.clanTag }, { ignoreRateLimit: true })));
+        const wars = await this.util.allSettled(warTags.map((warTag) => this.getClanWarLeagueRound({ warTag, clanTag: args.clanTag }, { ...options, ignoreRateLimit: true })));
         if (args.round && args.round in Constants_1.CWL_ROUNDS) {
             return wars.find((war) => war.state === state) ?? null;
         }
@@ -126,7 +131,7 @@ class Client extends events_1.EventEmitter {
     async _getCurrentLeagueWars(clanTag, options) {
         const data = await this.getClanWarLeagueGroup(clanTag, options);
         // @ts-expect-error
-        return data._getCurrentWars(clanTag);
+        return data._getCurrentWars(clanTag, options);
     }
     async _getClanWars(clanTag, options) {
         const date = new Date().getUTCDate();
@@ -134,21 +139,21 @@ class Client extends events_1.EventEmitter {
             return [await this.getClanWar(clanTag, options)];
         }
         try {
-            return this._getCurrentLeagueWars(clanTag);
+            return this._getCurrentLeagueWars(clanTag, options);
         }
         catch (e) {
             if (e instanceof HTTPError_1.HTTPError && [404].includes(e.status)) {
-                return [await this.getClanWar(clanTag)];
+                return [await this.getClanWar(clanTag, options)];
             }
             throw e;
         }
     }
-    /** Get information about clan war league. */
+    /** Get info about clan war league. */
     async getClanWarLeagueGroup(clanTag, options) {
         const { data } = await this.rest.getClanWarLeagueGroup(clanTag, options);
         return new struct_1.ClanWarLeagueGroup(this, data);
     }
-    /** Get information about CWL round by WarTag. */
+    /** Get info about a CWL round by WarTag. */
     async getClanWarLeagueRound(warTag, options) {
         const args = typeof warTag === 'string' ? { warTag } : { warTag: warTag.warTag, clanTag: warTag.clanTag };
         const { data, maxAge, status, path } = await this.rest.getClanWarLeagueRound(args.warTag, options);
@@ -157,14 +162,14 @@ class Client extends events_1.EventEmitter {
         }
         return new struct_1.ClanWar(this, data, { warTag: args.warTag, clanTag: args.clanTag, maxAge });
     }
-    /** Get information about a player by tag. */
+    /** Get info about a player by tag. */
     async getPlayer(playerTag, options) {
         const { data } = await this.rest.getPlayer(playerTag, options);
         return new struct_1.Player(this, data);
     }
     /** Verify Player API token that can be found from the Game settings. */
     async verifyPlayerToken(playerTag, token, options) {
-        const { data } = await this.rest.postPlayerToken(playerTag, token, options);
+        const { data } = await this.rest.verifyPlayerToken(playerTag, token, options);
         return data.status === 'ok';
     }
     /** Get list of Leagues. */
@@ -180,8 +185,7 @@ class Client extends events_1.EventEmitter {
     /** Get Legend League season rankings by season Id. */
     async getSeasonRankings(seasonId, options) {
         const { data } = await this.rest.getSeasonRankings(Constants_1.LEGEND_LEAGUE_ID, seasonId, options);
-        // @ts-expect-error
-        return data.items.map((entry) => new struct_1.RankedPlayer(entry));
+        return data.items.map((entry) => new struct_1.SeasonRankedPlayer(this, entry));
     }
     /** Get list of Clan War Leagues. */
     async getWarLeagues(options) {
@@ -193,22 +197,38 @@ class Client extends events_1.EventEmitter {
         const { data } = await this.rest.getLocations(options);
         return data.items.map((entry) => new struct_1.Location(entry));
     }
-    /** Get clan rankings for a specific location. */
+    /**
+     * Get clan rankings for a specific location.
+     *
+     * For global ranking, use `global` as `locationId`.
+     */
     async getClanRanks(locationId, options) {
         const { data } = await this.rest.getClanRanks(locationId, options);
         return data.items.map((entry) => new struct_1.RankedClan(entry));
     }
-    /** Get player rankings for a specific location. */
+    /**
+     * Get player rankings for a specific location.
+     *
+     * For global ranking, use `global` as `locationId`.
+     */
     async getPlayerRanks(locationId, options) {
         const { data } = await this.rest.getPlayerRanks(locationId, options);
         return data.items.map((entry) => new struct_1.RankedPlayer(this, entry));
     }
-    /** Get clan versus rankings for a specific location */
+    /**
+     * Get clan versus rankings for a specific location.
+     *
+     * For global ranking, use `global` as `locationId`.
+     */
     async getVersusClanRanks(locationId, options) {
         const { data } = await this.rest.getVersusClanRanks(locationId, options);
         return data.items.map((entry) => new struct_1.RankedClan(entry));
     }
-    /** Get player versus rankings for a specific location */
+    /**
+     * Get player versus rankings for a specific location.
+     *
+     * For global ranking, use `global` as `locationId`.
+     */
     async getVersusPlayerRanks(locationId, options) {
         const { data } = await this.rest.getVersusPlayerRanks(locationId, options);
         return data.items.map((entry) => new struct_1.RankedPlayer(this, entry));

package/dist/client/EventManager.d.ts

@@ -15,18 +15,18 @@ export declare class EventManager {
     constructor(client: Client);
     /** Initialize the Event Manager to start pulling. */
     init(): Promise<string[]>;
-    /** Add a clan tag to clan events. */
-    addClans(...tags: string[]): this;
-    /** Delete a clan tag from clan events. */
-    deleteClans(...tags: string[]): this;
-    /** Add a player tag for player events. */
-    addPlayers(...tags: string[]): this;
-    /** Delete a player tag from player events. */
-    deletePlayers(...tags: string[]): this;
-    /** Add a clan tag for war events. */
-    addWars(...tags: string[]): this;
-    /** Delete a clan tag from war events. */
-    deleteWars(...tags: string[]): this;
+    /** Add clan tags to clan events. */
+    addClans(tags: string[] | string): this;
+    /** Delete clan tags from clan events. */
+    deleteClans(tags: string[] | string): this;
+    /** Add player tags for player events. */
+    addPlayers(tags: string[] | string): this;
+    /** Delete player tags from player events. */
+    deletePlayers(tags: string[] | string): this;
+    /** Add clan tags for war events. */
+    addWars(tags: string[] | string): this;
+    /** Delete clan tags from war events. */
+    deleteWars(tags: string[] | string): this;
     /**
      * Set your own custom clan event.
      *

package/dist/client/EventManager.js

@@ -31,45 +31,52 @@ class EventManager {
         this.warUpdateHandler();
         return Promise.resolve(this.client.eventNames());
     }
-    /** Add a clan tag to clan events. */
-    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;
     }
-    /** Delete a clan tag from clan events. */
-    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;
     }
-    /** Add a player tag for player events. */
-    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;
     }
-    /** Delete a player tag from player events. */
-    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;
     }
-    /** Add a clan tag for war events. */
-    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;
     }
-    /** Delete a clan tag from war events. */
-    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;
     }
@@ -100,6 +107,10 @@ class EventManager {
      * @returns
      */
     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;
     }
@@ -109,6 +120,10 @@ class EventManager {
      * 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;
     }
@@ -118,6 +133,10 @@ class EventManager {
      * 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;
     }
@@ -127,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);
             }
@@ -144,7 +163,7 @@ class EventManager {
         const end = Util_1.Util.getSeasonEndTime().getTime() - Date.now();
         // Why this? setTimeout can be up to 24.8 days or 2147483647ms [(2^31 - 1) Max 32bit Integer]
         if (end > 24 * 60 * 60 * 1000) {
-            setTimeout(this.seasonEndHandler.bind(this), 60 * 60 * 1000).unref();
+            setTimeout(this.seasonEndHandler.bind(this), 60 * 60 * 1000);
         }
         else if (end > 0) {
             setTimeout(() => {
@@ -222,8 +241,8 @@ class EventManager {
         const clanWars = await this.client._getClanWars(tag).catch(() => null);
         if (!clanWars?.length)
             return null;
-        clanWars.forEach(async (war, state) => {
-            const key = `${tag}:${state}`;
+        clanWars.forEach(async (war, index) => {
+            const key = `${tag}:${index}`;
             const cached = this._wars.get(key);
             if (!cached)
                 return this._wars.set(key, war);
@@ -238,7 +257,7 @@ class EventManager {
                 }
             }
             // check for war end
-            if (state === 1 && cached.warTag !== war.warTag) {
+            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) {

package/dist/rest/HTTPError.d.ts

@@ -1,12 +1,15 @@
-/**
- * Represents an HTTP Error.
- */
+/** Represents an HTTP Error. */
 export declare class HTTPError extends Error {
-    /** The message of this error. */
+    /** The message of this errored request. */
     message: string;
     /** The HTTP method of this request. */
     method: string;
-    /** The reason of this error. */
+    /**
+     * The reason of this errored request.
+     *
+     * Expected values are `notFound`, `notInWar`, `accessDenied`, `accessDenied.invalidIp`, `privateWarLog`,
+     * `badRequest`, `requestThrottled`, `serviceUnavailable`, `requestAborted` and `unknownException`.
+     */
     reason: string;
     /** The HTTP status code of this request. */
     status: number;

package/dist/rest/HTTPError.js

@@ -12,16 +12,14 @@ const messages = {
 };
 const reasons = {
     503: 'serviceUnavailable',
-    429: 'tooManyRequests',
+    429: 'requestThrottled',
     400: 'badRequest',
-    403: 'forbidden',
-    500: 'unknownError',
+    403: 'accessDenied',
+    500: 'unknownException',
     404: 'notFound',
     504: 'requestAborted'
 };
-/**
- * Represents an HTTP Error.
- */
+/** Represents an HTTP Error. */
 class HTTPError extends Error {
     constructor(error, status, path, maxAge, method) {
         super();