clashofclans.js 2.3.0-dev.b07e37b → 2.4.0-dev.cedc2ac

package/CHANGELOG.md

@@ -2,6 +2,19 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## 2.4.0 (2021-12-28)
+
+### Features
+
+-   `ClanWar#getClanWarLeagueGroup`, `ClanWar#isCWL` and `ClanWar#isFriendly` are now available. ([#87](https://github.com/clashperk/clashofclans.js/pull/87))
+-   `RESTOptions#rejectIfNotValid` added to perform `res.ok` operations over `RESTManager` methods. [Know more?](https://clashofclans.js.org/guide/access-raw-data#easy-access) ([#87](https://github.com/clashperk/clashofclans.js/pull/87))
+-   `Icon#fileName` and `Icon#sizes` are now available in `Icon` class. ([#87](https://github.com/clashperk/clashofclans.js/pull/87))
+-   `Badge#fileName` and `Badge#sizes` are now available in `Badge` class. ([#87](https://github.com/clashperk/clashofclans.js/pull/87))
+
+### Deprecations
+
+-   `ClanWarMember#previousBestOpponentAttack` has been deprecated. Use `ClanWarAttack#previousBestAttack` instead. ([#87](https://github.com/clashperk/clashofclans.js/pull/87))
+
 ## 2.3.0 (2021-12-17)
 
 ### Features

package/LICENSE

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

package/dist/client/Client.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { ClanSearchOptions, SearchOptions, ClientOptions, InitOptions, OverrideOptions } from '../rest/RequestHandler';
+import { ClanSearchOptions, SearchOptions, ClientOptions, LoginOptions, OverrideOptions } from '../types';
 import { EVENTS, CWL_ROUNDS } from '../util/Constants';
 import { RESTManager } from '../rest/RESTManager';
 import { EventManager } from './EventManager';
@@ -31,7 +31,7 @@ export declare class Client extends EventEmitter {
      * client.login({ email: 'developer@email.com', password: '***' });
      * ```
      */
-    login(options: InitOptions): Promise<string[]>;
+    login(options: LoginOptions): Promise<string[]>;
     /** Set Clash of Clans API keys. */
     setKeys(keys: string[]): this;
     /** Search all clans by name and/or filtering the results using various criteria. */

package/dist/rest/RESTManager.d.ts

@@ -1,56 +1,56 @@
-import { RequestHandler, SearchOptions, ClanSearchOptions, RESTOptions, OverrideOptions } from './RequestHandler';
-import { APIClan, APIClanList, APIClanMemberList, APIClanRankingList, APIClanVersusRankingList, APIClanWar, APIClanWarLeagueGroup, APIClanWarLog, APIGoldPassSeason, APILabelList, APILeague, APILeagueList, APILeagueSeasonList, APILocation, APILocationList, APIPlayer, APIPlayerRankingList, APIPlayerSeasonRankingList, APIPlayerVersusRankingList, APIVerifyToken, APIWarLeague, APIWarLeagueList } from '../types';
+import { RequestHandler } from './RequestHandler';
+import { APIClan, APIClanList, APIClanMemberList, APIClanRankingList, APIClanVersusRankingList, APIClanWar, APIClanWarLeagueGroup, APIClanWarLog, APIGoldPassSeason, APILabelList, APILeague, APILeagueList, APILeagueSeasonList, APILocation, APILocationList, APIPlayer, APIPlayerRankingList, APIPlayerSeasonRankingList, APIPlayerVersusRankingList, APIVerifyToken, APIWarLeague, APIWarLeagueList, SearchOptions, ClanSearchOptions, RESTOptions, OverrideOptions } from '../types';
 /** Represents a REST Manager of the client. */
 export declare class RESTManager {
     /** Request Handler for the RESTManager. */
     readonly handler: RequestHandler;
     constructor(options?: RESTOptions);
     /** Search all clans by name and/or filtering the results using various criteria. */
-    getClans(query: ClanSearchOptions, options?: OverrideOptions): Promise<import("./RequestHandler").Response<APIClanList>>;
+    getClans(query: ClanSearchOptions, options?: OverrideOptions): Promise<import("../types").Response<APIClanList>>;
     /** Get info about a clan. */
-    getClan(clanTag: string, options?: OverrideOptions): Promise<import("./RequestHandler").Response<APIClan>>;
+    getClan(clanTag: string, options?: OverrideOptions): Promise<import("../types").Response<APIClan>>;
     /** Get list of clan members. */
-    getClanMembers(clanTag: string, options?: SearchOptions): Promise<import("./RequestHandler").Response<APIClanMemberList>>;
+    getClanMembers(clanTag: string, options?: SearchOptions): Promise<import("../types").Response<APIClanMemberList>>;
     /** Get clan war log. */
-    getClanWarLog(clanTag: string, options?: SearchOptions): Promise<import("./RequestHandler").Response<APIClanWarLog>>;
+    getClanWarLog(clanTag: string, options?: SearchOptions): Promise<import("../types").Response<APIClanWarLog>>;
     /** Get info about currently running war in the clan. */
-    getCurrentWar(clanTag: string, options?: OverrideOptions): Promise<import("./RequestHandler").Response<APIClanWar>>;
+    getCurrentWar(clanTag: string, options?: OverrideOptions): Promise<import("../types").Response<APIClanWar>>;
     /** Get info about clan war league. */
-    getClanWarLeagueGroup(clanTag: string, options?: OverrideOptions): Promise<import("./RequestHandler").Response<APIClanWarLeagueGroup>>;
+    getClanWarLeagueGroup(clanTag: string, options?: OverrideOptions): Promise<import("../types").Response<APIClanWarLeagueGroup>>;
     /** Get info about a CWL round by WarTag. */
-    getClanWarLeagueRound(warTag: string, options?: OverrideOptions): Promise<import("./RequestHandler").Response<APIClanWar>>;
+    getClanWarLeagueRound(warTag: string, options?: OverrideOptions): Promise<import("../types").Response<APIClanWar>>;
     /** Get info about a player by tag. */
-    getPlayer(playerTag: string, options?: OverrideOptions): Promise<import("./RequestHandler").Response<APIPlayer>>;
+    getPlayer(playerTag: string, options?: OverrideOptions): Promise<import("../types").Response<APIPlayer>>;
     /** Verify Player API token that can be found from the Game settings. */
-    verifyPlayerToken(playerTag: string, token: string, options?: OverrideOptions): Promise<import("./RequestHandler").Response<APIVerifyToken>>;
+    verifyPlayerToken(playerTag: string, token: string, options?: OverrideOptions): Promise<import("../types").Response<APIVerifyToken>>;
     /** Get list of Leagues. */
-    getLeagues(options?: SearchOptions): Promise<import("./RequestHandler").Response<APILeagueList>>;
+    getLeagues(options?: SearchOptions): Promise<import("../types").Response<APILeagueList>>;
     /** Get a League info. */
-    getLeague(leagueId: string | number, options?: OverrideOptions): Promise<import("./RequestHandler").Response<APILeague>>;
+    getLeague(leagueId: string | number, options?: OverrideOptions): Promise<import("../types").Response<APILeague>>;
     /** Get Legend League season Ids. */
-    getLeagueSeasons(leagueId: number, options?: SearchOptions): Promise<import("./RequestHandler").Response<APILeagueSeasonList>>;
+    getLeagueSeasons(leagueId: number, options?: SearchOptions): Promise<import("../types").Response<APILeagueSeasonList>>;
     /** Get Legend League season rankings by season Id. */
-    getSeasonRankings(leagueId: number, seasonId: string, options?: SearchOptions): Promise<import("./RequestHandler").Response<APIPlayerSeasonRankingList>>;
+    getSeasonRankings(leagueId: number, seasonId: string, options?: SearchOptions): Promise<import("../types").Response<APIPlayerSeasonRankingList>>;
     /** Get list of Clan War Leagues. */
-    getWarLeagues(options?: SearchOptions): Promise<import("./RequestHandler").Response<APIWarLeagueList>>;
+    getWarLeagues(options?: SearchOptions): Promise<import("../types").Response<APIWarLeagueList>>;
     /** Get info about a Clan War League. */
-    getWarLeague(leagueId: number, options?: OverrideOptions): Promise<import("./RequestHandler").Response<APIWarLeague>>;
+    getWarLeague(leagueId: number, options?: OverrideOptions): Promise<import("../types").Response<APIWarLeague>>;
     /** Get list of Locations. */
-    getLocations(options?: SearchOptions): Promise<import("./RequestHandler").Response<APILocationList>>;
+    getLocations(options?: SearchOptions): Promise<import("../types").Response<APILocationList>>;
     /** Get info about a Location. */
-    getLocation(locationId: number, options?: OverrideOptions): Promise<import("./RequestHandler").Response<APILocation>>;
+    getLocation(locationId: number, options?: OverrideOptions): Promise<import("../types").Response<APILocation>>;
     /** Get clan rankings for a specific location. */
-    getClanRanks(locationId: number | string, options?: SearchOptions): Promise<import("./RequestHandler").Response<APIClanRankingList>>;
+    getClanRanks(locationId: number | string, options?: SearchOptions): Promise<import("../types").Response<APIClanRankingList>>;
     /** Get player rankings for a specific location. */
-    getPlayerRanks(locationId: number | string, options?: SearchOptions): Promise<import("./RequestHandler").Response<APIPlayerRankingList>>;
+    getPlayerRanks(locationId: number | string, options?: SearchOptions): Promise<import("../types").Response<APIPlayerRankingList>>;
     /** Get clan versus rankings for a specific location. */
-    getVersusClanRanks(locationId: number | string, options?: SearchOptions): Promise<import("./RequestHandler").Response<APIClanVersusRankingList>>;
+    getVersusClanRanks(locationId: number | string, options?: SearchOptions): Promise<import("../types").Response<APIClanVersusRankingList>>;
     /** Get player versus rankings for a specific location. */
-    getVersusPlayerRanks(locationId: number | string, options?: SearchOptions): Promise<import("./RequestHandler").Response<APIPlayerVersusRankingList>>;
+    getVersusPlayerRanks(locationId: number | string, options?: SearchOptions): Promise<import("../types").Response<APIPlayerVersusRankingList>>;
     /** Get list of clan labels. */
-    getClanLabels(options?: SearchOptions): Promise<import("./RequestHandler").Response<APILabelList>>;
+    getClanLabels(options?: SearchOptions): Promise<import("../types").Response<APILabelList>>;
     /** Get list of player labels. */
-    getPlayerLabels(options?: SearchOptions): Promise<import("./RequestHandler").Response<APILabelList>>;
+    getPlayerLabels(options?: SearchOptions): Promise<import("../types").Response<APILabelList>>;
     /** Get info about gold pass season. */
-    getGoldPassSeason(options?: OverrideOptions): Promise<import("./RequestHandler").Response<APIGoldPassSeason>>;
+    getGoldPassSeason(options?: OverrideOptions): Promise<import("../types").Response<APIGoldPassSeason>>;
 }

package/dist/rest/RequestHandler.d.ts

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

package/dist/struct/Clan.d.ts

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

package/dist/struct/ClanMember.d.ts

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

package/dist/struct/ClanWarLeagueGroup.d.ts

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

package/dist/struct/ClanWarLog.d.ts

@@ -4,10 +4,8 @@ import { Badge } from './Badge';
 /**
  * Represents War Log Clan.
  *
- * :::caution
  * If this is called via {@link ClanWarLog.opponent}, then {@link WarLogClan.attackCount} and {@link WarLogClan.expEarned} will be `null`.
  * For CWL entries {@link WarLogClan.name} and {@link WarLogClan.tag} are `null`.
- * :::
  */
 export declare class WarLogClan {
     /** The clan's name. This property is `null` CWL entries. */

package/dist/struct/ClanWarLog.js

@@ -6,10 +6,8 @@ const Badge_1 = require("./Badge");
 /**
  * Represents War Log Clan.
  *
- * :::caution
  * If this is called via {@link ClanWarLog.opponent}, then {@link WarLogClan.attackCount} and {@link WarLogClan.expEarned} will be `null`.
  * For CWL entries {@link WarLogClan.name} and {@link WarLogClan.tag} are `null`.
- * :::
  */
 class WarLogClan {
     constructor(data) {

package/dist/struct/Player.d.ts

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

package/dist/struct/PlayerClan.d.ts

@@ -1,6 +1,5 @@
-import { OverrideOptions } from '../rest/RequestHandler';
+import { OverrideOptions, APIPlayerClan } from '../types';
 import { Client } from '../client/Client';
-import { APIPlayerClan } from '../types';
 import { Badge } from './Badge';
 /** Represents a Player's clan. */
 export declare class PlayerClan {

package/dist/types/api.d.ts

@@ -0,0 +1,351 @@
+export interface APIPaging {
+    cursors?: APICursors;
+}
+export interface APICursors {
+    after?: string;
+    before?: string;
+}
+export interface APIIcon {
+    small: string;
+    /** Tiny Icon is not available for Labels. */
+    tiny?: string;
+    /** Medium Icon is not available for Unranked Icon. */
+    medium?: string;
+}
+export interface APIBadge {
+    small: string;
+    large: string;
+    medium: string;
+}
+export interface APISeason {
+    id: string;
+    rank: number;
+    trophies: number;
+}
+/** /clans?name={name}&limit={limit} */
+export interface APIClanList {
+    items: Omit<APIClan, 'memberList'>[];
+    paging: APIPaging;
+}
+export interface APIChatLanguage {
+    name: string;
+    id: number;
+    languageCode: string;
+}
+/** /clans/{clanTag} */
+export interface APIClan {
+    tag: string;
+    name: string;
+    type: 'open' | 'inviteOnly' | 'closed';
+    description: string;
+    location?: APILocation;
+    chatLanguage?: APIChatLanguage;
+    badgeUrls: APIBadge;
+    clanLevel: number;
+    clanPoints: number;
+    clanVersusPoints: number;
+    requiredTrophies: number;
+    requiredTownhallLevel?: number;
+    warFrequency: 'always' | 'moreThanOncePerWeek' | 'oncePerWeek' | 'lessThanOncePerWeek' | 'never' | 'unknown';
+    warWinStreak: number;
+    warWins: number;
+    warTies?: number;
+    warLosses?: number;
+    isWarLogPublic: boolean;
+    warLeague?: APIWarLeague;
+    members: number;
+    labels: APILabel[];
+    memberList: APIClanMember[];
+}
+export interface APIClanMember {
+    name: string;
+    tag: string;
+    role: 'member' | 'admin' | 'coLeader' | 'leader';
+    expLevel: number;
+    league: APILeague;
+    trophies: number;
+    versusTrophies?: number;
+    clanRank: number;
+    previousClanRank: number;
+    donations: number;
+    donationsReceived: number;
+}
+/** /clans/{clanTag}/members */
+export interface APIClanMemberList {
+    items: APIClanMember[];
+    paging: APIPaging;
+}
+/** /clans/{clanTag}/currentwar and /clanwarleagues/wars/{warTag} */
+export interface APIClanWar {
+    state: 'notInWar' | 'preparation' | 'inWar' | 'warEnded';
+    teamSize: number;
+    startTime: string;
+    preparationStartTime: string;
+    endTime: string;
+    clan: APIWarClan;
+    opponent: APIWarClan;
+    /** This property is not available for CWL */
+    attacksPerMember?: number;
+}
+export interface APIWarClan {
+    tag: string;
+    name: string;
+    badgeUrls: APIBadge;
+    clanLevel: number;
+    attacks: number;
+    stars: number;
+    destructionPercentage: number;
+    members: APIClanWarMember[];
+}
+export interface APIClanWarMember {
+    tag: string;
+    name: string;
+    mapPosition: number;
+    townhallLevel: number;
+    opponentAttacks: number;
+    bestOpponentAttack?: APIClanWarAttack;
+    attacks?: APIClanWarAttack[];
+}
+export interface APIClanWarAttack {
+    order: number;
+    attackerTag: string;
+    defenderTag: string;
+    stars: number;
+    duration: number;
+    destructionPercentage: number;
+}
+export interface APIWarLogClan {
+    tag?: string;
+    name?: string;
+    badgeUrls: APIBadge;
+    clanLevel: number;
+    attacks?: number;
+    stars: number;
+    destructionPercentage: number;
+    expEarned?: number;
+}
+export interface APIClanWarLogEntry {
+    result: 'win' | 'lose' | 'tie' | null;
+    endTime: string;
+    teamSize: number;
+    attacksPerMember?: number;
+    clan: APIWarLogClan;
+    opponent: APIWarLogClan;
+}
+/** /clans/{clanTag}/warlog */
+export interface APIClanWarLog {
+    items: APIClanWarLogEntry[];
+    paging: APIPaging;
+}
+/** /clans/{clanTag}/currentwar/leaguegroup */
+export interface APIClanWarLeagueGroup {
+    state: 'preparation' | 'inWar' | 'warEnded';
+    season: string;
+    clans: APIClanWarLeagueClan[];
+    rounds: APIClanWarLeagueRound[];
+}
+export interface APIClanWarLeagueClan {
+    name: string;
+    tag: string;
+    clanLevel: number;
+    badgeUrls: APIBadge;
+    members: APIClanWarLeagueClanMember[];
+}
+export interface APIClanWarLeagueClanMember {
+    name: string;
+    tag: string;
+    townHallLevel: number;
+}
+export interface APIClanWarLeagueRound {
+    warTags: string[];
+}
+/** /players/{playerTag} */
+export interface APIPlayer {
+    name: string;
+    tag: string;
+    townHallLevel: number;
+    townHallWeaponLevel?: number;
+    expLevel: number;
+    trophies: number;
+    bestTrophies: number;
+    warStars: number;
+    attackWins: number;
+    defenseWins: number;
+    builderHallLevel?: number;
+    versusTrophies?: number;
+    bestVersusTrophies?: number;
+    versusBattleWins?: number;
+    donations: number;
+    donationsReceived: number;
+    role?: string;
+    warPreference?: 'in' | 'out';
+    clan?: APIPlayerClan;
+    league?: APILeague;
+    legendStatistics?: APILegendStatistics;
+    achievements: APIPlayerAchievement[];
+    troops: APIPlayerItem[];
+    heroes: APIPlayerItem[];
+    spells: APIPlayerItem[];
+    labels: APILabel[];
+}
+export interface APILegendStatistics {
+    previousSeason?: APISeason;
+    previousVersusSeason?: APISeason;
+    bestVersusSeason?: APISeason;
+    currentSeason?: APISeason;
+    bestSeason?: APISeason;
+    legendTrophies: number;
+}
+export interface APIPlayerClan {
+    tag: string;
+    name: string;
+    clanLevel: number;
+    badgeUrls: APIBadge;
+}
+export interface APIPlayerAchievement {
+    name: string;
+    stars: number;
+    value: number;
+    target: number;
+    info: string;
+    completionInfo: string | null;
+    village: 'home' | 'builderBase';
+}
+export interface APIPlayerItem {
+    name: string;
+    level: number;
+    maxLevel: number;
+    superTroopIsActive?: boolean;
+    village: 'home' | 'builderBase';
+}
+/** /players/{playerTag}/verifytoken */
+export interface APIVerifyToken {
+    tag: string;
+    token: string;
+    status: 'ok' | 'invalid';
+}
+/** /locations */
+export interface APILocationList {
+    items: APILocation[];
+    paging: APIPaging;
+}
+/** /locations/{locationId} */
+export interface APILocation {
+    localizedName?: string;
+    id: number;
+    name: string;
+    isCountry: boolean;
+    countryCode?: string;
+}
+/** /locations/{locationId}/rankings/clans */
+export interface APIClanRankingList {
+    items: APIClanRanking[];
+    paging: APIPaging;
+}
+export interface APIClanRanking {
+    clanLevel: number;
+    clanPoints: number;
+    location: APILocation;
+    members: number;
+    tag: string;
+    name: string;
+    rank: number;
+    previousRank: number;
+    badgeUrls: APIBadge;
+}
+/** /locations/{locationId}/rankings/players */
+export interface APIPlayerRankingList {
+    items: APIPlayerRanking[];
+    paging: APIPaging;
+}
+export interface APIPlayerRanking {
+    tag: string;
+    name: string;
+    expLevel: number;
+    trophies: number;
+    attackWins: number;
+    defenseWins: number;
+    rank: number;
+    previousRank: number;
+    clan?: Omit<APIPlayerClan, 'clanLevel'>;
+    league: APILeague;
+}
+/** /locations/{locationId}/rankings/clans-versus */
+export interface APIClanVersusRankingList {
+    items: APIClanVersusRanking[];
+    paging: APIPaging;
+}
+export interface APIClanVersusRanking {
+    clanLevel: number;
+    location: APILocation;
+    members: number;
+    tag: string;
+    name: string;
+    rank: number;
+    previousRank: number;
+    badgeUrls: APIBadge;
+    clanVersusPoints: number;
+}
+/** /locations/{locationId}/rankings/players-versus */
+export interface APIPlayerVersusRankingList {
+    items: APIPlayerVersusRanking[];
+    paging: APIPaging;
+}
+export interface APIPlayerVersusRanking {
+    tag: string;
+    name: string;
+    expLevel: number;
+    versusTrophies: number;
+    versusBattleWins: number;
+    rank: number;
+    previousRank: number;
+    clan?: APIPlayerClan;
+}
+/** /leagues */
+export interface APILeagueList {
+    items: APILeague[];
+    paging: APIPaging;
+}
+/** /leagues/{leagueId} */
+export interface APILeague {
+    id: number;
+    name: string;
+    iconUrls: APIIcon;
+}
+/** /leagues/{leagueId}/seasons/{seasonId} */
+export interface APIPlayerSeasonRankingList {
+    items: Omit<APIPlayerRanking, 'league'>[];
+    paging: APIPaging;
+}
+/** /leagues/{leagueId}/seasons */
+export interface APILeagueSeasonList {
+    items: {
+        id: string;
+    }[];
+    paging: APIPaging;
+}
+/** /warleagues */
+export interface APIWarLeagueList {
+    items: APIWarLeague[];
+    paging: APIPaging;
+}
+/** /warleagues/{leagueId} */
+export interface APIWarLeague {
+    id: number;
+    name: string;
+}
+export interface APILabel {
+    id: number;
+    name: string;
+    iconUrls: APIIcon;
+}
+/** /labels/clans and /labels/players */
+export interface APILabelList {
+    items: APILabel[];
+    paging: APIPaging;
+}
+/** /goldpass/seasons/current */
+export interface APIGoldPassSeason {
+    startTime: string;
+    endTime: string;
+}

package/dist/types/api.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/index.d.ts

@@ -1,351 +1,2 @@
-export interface APIPaging {
-    cursors?: APICursors;
-}
-export interface APICursors {
-    after?: string;
-    before?: string;
-}
-export interface APIIcon {
-    small: string;
-    /** Tiny Icon is not available for Labels. */
-    tiny?: string;
-    /** Medium Icon is not available for Unranked Icon. */
-    medium?: string;
-}
-export interface APIBadge {
-    small: string;
-    large: string;
-    medium: string;
-}
-export interface APISeason {
-    id: string;
-    rank: number;
-    trophies: number;
-}
-/** /clans?name={name}&limit={limit} */
-export interface APIClanList {
-    items: Omit<APIClan, 'memberList'>[];
-    paging: APIPaging;
-}
-export interface APIChatLanguage {
-    name: string;
-    id: number;
-    languageCode: string;
-}
-/** /clans/{clanTag} */
-export interface APIClan {
-    tag: string;
-    name: string;
-    type: 'open' | 'inviteOnly' | 'closed';
-    description: string;
-    location?: APILocation;
-    chatLanguage?: APIChatLanguage;
-    badgeUrls: APIBadge;
-    clanLevel: number;
-    clanPoints: number;
-    clanVersusPoints: number;
-    requiredTrophies: number;
-    requiredTownhallLevel?: number;
-    warFrequency: 'always' | 'moreThanOncePerWeek' | 'oncePerWeek' | 'lessThanOncePerWeek' | 'never' | 'unknown';
-    warWinStreak: number;
-    warWins: number;
-    warTies?: number;
-    warLosses?: number;
-    isWarLogPublic: boolean;
-    warLeague?: APIWarLeague;
-    members: number;
-    labels: APILabel[];
-    memberList: APIClanMember[];
-}
-export interface APIClanMember {
-    name: string;
-    tag: string;
-    role: 'member' | 'admin' | 'coLeader' | 'leader';
-    expLevel: number;
-    league: APILeague;
-    trophies: number;
-    versusTrophies?: number;
-    clanRank: number;
-    previousClanRank: number;
-    donations: number;
-    donationsReceived: number;
-}
-/** /clans/{clanTag}/members */
-export interface APIClanMemberList {
-    items: APIClanMember[];
-    paging: APIPaging;
-}
-/** /clans/{clanTag}/currentwar and /clanwarleagues/wars/{warTag} */
-export interface APIClanWar {
-    state: 'notInWar' | 'preparation' | 'inWar' | 'warEnded';
-    teamSize: number;
-    startTime: string;
-    preparationStartTime: string;
-    endTime: string;
-    clan: APIWarClan;
-    opponent: APIWarClan;
-    /** This property is not available for CWL */
-    attacksPerMember?: number;
-}
-export interface APIWarClan {
-    tag: string;
-    name: string;
-    badgeUrls: APIBadge;
-    clanLevel: number;
-    attacks: number;
-    stars: number;
-    destructionPercentage: number;
-    members: APIClanWarMember[];
-}
-export interface APIClanWarMember {
-    tag: string;
-    name: string;
-    mapPosition: number;
-    townhallLevel: number;
-    opponentAttacks: number;
-    bestOpponentAttack?: APIClanWarAttack;
-    attacks?: APIClanWarAttack[];
-}
-export interface APIClanWarAttack {
-    order: number;
-    attackerTag: string;
-    defenderTag: string;
-    stars: number;
-    duration: number;
-    destructionPercentage: number;
-}
-export interface APIWarLogClan {
-    tag?: string;
-    name?: string;
-    badgeUrls: APIBadge;
-    clanLevel: number;
-    attacks?: number;
-    stars: number;
-    destructionPercentage: number;
-    expEarned?: number;
-}
-export interface APIClanWarLogEntry {
-    result: 'win' | 'lose' | 'tie' | null;
-    endTime: string;
-    teamSize: number;
-    attacksPerMember?: number;
-    clan: APIWarLogClan;
-    opponent: APIWarLogClan;
-}
-/** /clans/{clanTag}/warlog */
-export interface APIClanWarLog {
-    items: APIClanWarLogEntry[];
-    paging: APIPaging;
-}
-/** /clans/{clanTag}/currentwar/leaguegroup */
-export interface APIClanWarLeagueGroup {
-    state: 'preparation' | 'inWar' | 'warEnded';
-    season: string;
-    clans: APIClanWarLeagueClan[];
-    rounds: APIClanWarLeagueRound[];
-}
-export interface APIClanWarLeagueClan {
-    name: string;
-    tag: string;
-    clanLevel: number;
-    badgeUrls: APIBadge;
-    members: APIClanWarLeagueClanMember[];
-}
-export interface APIClanWarLeagueClanMember {
-    name: string;
-    tag: string;
-    townHallLevel: number;
-}
-export interface APIClanWarLeagueRound {
-    warTags: string[];
-}
-/** /players/{playerTag} */
-export interface APIPlayer {
-    name: string;
-    tag: string;
-    townHallLevel: number;
-    townHallWeaponLevel?: number;
-    expLevel: number;
-    trophies: number;
-    bestTrophies: number;
-    warStars: number;
-    attackWins: number;
-    defenseWins: number;
-    builderHallLevel?: number;
-    versusTrophies?: number;
-    bestVersusTrophies?: number;
-    versusBattleWins?: number;
-    donations: number;
-    donationsReceived: number;
-    role?: string;
-    warPreference?: 'in' | 'out';
-    clan?: APIPlayerClan;
-    league?: APILeague;
-    legendStatistics?: APILegendStatistics;
-    achievements: APIPlayerAchievement[];
-    troops: APIPlayerItem[];
-    heroes: APIPlayerItem[];
-    spells: APIPlayerItem[];
-    labels: APILabel[];
-}
-export interface APILegendStatistics {
-    previousSeason?: APISeason;
-    previousVersusSeason?: APISeason;
-    bestVersusSeason?: APISeason;
-    currentSeason?: APISeason;
-    bestSeason?: APISeason;
-    legendTrophies: number;
-}
-export interface APIPlayerClan {
-    tag: string;
-    name: string;
-    clanLevel: number;
-    badgeUrls: APIBadge;
-}
-export interface APIPlayerAchievement {
-    name: string;
-    stars: number;
-    value: number;
-    target: number;
-    info: string;
-    completionInfo: string | null;
-    village: 'home' | 'builderBase';
-}
-export interface APIPlayerItem {
-    name: string;
-    level: number;
-    maxLevel: number;
-    superTroopIsActive?: boolean;
-    village: 'home' | 'builderBase';
-}
-/** /players/{playerTag}/verifytoken */
-export interface APIVerifyToken {
-    tag: string;
-    token: string;
-    status: 'ok' | 'invalid';
-}
-/** /locations */
-export interface APILocationList {
-    items: APILocation[];
-    paging: APIPaging;
-}
-/** /locations/{locationId} */
-export interface APILocation {
-    localizedName?: string;
-    id: number;
-    name: string;
-    isCountry: boolean;
-    countryCode?: string;
-}
-/** /locations/{locationId}/rankings/clans */
-export interface APIClanRankingList {
-    items: APIClanRanking[];
-    paging: APIPaging;
-}
-export interface APIClanRanking {
-    clanLevel: number;
-    clanPoints: number;
-    location: APILocation;
-    members: number;
-    tag: string;
-    name: string;
-    rank: number;
-    previousRank: number;
-    badgeUrls: APIBadge;
-}
-/** /locations/{locationId}/rankings/players */
-export interface APIPlayerRankingList {
-    items: APIPlayerRanking[];
-    paging: APIPaging;
-}
-export interface APIPlayerRanking {
-    tag: string;
-    name: string;
-    expLevel: number;
-    trophies: number;
-    attackWins: number;
-    defenseWins: number;
-    rank: number;
-    previousRank: number;
-    clan?: Omit<APIPlayerClan, 'clanLevel'>;
-    league: APILeague;
-}
-/** /locations/{locationId}/rankings/clans-versus */
-export interface APIClanVersusRankingList {
-    items: APIClanVersusRanking[];
-    paging: APIPaging;
-}
-export interface APIClanVersusRanking {
-    clanLevel: number;
-    location: APILocation;
-    members: number;
-    tag: string;
-    name: string;
-    rank: number;
-    previousRank: number;
-    badgeUrls: APIBadge;
-    clanVersusPoints: number;
-}
-/** /locations/{locationId}/rankings/players-versus */
-export interface APIPlayerVersusRankingList {
-    items: APIPlayerVersusRanking[];
-    paging: APIPaging;
-}
-export interface APIPlayerVersusRanking {
-    tag: string;
-    name: string;
-    expLevel: number;
-    versusTrophies: number;
-    versusBattleWins: number;
-    rank: number;
-    previousRank: number;
-    clan?: APIPlayerClan;
-}
-/** /leagues */
-export interface APILeagueList {
-    items: APILeague[];
-    paging: APIPaging;
-}
-/** /leagues/{leagueId} */
-export interface APILeague {
-    id: number;
-    name: string;
-    iconUrls: APIIcon;
-}
-/** /leagues/{leagueId}/seasons/{seasonId} */
-export interface APIPlayerSeasonRankingList {
-    items: Omit<APIPlayerRanking, 'league'>[];
-    paging: APIPaging;
-}
-/** /leagues/{leagueId}/seasons */
-export interface APILeagueSeasonList {
-    items: {
-        id: string;
-    }[];
-    paging: APIPaging;
-}
-/** /warleagues */
-export interface APIWarLeagueList {
-    items: APIWarLeague[];
-    paging: APIPaging;
-}
-/** /warleagues/{leagueId} */
-export interface APIWarLeague {
-    id: number;
-    name: string;
-}
-export interface APILabel {
-    id: number;
-    name: string;
-    iconUrls: APIIcon;
-}
-/** /labels/clans and /labels/players */
-export interface APILabelList {
-    items: APILabel[];
-    paging: APIPaging;
-}
-/** /goldpass/seasons/current */
-export interface APIGoldPassSeason {
-    startTime: string;
-    endTime: string;
-}
+export * from './api';
+export * from './lib';

package/dist/types/index.js

@@ -1,2 +1,14 @@
 "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]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./api"), exports);
+__exportStar(require("./lib"), exports);

package/dist/types/lib.d.ts

@@ -0,0 +1,139 @@
+import { QueueThrottler, BatchThrottler } from '../rest/Throttler';
+import Keyv from 'keyv';
+/** Options for a Client. */
+export interface ClientOptions {
+    /** Keys from Clash of Clans API developer site. */
+    keys?: string[];
+    /** Base URL of the Clash of Clans API. */
+    baseURL?: string;
+    /**
+     * How many times to retry on 5XX errors.
+     */
+    retryLimit?: number;
+    /**
+     * Whether enable or disable internal caching.
+     * @example
+     * ```ts
+     * const client = new Client({ cache: true });
+     * ```
+     */
+    cache?: boolean | Keyv;
+    /** Time to wait before cancelling a REST request, in milliseconds. */
+    restRequestTimeout?: number;
+    /**
+     * Throttler class which handles rate-limit
+     * @example
+     * ```ts
+     * const client = new Client({ throttler: new QueueThrottler(1000 / 10) });
+     * ```
+     * @example
+     * ```ts
+     * const client = new Client({ throttler: new BatchThrottler(30) });
+     * ```
+     */
+    throttler?: QueueThrottler | BatchThrottler;
+}
+/** Options for a RESTManager. */
+export interface RESTOptions extends ClientOptions {
+    /** Set this `false` to use `res.ok` property. */
+    rejectIfNotValid?: boolean;
+}
+/** Search options for request. */
+export interface SearchOptions extends OverrideOptions {
+    /** Limit the number of items returned in the response. */
+    limit?: number;
+    /**
+     * Return only items that occur after this marker.
+     * Before marker can be found from the response, inside the 'paging' property.
+     * Note that only after or before can be specified for a request, not both.
+     */
+    after?: string;
+    /**
+     * Return only items that occur before this marker.
+     * Before marker can be found from the response, inside the 'paging' property.
+     * Note that only after or before can be specified for a request, not both.
+     */
+    before?: string;
+}
+/** Override options for a request. */
+export interface OverrideOptions {
+    /** Whether to cache this response. */
+    cache?: boolean;
+    /** Whether to skip the cache check and request the API. */
+    force?: boolean;
+    /** How many times to retry on 5XX errors. */
+    retryLimit?: string;
+    /** Whether to ignore throttlers. */
+    ignoreRateLimit?: boolean;
+    /** Time to wait before cancelling a REST request, in milliseconds. */
+    restRequestTimeout?: number;
+}
+export interface RequestOptions extends OverrideOptions {
+    /** The request body. */
+    body?: string;
+    /** The request method. */
+    method?: string;
+}
+export interface Response<T> {
+    /** Whether the response is ok. */
+    ok: boolean;
+    /** The response body. */
+    data: T;
+    /** Path of the request for this response. */
+    path: string;
+    /** HTTP status code of this response. */
+    status: number;
+    /** The maxAge of this response. */
+    maxAge: number;
+}
+/**
+ * Clan search options for a request.
+ *
+ * If name is used as part of search query, it needs to be at least three characters long.
+ * Name search parameter is interpreted as wild card search, so it may appear anywhere in the clan name.
+ */
+export interface ClanSearchOptions {
+    /** Search clans by name. */
+    name?: string;
+    /** Filter by minimum number of clan members. */
+    minMembers?: number;
+    /** Filter by maximum number of clan members. */
+    maxMembers?: number;
+    /** Filter by minimum amount of clan points. */
+    minClanPoints?: number;
+    /** Filter by minimum clan level. */
+    minClanLevel?: number;
+    /** Filter by clan war frequency. */
+    warFrequency?: string;
+    /** Filter by clan location identifier. For list of available locations, refer to getLocations operation. */
+    locationId?: string;
+    /** Comma separated list of label IDs to use for filtering results. */
+    labelIds?: string;
+    /** Limit the number of items returned in the response. */
+    limit?: number;
+    /**
+     * Return only items that occur after this marker.
+     * Before marker can be found from the response, inside the 'paging' property.
+     * Note that only after or before can be specified for a request, not both.
+     */
+    after?: string;
+    /**
+     * Return only items that occur before this marker.
+     * Before marker can be found from the response, inside the 'paging' property.
+     * Note that only after or before can be specified for a request, not both.
+     */
+    before?: string;
+}
+/** Login options for a client. */
+export interface LoginOptions {
+    /** Developer site email address. */
+    email: string;
+    /** Developer site password. */
+    password: string;
+    /** Name of API key(s). */
+    keyName?: string;
+    /** Number of allowed API keys. */
+    keyCount?: number;
+    /** Description of API key(s). */
+    keyDescription?: string;
+}

package/dist/types/lib.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "clashofclans.js",
-	"version": "2.3.0-dev.b07e37b",
+	"version": "2.4.0-dev.cedc2ac",
 	"description": "JavaScript library for interacting with the Clash of Clans API",
 	"author": "SUVAJIT <suvajit.me@gmail.com>",
 	"license": "MIT",