clashofclans.js 2.0.2 → 2.1.0

package/CHANGELOG.md

@@ -2,6 +2,23 @@
 
 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.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`
+    -  `Util.decodeIdToTag(id: string): string`
+    
+- 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

package/dist/client/EventManager.js

@@ -34,14 +34,14 @@ class EventManager {
     /** Add clan tags to clan events. */
     addClans(tags) {
         for (const tag of Array.isArray(tags) ? tags : [tags]) {
-            this._clanTags.add(this.client.util.parseTag(tag));
+            this._clanTags.add(this.client.util.formatTag(tag));
         }
         return this;
     }
     /** Delete clan tags from clan events. */
     deleteClans(tags) {
         for (const tag of Array.isArray(tags) ? tags : [tags]) {
-            const key = this.client.util.parseTag(tag);
+            const key = this.client.util.formatTag(tag);
             this._clans.delete(key);
             this._clanTags.delete(key);
         }
@@ -50,14 +50,14 @@ class EventManager {
     /** Add player tags for player events. */
     addPlayers(tags) {
         for (const tag of Array.isArray(tags) ? tags : [tags]) {
-            this._playerTags.add(this.client.util.parseTag(tag));
+            this._playerTags.add(this.client.util.formatTag(tag));
         }
         return this;
     }
     /** Delete player tags from player events. */
     deletePlayers(tags) {
         for (const tag of Array.isArray(tags) ? tags : [tags]) {
-            const key = this.client.util.parseTag(tag);
+            const key = this.client.util.formatTag(tag);
             this._players.delete(key);
             this._playerTags.delete(key);
         }
@@ -66,14 +66,14 @@ class EventManager {
     /** Add clan tags for war events. */
     addWars(tags) {
         for (const tag of Array.isArray(tags) ? tags : [tags]) {
-            this._warTags.add(this.client.util.parseTag(tag));
+            this._warTags.add(this.client.util.formatTag(tag));
         }
         return this;
     }
     /** Delete clan tags from war events. */
     deleteWars(tags) {
         for (const tag of Array.isArray(tags) ? tags : [tags]) {
-            const key = this.client.util.parseTag(tag);
+            const key = this.client.util.formatTag(tag);
             this._wars.delete(`${key}:${1}`);
             this._wars.delete(`${key}:${2}`);
             this._warTags.delete(key);
@@ -203,7 +203,7 @@ class EventManager {
             return this._clans.set(clan.tag, clan);
         for (const { name, filter } of this._events.clans) {
             try {
-                if (!filter(cached, clan))
+                if (!(await filter(cached, clan)))
                     continue;
                 this.client.emit(name, cached, clan);
             }
@@ -224,7 +224,7 @@ class EventManager {
             return this._players.set(player.tag, player);
         for (const { name, filter } of this._events.players) {
             try {
-                if (!filter(cached, player))
+                if (!(await filter(cached, player)))
                     continue;
                 this.client.emit(name, cached, player);
             }
@@ -248,7 +248,7 @@ class EventManager {
                 return this._wars.set(key, war);
             for (const { name, filter } of this._events.wars) {
                 try {
-                    if (!filter(cached, war))
+                    if (!(await filter(cached, war)))
                         continue;
                     this.client.emit(name, cached, war);
                 }
@@ -262,7 +262,7 @@ class EventManager {
                 if (data && data.warTag === cached.warTag) {
                     for (const { name, filter } of this._events.wars) {
                         try {
-                            if (!filter(cached, data))
+                            if (!(await filter(cached, data)))
                                 continue;
                             this.client.emit(name, cached, data);
                         }

package/dist/struct/ClanWar.js

@@ -134,13 +134,13 @@ class ClanWar {
         // @ts-expect-error
         this.state = data.state;
         this.teamSize = data.teamSize;
-        this.attacksPerMember = data.attacksPerMember;
-        this.preparationStartTime = client.util.parseDate(data.preparationStartTime);
-        this.startTime = client.util.parseDate(data.startTime);
-        this.endTime = client.util.parseDate(data.endTime);
+        this.attacksPerMember = data.attacksPerMember ?? extra.warTag ? 1 : 2;
+        this.preparationStartTime = client.util.formatDate(data.preparationStartTime);
+        this.startTime = client.util.formatDate(data.startTime);
+        this.endTime = client.util.formatDate(data.endTime);
         this.warTag = extra.warTag ?? null;
         let [clan, opponent] = [data.clan, data.opponent];
-        const clanTag = extra.clanTag && client.util.parseTag(extra.clanTag);
+        const clanTag = extra.clanTag && client.util.formatTag(extra.clanTag);
         if (clanTag && [data.clan.tag, data.opponent.tag].includes(clanTag)) {
             clan = data.clan.tag === clanTag ? data.clan : data.opponent;
             opponent = data.clan.tag === clan.tag ? data.opponent : data.clan;

package/dist/struct/ClanWarLog.js

@@ -28,7 +28,7 @@ class ClanWarLog {
     constructor(client, data) {
         this.client = client;
         this.result = data.result ?? null;
-        this.endTime = Util_1.Util.parseDate(data.endTime);
+        this.endTime = Util_1.Util.formatDate(data.endTime);
         this.teamSize = data.teamSize;
         this.attacksPerMember = data.attacksPerMember ?? null;
         this.clan = new WarLogClan(data.clan);

package/dist/struct/Season.js

@@ -14,8 +14,8 @@ exports.Season = Season;
 /** Represents a gold pass season. */
 class GoldPassSeason {
     constructor(data) {
-        this.startTime = Util_1.Util.parseDate(data.startTime);
-        this.endTime = Util_1.Util.parseDate(data.endTime);
+        this.startTime = Util_1.Util.formatDate(data.startTime);
+        this.endTime = Util_1.Util.formatDate(data.endTime);
     }
 }
 exports.GoldPassSeason = GoldPassSeason;

package/dist/types/index.d.ts

@@ -84,7 +84,8 @@ export interface APIClanWar {
     endTime: string;
     clan: APIWarClan;
     opponent: APIWarClan;
-    attacksPerMember: number;
+    /** This property is not available for CWL */
+    attacksPerMember?: number;
 }
 export interface APIWarClan {
     tag: string;

package/dist/util/Util.d.ts

@@ -1,17 +1,39 @@
 /** Contains various general-purpose utility methods. */
 export declare class Util extends null {
-    /** Encode a game tag. */
-    static encodeTag(tag: string): string;
-    /** Parse a game tag. */
+    /**
+     * Corrects malformed tags to match how they are formatted.
+     * ```ts
+     * Util.formatTag("PccVqqGO"); // #PCCVQQG0
+     * ```
+     */
+    static formatTag(tag: string): string;
+    /** @internal */
     static parseTag(tag: string): string;
-    /** Parse API Date to JavaScript Date. */
-    static parseDate(time: string): Date;
-    /** Get URL search params. */
+    /** Encodes a tag as a valid component of a URI. */
+    static encodeTag(tag: string): string;
+    static isValidTag(tag: string): boolean;
+    /**
+     * Encode tag string into 64bit unsigned integer string.
+     * ```ts
+     * Util.encodeTagToId('#PCCVQQG0'); // '510915076'
+     * ```
+     */
+    static encodeTagToId(tag: string): string;
+    /**
+     * Decode 64bit unsigned integer string into tag string with hash.
+     * ```ts
+     * Util.decodeTagToId('510915076'); // '#PCCVQQG0'
+     * ```
+     */
+    static decodeIdToTag(id: string): string;
+    /** Converts API Date to JavaScript Date. */
+    static formatDate(date: string): Date;
+    /** Returns a string containing a query string suitable for use in a URL. */
     static queryString(options?: {}): string;
     private static getSeasonEnd;
     /** Get current trophy season Id. */
     static getSeasonId(): string;
-    /** Get current trophy season end time. */
+    /** Get current trophy season end date. */
     static getSeasonEndTime(date?: Date): Date;
     static allSettled<T>(values: Promise<T>[]): Promise<T[]>;
     static delay(ms: number): Promise<unknown>;

package/dist/util/Util.js

@@ -1,21 +1,65 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Util = void 0;
+const TAG_CHARACTERS = '0289PYLQGRJCUV';
 /** Contains various general-purpose utility methods. */
 class Util extends null {
-    /** Encode a game tag. */
-    static encodeTag(tag) {
-        return encodeURIComponent(this.parseTag(tag));
+    /**
+     * Corrects malformed tags to match how they are formatted.
+     * ```ts
+     * Util.formatTag("PccVqqGO"); // #PCCVQQG0
+     * ```
+     */
+    static formatTag(tag) {
+        return this.parseTag(tag);
     }
-    /** Parse a game tag. */
+    /** @internal */
     static parseTag(tag) {
-        return `#${tag.toUpperCase().replace(/O/g, '0').replace(/^#/g, '')}`;
+        return `#${tag.toUpperCase().replace(/O/g, '0').replace(/^#/g, '').replace(/\s/g, '')}`;
+    }
+    /** Encodes a tag as a valid component of a URI. */
+    static encodeTag(tag) {
+        return encodeURIComponent(this.formatTag(tag));
+    }
+    static isValidTag(tag) {
+        return /^#?[0289PYLQGRJCUV]{3,}$/.test(tag);
+    }
+    /**
+     * Encode tag string into 64bit unsigned integer string.
+     * ```ts
+     * Util.encodeTagToId('#PCCVQQG0'); // '510915076'
+     * ```
+     */
+    static encodeTagToId(tag) {
+        const formatted = this.formatTag(tag).substring(1);
+        if (!this.isValidTag(formatted)) {
+            throw new Error(`Failed to encode tag ${formatted}. RegExp matching failed.`);
+        }
+        const result = formatted.split('').reduce((sum, char) => sum * 14n + BigInt(TAG_CHARACTERS.indexOf(char)), 0n);
+        return result.toString();
+    }
+    /**
+     * Decode 64bit unsigned integer string into tag string with hash.
+     * ```ts
+     * Util.decodeTagToId('510915076'); // '#PCCVQQG0'
+     * ```
+     */
+    static decodeIdToTag(id) {
+        let [bigint, tag] = [BigInt(id), ''];
+        while (bigint !== 0n) {
+            const index = Number(bigint % 14n);
+            tag = TAG_CHARACTERS[index] + tag;
+            bigint /= 14n;
+        }
+        return `#${tag}`;
     }
