clashofclans.js 3.0.0-dev.392ca4c → 3.0.0-dev.ec60c82

package/dist/rest/RESTManager.js

@@ -1,12 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RESTManager = void 0;
-const RequestHandler_1 = require("./RequestHandler");
+const node_events_1 = require("node:events");
 const Util_1 = require("../util/Util");
+const Constants_1 = require("../util/Constants");
+const RequestHandler_1 = require("./RequestHandler");
 /** Represents a REST Manager of the client. */
-class RESTManager {
+class RESTManager extends node_events_1.EventEmitter {
     constructor(options) {
-        this.handler = new RequestHandler_1.RequestHandler(options);
+        super();
+        this.requestHandler = new RequestHandler_1.RequestHandler(options)
+            .on(Constants_1.RestEvents.Debug, this.emit.bind(this, Constants_1.RestEvents.Debug))
+            .on(Constants_1.RestEvents.Error, this.emit.bind(this, Constants_1.RestEvents.Error))
+            .on(Constants_1.RestEvents.RateLimited, this.emit.bind(this, Constants_1.RestEvents.RateLimited));
     }
     /** Contains various general-purpose utility methods. */
     get util() {
@@ -21,122 +27,122 @@ class RESTManager {
      * ```
      */
     login(options) {
-        return this.handler.init(options);
+        return this.requestHandler.init(options);
     }
     /** Set Clash of Clans API keys. */
     setKeys(keys) {
-        this.handler.setKeys(keys);
+        this.requestHandler.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.requestHandler.request(`/clans${Util_1.Util.queryString(query)}`, options);
     }
     /** Get info about a clan. */
     getClan(clanTag, options) {
-        return this.handler.request(`/clans/${Util_1.Util.encodeURI(clanTag)}`, options);
+        return this.requestHandler.request(`/clans/${Util_1.Util.encodeURI(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.encodeURI(clanTag)}/members${query}`, options);
+        return this.requestHandler.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.requestHandler.request(`/clans/${Util_1.Util.encodeURI(clanTag)}/warlog${query}`, options);
     }
     /** Get info about currently running war in the clan. */
     getCurrentWar(clanTag, options) {
-        return this.handler.request(`/clans/${Util_1.Util.encodeURI(clanTag)}/currentwar`, options);
+        return this.requestHandler.request(`/clans/${Util_1.Util.encodeURI(clanTag)}/currentwar`, options);
     }
     /** Get info about clan war league. */
     getClanWarLeagueGroup(clanTag, options) {
-        return this.handler.request(`/clans/${Util_1.Util.encodeURI(clanTag)}/currentwar/leaguegroup`, options);
+        return this.requestHandler.request(`/clans/${Util_1.Util.encodeURI(clanTag)}/currentwar/leaguegroup`, options);
     }
     /** Get info about a CWL round by WarTag. */
     getClanWarLeagueRound(warTag, options) {
-        return this.handler.request(`/clanwarleagues/wars/${Util_1.Util.encodeURI(warTag)}`, options);
+        return this.requestHandler.request(`/clanwarleagues/wars/${Util_1.Util.encodeURI(warTag)}`, options);
     }
     /** Get info about a player by tag. */
     getPlayer(playerTag, options) {
-        return this.handler.request(`/players/${Util_1.Util.encodeURI(playerTag)}`, options);
+        return this.requestHandler.request(`/players/${Util_1.Util.encodeURI(playerTag)}`, 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.encodeURI(playerTag)}/verifytoken`, opts);
+        return this.requestHandler.request(`/players/${Util_1.Util.encodeURI(playerTag)}/verifytoken`, opts);
     }
     /** Get list of Leagues. */
     getLeagues(options) {
         const query = Util_1.Util.queryString(options);
-        return this.handler.request(`/leagues${query}`, options);
+        return this.requestHandler.request(`/leagues${query}`, options);
     }
     /** Get a League info. */
     getLeague(leagueId, options) {
-        return this.handler.request(`/leagues/${leagueId}`, options);
+        return this.requestHandler.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);
+        return this.requestHandler.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.requestHandler.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.requestHandler.request(`/warleagues${query}`, options);
     }
     /** Get info about a Clan War League. */
     getWarLeague(leagueId, options) {
-        return this.handler.request(`/warleagues/${leagueId}`, options);
+        return this.requestHandler.request(`/warleagues/${leagueId}`, options);
     }
     /** Get list of Locations. */
     getLocations(options) {
         const query = Util_1.Util.queryString(options);
-        return this.handler.request(`/locations${query}`, options);
+        return this.requestHandler.request(`/locations${query}`, options);
     }
     /** Get info about a Location. */
     getLocation(locationId, options) {
-        return this.handler.request(`/locations/${locationId}`, options);
+        return this.requestHandler.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);
+        return this.requestHandler.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.requestHandler.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.requestHandler.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.requestHandler.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.requestHandler.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.requestHandler.request(`/labels/players${query}`, options);
     }
     /** Get info about gold pass season. */
     getGoldPassSeason(options) {
-        return this.handler.request('/goldpass/seasons/current', options);
+        return this.requestHandler.request('/goldpass/seasons/current', options);
     }
 }
 exports.RESTManager = RESTManager;

