clashofclans.js 2.7.0 → 2.8.0-dev.11ea070

package/dist/struct/Unit.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Hero = exports.Spell = exports.Troop = exports.Unit = void 0;
-const raw_json_1 = require("../util/raw.json");
 const Constants_1 = require("../util/Constants");
 /** Represents a Player's Unit. */
 class Unit {
@@ -11,14 +10,14 @@ class Unit {
         this.level = unit.level;
         this.maxLevel = unit.maxLevel;
         this.village = unit.village;
-        const rawSuperUnit = raw_json_1.RAW_SUPER_UNITS.find((unit) => unit.name === this.name && this.isHomeBase);
-        const rawUnit = raw_json_1.RAW_UNITS.find((unit) => unit.name === this.name && unit.village === this.village);
+        const rawSuperUnit = Constants_1.RawData.RawSuperUnits.find((unit) => unit.name === this.name && this.isHomeBase);
+        const rawUnit = Constants_1.RawData.RawUnits.find((unit) => unit.name === this.name && unit.village === this.village);
         if (rawSuperUnit) {
             this.id = rawSuperUnit.id;
             this.housingSpace = rawSuperUnit.housingSpace;
             this.originalName = rawSuperUnit.original;
             this.minOriginalLevel = rawSuperUnit.minOriginalLevel;
-            const original = raw_json_1.RAW_UNITS.find((unit) => unit.village === 'home' && unit.name === rawSuperUnit.original);
+            const original = Constants_1.RawData.RawUnits.find((unit) => unit.village === 'home' && unit.name === rawSuperUnit.original);
             this.unlockHallLevel = original.levels.findIndex((level) => level >= rawSuperUnit.minOriginalLevel) + 1;
             this.unlockCost = original.unlock.cost;
             this.unlockTime = original.unlock.time;
@@ -88,7 +87,7 @@ class Troop extends Unit {
     }
     /** Whether this troop is a Super Troop. */
     get isSuperTroop() {
-        return this.isActive || (this.isHomeBase && Constants_1.SUPER_TROOPS.includes(this.name));
+        return this.isActive || (this.isHomeBase && Constants_1.SuperTroops.includes(this.name));
     }
 }
 exports.Troop = Troop;

package/dist/struct/WarLeague.js

@@ -10,7 +10,7 @@ class WarLeague {
     }
     /** Position of this War League. Starting from 0 (Unranked) */
     get position() {
-        return Constants_1.WAR_LEAGUES.indexOf(this.id);
+        return Constants_1.WarLeagues.indexOf(this.id);
     }
 }
 exports.WarLeague = WarLeague;

package/dist/types/api.d.ts

@@ -57,6 +57,7 @@ export interface APIClan {
     members: number;
     labels: APILabel[];
     memberList: APIClanMember[];
+    clanCapital: APIClanCapital;
 }
 export interface APIClanMember {
     name: string;
@@ -71,6 +72,14 @@ export interface APIClanMember {
     donations: number;
     donationsReceived: number;
 }
+export interface APIClanCapital {
+    capitalHallLevel?: number;
+    districts?: {
+        id: number;
+        name: string;
+        districtHallLevel: number;
+    }[];
+}
 /** /clans/{clanTag}/members */
 export interface APIClanMemberList {
     items: APIClanMember[];
@@ -179,6 +188,7 @@ export interface APIPlayer {
     versusBattleWinCount?: number;
     donations: number;
     donationsReceived: number;
+    clanCapitalContributions: number;
     role?: string;
     warPreference?: 'in' | 'out';
     clan?: APIPlayerClan;

package/dist/types/lib.d.ts

@@ -5,7 +5,7 @@ export interface Store<T = any> {
     delete(key: string): boolean | Promise<boolean>;
     clear(): void | Promise<void>;
 }
-/** Options for a Client. */
+/** Options for a {@link Client} */
 export interface ClientOptions {
     /** Keys from Clash of Clans API developer site. */
     keys?: string[];
@@ -36,13 +36,18 @@ export interface ClientOptions {
      * const client = new Client({ throttler: new BatchThrottler(30) });
      * ```
      */
-    throttler?: QueueThrottler | BatchThrottler;
+    throttler?: QueueThrottler | BatchThrottler | null;
 }
-/** Options for a RESTManager. */
+/** Options for a {@link RESTManager} */
 export interface RESTOptions extends ClientOptions {
     /** Set this `false` to use `res.ok` property. */
     rejectIfNotValid?: boolean;
 }
+/** Options for a {@link RequestHandler} */
+export interface RequestHandlerOptions 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. */

package/dist/util/Constants.d.ts

@@ -1,17 +1,17 @@
-export declare const API_BASE_URL = "https://api.clashofclans.com/v1";
-export declare const DEV_SITE_API_BASE_URL = "https://developer.clashofclans.com/api";
-export declare const ELIXIR_TROOPS: string[];
-export declare const DARK_ELIXIR_TROOPS: string[];
-export declare const HOME_TROOPS: string[];
-export declare const SIEGE_MACHINES: string[];
-export declare const SUPER_TROOPS: string[];
-export declare const ELIXIR_SPELLS: string[];
-export declare const DARK_ELIXIR_SPELLS: string[];
-export declare const SPELLS: string[];
-export declare const BUILDER_TROOPS: string[];
-export declare const HEROES: string[];
-export declare const HERO_PETS: string[];
-export declare const UNRANKED_LEAGUE_DATA: {
+export declare const APIBaseURL = "https://api.clashofclans.com/v1";
+export declare const DevSiteAPIBaseURL = "https://developer.clashofclans.com/api";
+export declare const ElixirTroops: string[];
+export declare const DarkElixirTroops: string[];
+export declare const HomeTroops: string[];
+export declare const SiegeMachines: string[];
+export declare const SuperTroops: string[];
+export declare const ElixirSpells: string[];
+export declare const DarkElixirSpells: string[];
+export declare const Spells: string[];
+export declare const BuilderTroops: string[];
+export declare const Heroes: string[];
+export declare const HeroPets: string[];
+export declare const UnrankedLeagueData: {
     id: number;
     name: string;
     iconUrls: {
@@ -19,24 +19,66 @@ export declare const UNRANKED_LEAGUE_DATA: {
         tiny: string;
     };
 };
-export declare const LEGEND_LEAGUE_ID = 29000022;
-export declare const LEAGUES: number[];
-export declare const WAR_LEAGUES: number[];
-export declare const FRIENDLY_WAR_PREPARATION_TIMES: readonly [number, number, number, number, number, number, number, number, number, number, number, number];
-export declare const EVENTS: {
-    readonly NEW_SEASON_START: "newSeasonStart";
-    readonly CLAN_LOOP_START: "clanLoopStart";
-    readonly CLAN_LOOP_END: "clanLoopEnd";
-    readonly PLAYER_LOOP_START: "playerLoopStart";
-    readonly PLAYER_LOOP_END: "playerLoopEnd";
-    readonly WAR_LOOP_START: "warLoopEnd";
-    readonly WAR_LOOP_END: "warLoopEnd";
-    readonly MAINTENANCE_START: "maintenanceStart";
-    readonly MAINTENANCE_END: "maintenanceEnd";
-    readonly ERROR: "error";
+export declare const LegendLeagueId = 29000022;
+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 MaintenanceStart: "maintenanceStart";
+    readonly MaintenanceEnd: "maintenanceEnd";
+    readonly Error: "error";
+    readonly Debug: "debug";
 };
-export declare const CWL_ROUNDS: {
-    readonly PREVIOUS_ROUND: "warEnded";
-    readonly CURRENT_ROUND: "inWar";
-    readonly NEXT_ROUND: "preparation";
+export declare const CWLRounds: {
+    readonly PreviousRound: "warEnded";
+    readonly CurrentRound: "inWar";
+    readonly NextRound: "preparation";
+};
+export declare const RawData: {
+    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;
+        };
+        resourceType: string;
+        trainingTime: number;
+        regenerationTimes: number[];
+        dps: number[];
+        upgrade: {
+            cost: number[];
+            time: number[];
+            resource: string;
+        };
+        seasonal: boolean;
+        levels: number[];
+    }[];
+    RawSuperUnits: {
+        name: string;
+        id: number;
+        original: string;
+        minOriginalLevel: number;
+        village: string;
+        duration: number;
+        cooldown: number;
+        resource: string;
+        resourceCost: number;
+        housingSpace: number;
+    }[];
 };

package/dist/util/Constants.js

@@ -1,9 +1,13 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CWL_ROUNDS = exports.EVENTS = exports.FRIENDLY_WAR_PREPARATION_TIMES = exports.WAR_LEAGUES = exports.LEAGUES = exports.LEGEND_LEAGUE_ID = exports.UNRANKED_LEAGUE_DATA = exports.HERO_PETS = exports.HEROES = exports.BUILDER_TROOPS = exports.SPELLS = exports.DARK_ELIXIR_SPELLS = exports.ELIXIR_SPELLS = exports.SUPER_TROOPS = exports.SIEGE_MACHINES = exports.HOME_TROOPS = exports.DARK_ELIXIR_TROOPS = exports.ELIXIR_TROOPS = exports.DEV_SITE_API_BASE_URL = exports.API_BASE_URL = void 0;
-exports.API_BASE_URL = 'https://api.clashofclans.com/v1';
-exports.DEV_SITE_API_BASE_URL = 'https://developer.clashofclans.com/api';
-exports.ELIXIR_TROOPS = [
+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;
+const raw_json_1 = __importDefault(require("../util/raw.json"));
+exports.APIBaseURL = 'https://api.clashofclans.com/v1';
+exports.DevSiteAPIBaseURL = 'https://developer.clashofclans.com/api';
+exports.ElixirTroops = [
     'Barbarian',
     'Archer',
     'Giant',
@@ -20,10 +24,10 @@ exports.ELIXIR_TROOPS = [
     'Yeti',
     'Dragon Rider'
 ];
-exports.DARK_ELIXIR_TROOPS = ['Minion', 'Hog Rider', 'Valkyrie', 'Golem', 'Witch', 'Lava Hound', 'Bowler', 'Ice Golem', 'Headhunter'];
-exports.HOME_TROOPS = [...exports.ELIXIR_TROOPS, ...exports.DARK_ELIXIR_TROOPS];
-exports.SIEGE_MACHINES = ['Wall Wrecker', 'Battle Blimp', 'Stone Slammer', 'Siege Barracks', 'Log Launcher', 'Flame Flinger'];
-exports.SUPER_TROOPS = [
+exports.DarkElixirTroops = ['Minion', 'Hog Rider', 'Valkyrie', 'Golem', 'Witch', 'Lava Hound', 'Bowler', 'Ice Golem', 'Headhunter'];
+exports.HomeTroops = [...exports.ElixirTroops, ...exports.DarkElixirTroops];
+exports.SiegeMachines = ['Wall Wrecker', 'Battle Blimp', 'Stone Slammer', 'Siege Barracks', 'Log Launcher', 'Flame Flinger'];
+exports.SuperTroops = [
     'Super Barbarian',
     'Super Archer',
     'Super Giant',
@@ -39,7 +43,7 @@ exports.SUPER_TROOPS = [
     'Ice Hound',
     'Super Bowler'
 ];
-exports.ELIXIR_SPELLS = [
+exports.ElixirSpells = [
     'Lightning Spell',
     'Healing Spell',
     'Rage Spell',
@@ -48,9 +52,9 @@ exports.ELIXIR_SPELLS = [
     'Clone Spell',
     'Invisibility Spell'
 ];
-exports.DARK_ELIXIR_SPELLS = ['Poison Spell', 'Earthquake Spell', 'Haste Spell', 'Skeleton Spell', 'Bat Spell'];
-exports.SPELLS = [...exports.ELIXIR_SPELLS, ...exports.DARK_ELIXIR_SPELLS];
-exports.BUILDER_TROOPS = [
+exports.DarkElixirSpells = ['Poison Spell', 'Earthquake Spell', 'Haste Spell', 'Skeleton Spell', 'Bat Spell'];
+exports.Spells = [...exports.ElixirSpells, ...exports.DarkElixirSpells];
+exports.BuilderTroops = [
     'Raged Barbarian',
     'Sneaky Archer',
     'Boxer Giant',
@@ -63,9 +67,9 @@ exports.BUILDER_TROOPS = [
     'Super P.E.K.K.A',
     'Hog Glider'
 ];
-exports.HEROES = ['Barbarian King', 'Archer Queen', 'Grand Warden', 'Royal Champion', 'Battle Machine'];
-exports.HERO_PETS = ['L.A.S.S.I', 'Electro Owl', 'Mighty Yak', 'Unicorn'];
-exports.UNRANKED_LEAGUE_DATA = {
+exports.Heroes = ['Barbarian King', 'Archer Queen', 'Grand Warden', 'Royal Champion', 'Battle Machine'];
+exports.HeroPets = ['L.A.S.S.I', 'Electro Owl', 'Mighty Yak', 'Unicorn'];
+exports.UnrankedLeagueData = {
     id: 29000000,
     name: 'Unranked',
     iconUrls: {
@@ -73,8 +77,8 @@ exports.UNRANKED_LEAGUE_DATA = {
         tiny: 'https://api-assets.clashofclans.com/leagues/36/e--YMyIexEQQhE4imLoJcwhYn6Uy8KqlgyY3_kFV6t4.png'
     }
 };
-exports.LEGEND_LEAGUE_ID = 29000022;
-exports.LEAGUES = [
+exports.LegendLeagueId = 29000022;
+exports.Leagues = [
     29000000,
     29000001,
     29000002,
@@ -97,13 +101,13 @@ exports.LEAGUES = [
     29000019,
     29000020,
     29000021,
-    exports.LEGEND_LEAGUE_ID
+    exports.LegendLeagueId
 ];
-exports.WAR_LEAGUES = [
+exports.WarLeagues = [
     48000000, 48000001, 48000002, 48000003, 48000004, 48000005, 48000006, 48000007, 48000008, 48000009, 48000010, 48000011, 48000012,
     48000013, 48000014, 48000015, 48000016, 48000017, 48000018
 ];
-exports.FRIENDLY_WAR_PREPARATION_TIMES = [
+exports.FriendlyWarPreparationTimes = [
     1000 * 60 * 60 * 24,
     1000 * 60 * 60 * 20,
     1000 * 60 * 60 * 16,
@@ -117,20 +121,25 @@ exports.FRIENDLY_WAR_PREPARATION_TIMES = [
     1000 * 60 * 15,
     1000 * 60 * 5
 ];
-exports.EVENTS = {
-    NEW_SEASON_START: 'newSeasonStart',
-    CLAN_LOOP_START: 'clanLoopStart',
-    CLAN_LOOP_END: 'clanLoopEnd',
-    PLAYER_LOOP_START: 'playerLoopStart',
-    PLAYER_LOOP_END: 'playerLoopEnd',
-    WAR_LOOP_START: 'warLoopEnd',
-    WAR_LOOP_END: 'warLoopEnd',
-    MAINTENANCE_START: 'maintenanceStart',
-    MAINTENANCE_END: 'maintenanceEnd',
-    ERROR: 'error'
+exports.PollingEvents = {
+    NewSeasonStart: 'newSeasonStart',
+    ClanLoopStart: 'clanLoopStart',
+    ClanLoopEnd: 'clanLoopEnd',
+    PlayerLoopStart: 'playerLoopStart',
+    PlayerLoopEnd: 'playerLoopEnd',
+    WarLoopStart: 'warLoopEnd',
+    WarLoopEnd: 'warLoopEnd',
+    MaintenanceStart: 'maintenanceStart',
+    MaintenanceEnd: 'maintenanceEnd',
+    Error: 'error',
+    Debug: 'debug'
+};
+exports.CWLRounds = {
+    PreviousRound: 'warEnded',
+    CurrentRound: 'inWar',
+    NextRound: 'preparation'
 };
-exports.CWL_ROUNDS = {
-    PREVIOUS_ROUND: 'warEnded',
-    CURRENT_ROUND: 'inWar',
-    NEXT_ROUND: 'preparation'
+exports.RawData = {
+    RawUnits: raw_json_1.default.RAW_UNITS,
+    RawSuperUnits: raw_json_1.default.RAW_SUPER_UNITS
 };

package/dist/util/Util.d.ts

@@ -39,4 +39,17 @@ export declare class Util extends null {
     static getSeasonEndTime(timestamp?: Date): Date;
     static allSettled<T>(values: Promise<T>[]): Promise<T[]>;
     static delay(ms: number): Promise<unknown>;
+    /** Parse in-game army link into troops and spells count with respective Id's. */
+    static parseArmyLink(link: string): {
+        units: {
+            name: string | null;
+            count: number;
+            id: number;
+        }[];
+        spells: {
+            name: string | null;
+            count: number;
+            id: number;
+        }[];
+    };
 }

package/dist/util/Util.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Util = void 0;
+const Constants_1 = require("../util/Constants");
 const TAG_CHARACTERS = '0289PYLQGRJCUV';
 const params = [
     'name',
@@ -111,5 +112,34 @@ class Util extends null {
     static async delay(ms) {
         return new Promise((res) => setTimeout(res, ms));
     }
+    /** 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 unitsPart = unitsMatches?.groups?.unit?.split('-') ?? [];
+        const spellParts = spellsMatches?.groups?.spells?.split('-') ?? [];
+        const units = unitsPart
+            .map((parts) => parts.split(/x/))
+            .map((parts) => ({
+            id: Number(parts[1]),
+            total: Number(parts[0])
+        }));
+        const spells = spellParts
+            .map((parts) => parts.split(/x/))
+            .map((parts) => ({
+            id: Number(parts[1]),
+            total: Number(parts[0])
+        }));
+        return {
+            units: units.map((unit) => {
+                const _unit = Constants_1.RawData.RawUnits.find((raw) => raw.category === 'troop' && raw.id === unit.id);
+                return { name: _unit?.name ?? null, count: unit.total, id: unit.id };
+            }),
+            spells: spells.map((spell) => {
+                const _spell = Constants_1.RawData.RawUnits.find((raw) => raw.category === 'spell' && raw.id === spell.id);
+                return { name: _spell?.name ?? null, count: spell.total, id: spell.id };
+            })
+        };
+    }
 }
 exports.Util = Util;