-    /** Parse API Date to JavaScript Date. */
-    static parseDate(time) {
-        return new Date(`${time.slice(0, 4)}-${time.slice(4, 6)}-${time.slice(6, 8)}T${time.slice(9, 11)}:${time.slice(11, 13)}:${time.slice(13)}`);
+    /** Converts API Date to JavaScript Date. */
+    static formatDate(date) {
+        const YYYY_MM_DD = `${date.slice(0, 4)}-${date.slice(4, 6)}-${date.slice(6, 8)}`;
+        const HH_MM_SS = `${date.slice(9, 11)}:${date.slice(11, 13)}:${date.slice(13)}`;
+        return new Date(`${YYYY_MM_DD}T${HH_MM_SS}`);
     }
-    /** Get URL search params. */
+    /** Returns a string containing a query string suitable for use in a URL. */
     static queryString(options = {}) {
         const query = new URLSearchParams(options);
         for (const key of ['cache', 'force', 'retryLimit', 'ignoreRateLimit', 'restRequestTimeout'])
@@ -37,7 +81,7 @@ class Util extends null {
     static getSeasonId() {
         return this.getSeasonEndTime().toISOString().substring(0, 7);
     }
-    /** Get current trophy season end time. */
+    /** Get current trophy season end date. */
     static getSeasonEndTime(date = new Date()) {
         return this.getSeasonEnd(date.getUTCMonth() + 1);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "clashofclans.js",
-	"version": "2.0.2",
+	"version": "2.1.0",
 	"description": "JavaScript library for interacting with the Clash of Clans API",
 	"author": "SUVAJIT <suvajit.me@gmail.com>",
 	"license": "MIT",
@@ -12,6 +12,9 @@
 		"test": "eslint --ext .ts --ignore-path .gitignore .",
 		"lint": "eslint --fix --ext .ts --ignore-path .gitignore ."
 	},
+	"files": [
+		"dist"
+	],
 	"repository": {
 		"type": "git",
 		"url": "https://github.com/clashperk/clashofclans.js.git"