package/dist/rest/RequestHandler.d.ts

@@ -1,6 +1,34 @@
+/// <reference types="node" />
+import { EventEmitter } from 'node:events';
 import { Response, RequestOptions, LoginOptions, RequestHandlerOptions } from '../types';
-/** Represents a Request Handler. */
-export declare class RequestHandler {
+import { IRestEvents } from './RESTManager';
+export interface RequestHandler {
+    emit: (<K extends keyof IRestEvents>(event: K, ...args: IRestEvents[K]) => boolean) & (<S extends string | symbol>(event: Exclude<S, keyof IRestEvents>, ...args: any[]) => boolean);
+    off: (<K extends keyof IRestEvents>(event: K, listener: (...args: IRestEvents[K]) => void) => this) & (<S extends string | symbol>(event: Exclude<S, keyof IRestEvents>, listener: (...args: any[]) => void) => this);
+    on: (<K extends keyof IRestEvents>(event: K, listener: (...args: IRestEvents[K]) => void) => this) & (<S extends string | symbol>(event: Exclude<S, keyof IRestEvents>, listener: (...args: any[]) => void) => this);
+    once: (<K extends keyof IRestEvents>(event: K, listener: (...args: IRestEvents[K]) => void) => this) & (<S extends string | symbol>(event: Exclude<S, keyof IRestEvents>, listener: (...args: any[]) => void) => this);
+    removeAllListeners: (<K extends keyof IRestEvents>(event?: K) => this) & (<S extends string | symbol>(event?: Exclude<S, keyof IRestEvents>) => this);
+    /**
+     * Emitted for general debugging information.
+     * @public
+     * @event
+     */
+    debug: string;
+    /**
+     * Emitted when the client encounters an error.
+     * @public
+     * @event
+     */
+    error: string;
+    /**
+     * Emitted when the client is rate limited.
+     * @public
+     * @event
+     */
+    rateLimited: string;
+}
+/** Represents the class that manages handlers for endpoints. */
+export declare class RequestHandler extends EventEmitter {
     #private;
     private email;
     private password;

package/dist/rest/RequestHandler.js

@@ -16,16 +16,18 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 var _RequestHandler_keyIndex;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RequestHandler = void 0;
+const node_https_1 = __importDefault(require("node:https"));
+const node_events_1 = require("node:events");
+const node_fetch_1 = __importDefault(require("node-fetch"));
 const Constants_1 = require("../util/Constants");
-const HTTPError_1 = require("./HTTPError");
 const Store_1 = require("../util/Store");
-const node_fetch_1 = __importDefault(require("node-fetch"));
-const https_1 = __importDefault(require("https"));
+const HTTPError_1 = require("./HTTPError");
 const IP_REGEX = /\d{1,3}.\d{1,3}.\d{1,3}.\d{1,3}/g;
-const agent = new https_1.default.Agent({ keepAlive: true });
-/** Represents a Request Handler. */
-class RequestHandler {
+const agent = new node_https_1.default.Agent({ keepAlive: true });
+/** Represents the class that manages handlers for endpoints. */
+class RequestHandler extends node_events_1.EventEmitter {
     constructor(options) {
+        super();
         _RequestHandler_keyIndex.set(this, 0); // eslint-disable-line
         this.keys = options?.keys ?? [];
         this.retryLimit = options?.retryLimit ?? 0;
@@ -89,6 +91,10 @@ class RequestHandler {
         if (!res?.ok && this.rejectIfNotValid) {
             throw new HTTPError_1.HTTPError(data, res?.status ?? 504, path, maxAge, options.method);
         }
+        if (res?.status === 429) {
+            this.emit(Constants_1.RestEvents.RateLimited, path, res.status, options.method);
+        }
+        this.emit(Constants_1.RestEvents.Debug, path, res?.status ?? 504, options.method);
         if (this.cached && maxAge > 0 && options.cache !== false && res?.ok) {
             await this.cached.set(path, { data, ttl: Date.now() + maxAge, status: res.status }, maxAge);
         }

package/dist/struct/Clan.d.ts

@@ -1,7 +1,7 @@
 import { APIClan, OverrideOptions } from '../types';
+import { Client } from '../client/Client';
 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';

package/dist/struct/Player.d.ts

@@ -1,9 +1,9 @@
 import { APIPlayer, OverrideOptions } from '../types';
+import { Client } from '../client/Client';
 import { LegendStatistics } from './LegendStatistics';
 import { Achievement } from './Achievement';
 import { Hero, Spell, Troop } from './Unit';
 import { PlayerClan } from './PlayerClan';
-import { Client } from '../client/Client';
 import { League } from './League';
 import { Label } from './Label';
 /** Represents a Clash of Clans Player. */

package/dist/struct/Ranking.d.ts

@@ -1,6 +1,6 @@
 import { APIClanRanking, APIClanVersusRanking, APIPlayerRanking, APIPlayerVersusRanking } from '../types';
-import { PlayerClan } from './PlayerClan';
 import { Client } from '../client/Client';
+import { PlayerClan } from './PlayerClan';
 import { Location } from './Location';
 import { League } from './League';
 import { Badge } from './Badge';

package/dist/struct/Unit.d.ts

@@ -39,8 +39,6 @@ export declare class Unit {
     seasonal: boolean;
     /** Damage per second of this unit. */
     dps: number;
-    /** Resource type of this unit. */
-    resourceType: string;
     /** Training time of this unit. */
     trainingTime: number;
     /** @internal */

package/dist/struct/Unit.js

@@ -25,7 +25,6 @@ class Unit {
             this.unlockBuilding = original.unlock.building;
             this.unlockBuildingLevel = original.unlock.buildingLevel;
             this.dps = rawUnit.dps[this.level - 1];
-            this.resourceType = rawSuperUnit.resource;
             this.trainingTime = rawUnit.trainingTime;
             const origin = data.troops.find((troop) => troop.village === 'home' && troop.name === original.name);
             this.level = origin.level;
@@ -49,7 +48,6 @@ class Unit {
             this.upgradeCost = rawUnit.upgrade.cost[this.level - 1] ?? 0;
             this.upgradeTime = rawUnit.upgrade.time[this.level - 1] ?? 0;
             this.dps = rawUnit.dps[this.level - 1];
-            this.resourceType = rawUnit.resourceType;
             this.trainingTime = rawUnit.trainingTime;
             if (rawUnit.category === 'hero')
                 this.regenerationTime = rawUnit.regenerationTimes[this.level - 1];

package/dist/struct/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/dist/types/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/dist/types/lib.d.ts

@@ -1,9 +1,9 @@
 import { QueueThrottler, BatchThrottler } from '../rest/Throttler';
 export interface Store<T = any> {
-    set(key: string, value: T, ttl?: number): boolean | Promise<boolean>;
-    get(key: string): T | null | Promise<T | null>;
-    delete(key: string): boolean | Promise<boolean>;
-    clear(): void | Promise<void>;
+    set: (key: string, value: T, ttl?: number) => boolean | Promise<boolean>;
+    get: (key: string) => T | null | Promise<T | null>;
+    delete: (key: string) => boolean | Promise<boolean>;
+    clear: () => void | Promise<void>;
 }
 /** Options for a {@link Client} */
 export interface ClientOptions {

package/dist/util/Constants.d.ts

@@ -24,25 +24,60 @@ export declare const Leagues: number[];
 export declare const WarLeagues: number[];
 export declare const FriendlyWarPreparationTimes: readonly [number, number, number, number, number, number, number, number, number, number, number, number];
 export declare const PollingEvents: {
-    readonly NewSeasonStart: "newSeasonStart";
     readonly ClanLoopStart: "clanLoopStart";
     readonly ClanLoopEnd: "clanLoopEnd";
     readonly PlayerLoopStart: "playerLoopStart";
     readonly PlayerLoopEnd: "playerLoopEnd";
     readonly WarLoopStart: "warLoopEnd";
     readonly WarLoopEnd: "warLoopEnd";
+    readonly NewSeasonStart: "newSeasonStart";
     readonly MaintenanceStart: "maintenanceStart";
     readonly MaintenanceEnd: "maintenanceEnd";
     readonly Error: "error";
     readonly Debug: "debug";
 };
+export declare const ClientEvents: {
+    readonly Error: "error";
+    readonly Debug: "debug";
+};
+export declare const RestEvents: {
+    readonly Error: "error";
+    readonly Debug: "debug";
+    readonly RateLimited: "rateLimited";
+};
 export declare const CWLRounds: {
     readonly PreviousRound: "warEnded";
     readonly CurrentRound: "inWar";
     readonly NextRound: "preparation";
 };
 export declare const RawData: {
-    RawUnits: {
+    RawUnits: ({
+        id: number;
+        name: string;
+        housingSpace: number;
+        village: string;
+        category: string;
+        subCategory: string;
+        unlock: {
+            hall: number;
+            cost: number;
+            time: number;
+            resource: string;
+            building: string;
+            buildingLevel: number;
+        };
+        trainingTime: number;
+        regenerationTimes: number[];
+        dps: number[];
+        upgrade: {
+            cost: number[];
+            time: number[];
+            resource: string;
+        };
+        seasonal: boolean;
+        levels: number[];
+        resourceType?: undefined;
+    } | {
         id: number;
         name: string;
         housingSpace: number;
@@ -68,7 +103,7 @@ export declare const RawData: {
         };
         seasonal: boolean;
         levels: number[];
-    }[];
+    })[];
     RawSuperUnits: {
         name: string;
         id: number;

package/dist/util/Constants.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RawData = exports.CWLRounds = exports.PollingEvents = exports.FriendlyWarPreparationTimes = exports.WarLeagues = exports.Leagues = exports.LegendLeagueId = exports.UnrankedLeagueData = exports.HeroPets = exports.Heroes = exports.BuilderTroops = exports.Spells = exports.DarkElixirSpells = exports.ElixirSpells = exports.SuperTroops = exports.SiegeMachines = exports.HomeTroops = exports.DarkElixirTroops = exports.ElixirTroops = exports.DevSiteAPIBaseURL = exports.APIBaseURL = void 0;
+exports.RawData = exports.CWLRounds = exports.RestEvents = exports.ClientEvents = exports.PollingEvents = exports.FriendlyWarPreparationTimes = exports.WarLeagues = exports.Leagues = exports.LegendLeagueId = exports.UnrankedLeagueData = exports.HeroPets = exports.Heroes = exports.BuilderTroops = exports.Spells = exports.DarkElixirSpells = exports.ElixirSpells = exports.SuperTroops = exports.SiegeMachines = exports.HomeTroops = exports.DarkElixirTroops = exports.ElixirTroops = exports.DevSiteAPIBaseURL = exports.APIBaseURL = void 0;
 const raw_json_1 = __importDefault(require("../util/raw.json"));
 exports.APIBaseURL = 'https://api.clashofclans.com/v1';
 exports.DevSiteAPIBaseURL = 'https://developer.clashofclans.com/api';
@@ -122,18 +122,27 @@ exports.FriendlyWarPreparationTimes = [
     1000 * 60 * 5
 ];
 exports.PollingEvents = {
-    NewSeasonStart: 'newSeasonStart',
     ClanLoopStart: 'clanLoopStart',
     ClanLoopEnd: 'clanLoopEnd',
     PlayerLoopStart: 'playerLoopStart',
     PlayerLoopEnd: 'playerLoopEnd',
     WarLoopStart: 'warLoopEnd',
     WarLoopEnd: 'warLoopEnd',
+    NewSeasonStart: 'newSeasonStart',
     MaintenanceStart: 'maintenanceStart',
     MaintenanceEnd: 'maintenanceEnd',
     Error: 'error',
     Debug: 'debug'
 };
+exports.ClientEvents = {
+    Error: 'error',
+    Debug: 'debug'
+};
+exports.RestEvents = {
+    Error: 'error',
+    Debug: 'debug',
+    RateLimited: 'rateLimited'
+};
 exports.CWLRounds = {
     PreviousRound: 'warEnded',
     CurrentRound: 'inWar',

package/dist/util/Util.js

@@ -114,8 +114,8 @@ class Util extends null {
     }
     /** Parse in-game army link into troops and spells count with respective Id's. */
     static parseArmyLink(link) {
-        const unitsMatches = link.match(/u(?<units>[\d+x-]+)/);
-        const spellsMatches = link.match(/s(?<spells>[\d+x-]+)/);
+        const unitsMatches = /u(?<units>[\d+x-]+)/.exec(link);
+        const spellsMatches = /s(?<spells>[\d+x-]+)/.exec(link);
         const unitsPart = unitsMatches?.groups?.unit?.split('-') ?? [];
         const spellParts = spellsMatches?.groups?.spells?.split('-') ?? [];
         const units = unitsPart