clashofclans.js 3.3.18 → 3.3.19-dev.4967cd5

package/dist/index.mjs

@@ -28,6 +28,7 @@ export const DarkElixirTroops = mod.DarkElixirTroops;
 export const DevSiteAPIBaseURL = mod.DevSiteAPIBaseURL;
 export const ElixirSpells = mod.ElixirSpells;
 export const ElixirTroops = mod.ElixirTroops;
+export const Equipment = mod.Equipment;
 export const FriendlyWarPreparationTimes = mod.FriendlyWarPreparationTimes;
 export const GoldPassSeason = mod.GoldPassSeason;
 export const HTTPError = mod.HTTPError;

package/dist/struct/Player.d.ts

@@ -5,7 +5,7 @@ import { Label } from './Label';
 import { League } from './League';
 import { LegendStatistics } from './LegendStatistics';
 import { PlayerClan } from './PlayerClan';
-import { Hero, HeroEquipment, Spell, Troop } from './Unit';
+import { Equipment, Hero, Spell, Troop } from './Unit';
 /** Represents a Clash of Clans Player. */
 export declare class Player {
     /** The player's name. */
@@ -61,7 +61,7 @@ export declare class Player {
     /** An array of player's heroes (both home base and build base). */
     heroes: Hero[];
     /** An array of player's hero equipment. */
-    heroEquipment: HeroEquipment[];
+    heroEquipment: Equipment[];
     /** The player's clan capital house details. */
     playerHouse?: APIPlayerHouse | null;
     private readonly client;

package/dist/struct/Player.js

@@ -46,7 +46,7 @@ class Player {
         this.troops = data.troops.map((unit) => new Unit_1.Troop(data, unit));
         this.spells = data.spells.map((unit) => new Unit_1.Spell(data, unit));
         this.heroes = data.heroes.map((unit) => new Unit_1.Hero(data, unit));
-        this.heroEquipment = data.heroEquipment.map((unit) => new Unit_1.HeroEquipment(data, unit));
+        this.heroEquipment = data.heroEquipment.map((unit) => new Unit_1.Equipment(data, unit));
         this.playerHouse = data.playerHouse ?? null;
     }
     /** Whether this clan member is in the clan. */

package/dist/struct/Unit.d.ts

@@ -50,7 +50,7 @@ export declare class Unit {
     /** @internal */
     originalName: string | null;
     /** @internal */
-    equipment: HeroEquipment[];
+    equipment: Equipment[];
     constructor(data: APIPlayer, unit: APIPlayerItem);
     /** Whether the unit belongs to the home base. */
     get isHomeBase(): boolean;
@@ -82,8 +82,8 @@ export declare class Hero extends Unit {
     /** Regeneration time of this hero. */
     regenerationTime: number;
     /** Hero Equipment */
-    equipment: HeroEquipment[];
+    equipment: Equipment[];
 }
 /** Represents a Player's Hero Equipment. */
-export declare class HeroEquipment extends Unit {
+export declare class Equipment extends Unit {
 }

package/dist/struct/Unit.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.HeroEquipment = exports.Hero = exports.Spell = exports.Troop = exports.Unit = void 0;
+exports.Equipment = exports.Hero = exports.Spell = exports.Troop = exports.Unit = void 0;
 const Constants_1 = require("../util/Constants");
 /** Represents a Player's Unit. */
 class Unit {
@@ -58,7 +58,7 @@ class Unit {
                 this.regenerationTime = rawUnit.regenerationTimes[this.level - 1] ?? 0;
             this.hallMaxLevel =
                 rawUnit.levels[(this.village === 'home' ? data.townHallLevel : data.builderHallLevel) - 1] ?? this.maxLevel;
-            this.equipment = (unit.equipment ?? []).map((unit) => new HeroEquipment(data, unit));
+            this.equipment = (unit.equipment ?? []).map((unit) => new Equipment(data, unit));
         }
         this.seasonal = Boolean(rawUnit?.seasonal);
         this.isLoaded = Boolean(rawUnit ?? rawSuperUnit);
@@ -101,6 +101,6 @@ class Hero extends Unit {
 }
 exports.Hero = Hero;
 /** Represents a Player's Hero Equipment. */
-class HeroEquipment extends Unit {
+class Equipment extends Unit {
 }
-exports.HeroEquipment = HeroEquipment;
+exports.Equipment = Equipment;

package/dist/util/Constants.d.ts

@@ -1,10 +1,11 @@
 export declare const APIBaseURL = "https://api.clashofclans.com/v1";
 export declare const DevSiteAPIBaseURL = "https://developer.clashofclans.com/api";
+export declare const SuperTroops: string[];
 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 HeroEquipment: string[];
 export declare const ElixirSpells: string[];
 export declare const DarkElixirSpells: string[];
 export declare const Spells: string[];

package/dist/util/Constants.js

@@ -3,119 +3,22 @@ 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.RestEvents = exports.ClientEvents = exports.PollingEvents = exports.FriendlyWarPreparationTimes = exports.WarLeagues = exports.Leagues = exports.UnrankedWarLeagueId = exports.LegendLeagueId = exports.UnrankedLeagueId = 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.UnrankedWarLeagueId = exports.LegendLeagueId = exports.UnrankedLeagueId = exports.UnrankedLeagueData = exports.HeroPets = exports.Heroes = exports.BuilderTroops = exports.Spells = exports.DarkElixirSpells = exports.ElixirSpells = exports.HeroEquipment = exports.SiegeMachines = exports.HomeTroops = exports.DarkElixirTroops = exports.ElixirTroops = exports.SuperTroops = 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',
-    'Goblin',
-    'Wall Breaker',
-    'Balloon',
-    'Wizard',
-    'Healer',
-    'Dragon',
-    'P.E.K.K.A',
-    'Baby Dragon',
-    'Miner',
-    'Electro Dragon',
-    'Yeti',
-    'Dragon Rider',
-    'Electro Titan',
-    'Root Rider',
-    'Thrower'
-];
-exports.DarkElixirTroops = [
-    'Minion',
-    'Hog Rider',
-    'Valkyrie',
-    'Golem',
-    'Witch',
-    'Lava Hound',
-    'Bowler',
-    'Ice Golem',
-    'Headhunter',
-    'Apprentice Warden',
-    'Druid'
-];
+exports.SuperTroops = raw_json_1.default.RAW_SUPER_UNITS.map((unit) => unit.name);
+exports.ElixirTroops = raw_json_1.default.RAW_UNITS.filter((unit) => !exports.SuperTroops.includes(unit.name) && unit.subCategory === 'troop' && unit.upgrade.resource === 'Elixir').map((unit) => unit.name);
+exports.DarkElixirTroops = raw_json_1.default.RAW_UNITS.filter((unit) => !exports.SuperTroops.includes(unit.name) && unit.subCategory === 'troop' && unit.upgrade.resource === 'Dark Elixir').map((unit) => unit.name);
 exports.HomeTroops = [...exports.ElixirTroops, ...exports.DarkElixirTroops];
-exports.SiegeMachines = [
-    'Wall Wrecker',
-    'Battle Blimp',
-    'Stone Slammer',
-    'Siege Barracks',
-    'Log Launcher',
-    'Flame Flinger',
-    'Battle Drill'
-];
-exports.SuperTroops = [
-    'Super Barbarian',
-    'Super Archer',
-    'Super Giant',
-    'Sneaky Goblin',
-    'Super Wall Breaker',
-    'Rocket Balloon',
-    'Super Wizard',
-    'Super Dragon',
-    'Inferno Dragon',
-    'Super Minion',
-    'Super Valkyrie',
-    'Super Witch',
-    'Ice Hound',
-    'Super Bowler',
-    'Super Miner',
-    'Super Hog Rider'
-];
-exports.ElixirSpells = [
-    'Lightning Spell',
-    'Healing Spell',
-    'Rage Spell',
-    'Jump Spell',
-    'Freeze Spell',
-    'Clone Spell',
-    'Invisibility Spell',
-    'Recall Spell',
-    'Revive Spell'
-];
-exports.DarkElixirSpells = ['Poison Spell', 'Earthquake Spell', 'Haste Spell', 'Skeleton Spell', 'Bat Spell', 'Overgrowth Spell'];
+exports.SiegeMachines = raw_json_1.default.RAW_UNITS.filter((unit) => unit.subCategory === 'siege').map((unit) => unit.name);
+exports.HeroEquipment = raw_json_1.default.RAW_UNITS.filter((unit) => unit.subCategory === 'equipment').map((unit) => unit.name);
+exports.ElixirSpells = raw_json_1.default.RAW_UNITS.filter((unit) => unit.subCategory === 'spell' && unit.upgrade.resource === 'Elixir').map((unit) => unit.name);
+exports.DarkElixirSpells = raw_json_1.default.RAW_UNITS.filter((unit) => unit.subCategory === 'spell' && unit.upgrade.resource === 'Dark Elixir').map((unit) => unit.name);
 exports.Spells = [...exports.ElixirSpells, ...exports.DarkElixirSpells];
-exports.BuilderTroops = [
-    'Raged Barbarian',
-    'Sneaky Archer',
-    'Boxer Giant',
-    'Beta Minion',
-    'Bomber',
-    'Baby Dragon',
-    'Cannon Cart',
-    'Night Witch',
-    'Drop Ship',
-    'Super P.E.K.K.A',
-    'Hog Glider',
-    'Electrofire Wizard'
-];
-exports.Heroes = [
-    'Barbarian King',
-    'Archer Queen',
-    'Grand Warden',
-    'Royal Champion',
-    'Minion Prince',
-    'Battle Machine',
-    'Battle Copter'
-];
-exports.HeroPets = [
-    'L.A.S.S.I',
-    'Electro Owl',
-    'Mighty Yak',
-    'Unicorn',
-    'Poison Lizard',
-    'Diggy',
-    'Frosty',
-    'Phoenix',
-    'Spirit Fox',
-    'Angry Jelly'
-];
+exports.BuilderTroops = raw_json_1.default.RAW_UNITS.filter((unit) => unit.subCategory === 'troop' && unit.village === 'builderBase').map((unit) => unit.name);
+exports.Heroes = raw_json_1.default.RAW_UNITS.filter((unit) => unit.subCategory === 'hero').map((unit) => unit.name);
+exports.HeroPets = raw_json_1.default.RAW_UNITS.filter((unit) => unit.subCategory === 'pet').map((unit) => unit.name);
 exports.UnrankedLeagueData = {
     id: 29000000,
     name: 'Unranked',

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "clashofclans.js",
-	"version": "3.3.18",
+	"version": "3.3.19-dev.4967cd5",
 	"description": "JavaScript library for interacting with the Clash of Clans API",
 	"author": "https://clashofclans.js.org",
 	"license": "MIT",

package/CHANGELOG.md

@@ -1,173 +0,0 @@
-# Changelog
-
-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.
-
-## 3.1.3 (24-12-2023)
-
-### Features
-
-- Town Hall 16 updates.
-- Removed deprecated builder base properties.
-
-## 3.1.3 (13-08-2023)
-
-### Features
-
-- Switched to `undici` from `node-fetch` for better performance.
-
-## 3.1.0 (2023-07-28)
-
-### Features
-
-- Builder base update and new troop levels.
-
-## 3.0.2 (2023-01-15)
-
-### Bug Fixes
-
-- Conflict with the same name of builder base and home base troops. (#123)
-- Fix the issue with the `Client#getLeagueWar()` method.
-- Typings and documentation for clan capital.
-- Fix the issue with the `Clan#clanCapital` property.
-
-### Features
-
-- Added `Client#getCapitalRaidSeasons()` method.
-- Added `Client#getCapitalLeagues()` method.
-- Added `Client#getClanCapitalRanks()` method.
-- Added new Super Troops in raw.json file.
-
-### Breaking Changes
-
-- Using PascalCase instead of SCREAMING_SNAKE_CASE ([#115](https://github.com/clashperk/clashofclans.js/pull/115))
-- `Client#events` and `EventManager` have been removed in favor of `PollingClient` ([#117](https://github.com/clashperk/clashofclans.js/pull/117), [#127](https://github.com/clashperk/clashofclans.js/pull/127))
-
-## 2.8.0 (2022-07-22)
-
-### Features
-
-- Better Throttler with JS generator function. ([#111](https://github.com/clashperk/clashofclans.js/pull/111))
-- Updated raw data from game files. ([#111](https://github.com/clashperk/clashofclans.js/pull/111))
-- New method Util#parseArmyLink has been added. ([#110](https://github.com/clashperk/clashofclans.js/pull/110))
-
-## 2.7.0 (2022-05-22)
-
-### Features
-
-- Some useful QOL methods have been added. ([#106](https://github.com/clashperk/clashofclans.js/pull/106))
-
-## 2.6.1 (2022-02-03)
-
-### Bug Fixes
-
-- New value and typings `notInWar` added for `ClanWarLeagueGroup#state` ([#101](https://github.com/clashperk/clashofclans.js/pull/101))
-- Throw error if `Util.formatTag` / `Util.parseTag` is called with invalid argument ([#102](https://github.com/clashperk/clashofclans.js/pull/101))
-
-## 2.6.0 (2022-01-29)
-
-## Features
-
-- Replaced Keyv with customizable cache store ([#99](https://github.com/clashperk/clashofclans.js/pull/99))
-- Guide for [Internal Caching](https://clashofclans.js.org/guide/internal-caching)
-
-## 2.5.2 (2022-01-23)
-
-### Bug Fixes
-
-- Fix `ClanWar#attacksPerMembers` property ([#97](https://github.com/clashperk/clashofclans.js/pull/97))
-- Bump `node-fetch` from 2.6.6 to 2.6.7 ([#96](https://github.com/clashperk/clashofclans.js/pull/96))
-
-## 2.5.1 (2022-01-11)
-
-### Bug Fixes
-
-- Typings for `ClanWarLeagueGroup#state` property. ([#94](https://github.com/clashperk/clashofclans.js/pull/94))
-
-## 2.5.0 (2021-12-30)
-
-### Bug Fixes
-
-- Fix caching issue with unnecessary/invalid query params. ([#91](https://github.com/clashperk/clashofclans.js/pull/91))
-- Added necessary methods to `RESTManager` class. ([#92](https://github.com/clashperk/clashofclans.js/pull/92))
-
-## 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
-
-- BigInt literals issue fixed. ([#84](https://github.com/clashperk/clashofclans.js/pull/84))
-- Some Utility methods renamed. ([#84](https://github.com/clashperk/clashofclans.js/pull/84))
-  - `Util.encodeTag()` to `Util.encodeURI()`
-  - `Util.encodeTagToId()` to `Util.encodeTag()`
-  - `Util.decodeIdToTag()` to `Util.decodeTag()`
-- Added `dps`, `resourceType`, `trainingTime` and `regenerationTime` to the `Unit` class. ([#85](https://github.com/clashperk/clashofclans.js/pull/85))
-
-## 2.2.0 (2021-12-16)
-
-### Bug Fixes
-
-- Show units as per in-game orders. ([#82](https://github.com/clashperk/clashofclans.js/pull/82)) ([6e23d2f](https://github.com/clashperk/clashofclans.js/commit/95cf3001059fd3ede9262e249814178631660d5b))
-- Season end time utility method. ([#82](https://github.com/clashperk/clashofclans.js/pull/82)) ([6e23d2f](https://github.com/clashperk/clashofclans.js/commit/95cf3001059fd3ede9262e249814178631660d5b))
-- Updated raw files for new Troops. ([#82](https://github.com/clashperk/clashofclans.js/pull/82)) ([6e23d2f](https://github.com/clashperk/clashofclans.js/commit/95cf3001059fd3ede9262e249814178631660d5b))
-
-### Features
-
-- Added `seasonal`, `boostable` and `isLoaded` property to `Unit` class. ([#82](https://github.com/clashperk/clashofclans.js/pull/82)) ([6e23d2f](https://github.com/clashperk/clashofclans.js/commit/95cf3001059fd3ede9262e249814178631660d5b))
-
-## 2.1.0 (2021-12-06)
-
-### Bug Fixes
-
-- Consistency of `ClanWar.attacksPerMember` property. ([#75](https://github.com/clashperk/clashofclans.js/pull/75)) ([6e23d2f](https://github.com/clashperk/clashofclans.js/commit/6e23d2fe0373f56268ffa55d5ac2807c9a2dc2fc))
-
-### Features
-
-- More utility methods added to `Util` class. ([#76](https://github.com/clashperk/clashofclans.js/pull/76)) ([ff41115](https://github.com/clashperk/clashofclans.js/commit/ff4111530d6293ef1fc54aa916436130fc30a09c))
-
-  - `Util.formatTag(tag: string): string`
-  - `Util.formatDate(date: string): Date`
-  - `Util.isValidTag(tag: string): boolean`
-  - `Util.encodeTagToId(tag: string): string` (Removed on 2.3.0)
-  - `Util.decodeIdToTag(id: string): string` (Removed on 2.3.0)
-
-- Support of async/await for custom events ([#79](https://github.com/clashperk/clashofclans.js/pull/79)) ([ff41115](https://github.com/clashperk/clashofclans.js/commit/a23db3786bcca44b8547c70f27773bdb1216f990))
-
-## 2.0.2 (2021-11-30)
-
-### Bug Fixes
-
-- Return `null` for `RankedPlayer.clan` if they are not in the clan. ([#73](https://github.com/clashperk/clashofclans.js/pull/73)) ([ba82327](https://github.com/clashperk/clashofclans.js/commit/ba8232740f4ca9af2bcc7971aca3574612ef25b6))
-- `OverrideOptions` added for `Client#getClans` and `RESTManager#getClans` ([#73](https://github.com/clashperk/clashofclans.js/pull/73)) ([ba82327](https://github.com/clashperk/clashofclans.js/commit/ba8232740f4ca9af2bcc7971aca3574612ef25b6))
-- `SeasonRankedPlayer` class for legend league ranking. ([#73](https://github.com/clashperk/clashofclans.js/pull/73)) ([ba82327](https://github.com/clashperk/clashofclans.js/commit/ba8232740f4ca9af2bcc7971aca3574612ef25b6))
-
-## 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
-
-- 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))
-- 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))
-- 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))