Skip to main content

Changelog

All notable changes to this project will be documented in this file. See 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)
  • Client#events and EventManager have been removed in favor of PollingClient (#117, #127)

2.8.0 (2022-07-22)

Features

  • Better Throttler with JS generator function. (#111)
  • Updated raw data from game files. (#111)
  • New method Util#parseArmyLink has been added. (#110)

2.7.0 (2022-05-22)

Features

  • Some useful QOL methods have been added. (#106)

2.6.1 (2022-02-03)

Bug Fixes

  • New value and typings notInWar added for ClanWarLeagueGroup#state (#101)
  • Throw error if Util.formatTag / Util.parseTag is called with invalid argument (#102)

2.6.0 (2022-01-29)

Features

2.5.2 (2022-01-23)

Bug Fixes

  • Fix ClanWar#attacksPerMembers property (#97)
  • Bump node-fetch from 2.6.6 to 2.6.7 (#96)

2.5.1 (2022-01-11)

Bug Fixes

  • Typings for ClanWarLeagueGroup#state property. (#94)

2.5.0 (2021-12-30)

Bug Fixes

  • Fix caching issue with unnecessary/invalid query params. (#91)
  • Added necessary methods to RESTManager class. (#92)

2.4.0 (2021-12-28)

Features

  • ClanWar#getClanWarLeagueGroup, ClanWar#isCWL and ClanWar#isFriendly are now available. (#87)
  • RESTOptions#rejectIfNotValid added to perform res.ok operations over RESTManager methods. Know more? (#87)
  • Icon#fileName and Icon#sizes are now available in Icon class. (#87)
  • Badge#fileName and Badge#sizes are now available in Badge class. (#87)

Deprecations

  • ClanWarMember#previousBestOpponentAttack has been deprecated. Use ClanWarAttack#previousBestAttack instead. (#87)

2.3.0 (2021-12-17)

Features

  • BigInt literals issue fixed. (#84)
  • Some Utility methods renamed. (#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)

2.2.0 (2021-12-16)

Bug Fixes

Features

  • Added seasonal, boostable and isLoaded property to Unit class. (#82) (6e23d2f)

2.1.0 (2021-12-06)

Bug Fixes

  • Consistency of ClanWar.attacksPerMember property. (#75) (6e23d2f)

Features

  • More utility methods added to Util class. (#76) (ff41115)

    • 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) (ff41115)

2.0.2 (2021-11-30)

Bug Fixes

  • Return null for RankedPlayer.clan if they are not in the clan. (#73) (ba82327)
  • OverrideOptions added for Client#getClans and RESTManager#getClans (#73) (ba82327)
  • SeasonRankedPlayer class for legend league ranking. (#73) (ba82327)

2.0.1 (2021-11-27)

Bug Fixes

  • IP retrieval method and Event Loop (#70) (82b84ba)

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