clashofclans.js 2.7.0-dev.31f642e → 2.7.0-dev.a33ae73

package/CHANGELOG.md

@@ -2,9 +2,15 @@
 
 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.6.1 (2022-02-03)
+## 2.7.0 (2022-05-22)
 
-Bug Fixes
+### 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))

package/dist/struct/ClanMember.d.ts

@@ -26,9 +26,13 @@ export declare class ClanMember {
     /** The member's donation received count for this season. */
     received: number;
     constructor(client: Client, data: APIClanMember);
+    /** Whether this clan member is in the clan. */
     get isMember(): boolean;
+    /** Whether this clan member is an Elder. */
     get isElder(): boolean;
+    /** Whether this clan member is a Co-Leader. */
     get isCoLeader(): boolean;
+    /** Whether this clan member is a Leader. */
     get isLeader(): boolean;
     /** Fetch detailed clan info for the member's clan. */
     fetch(options?: OverrideOptions): Promise<import("./Player").Player>;

package/dist/struct/ClanMember.js

@@ -20,15 +20,19 @@ class ClanMember {
         this.donations = data.donations;
         this.received = data.donationsReceived;
     }
+    /** Whether this clan member is in the clan. */
     get isMember() {
         return this.role === 'member';
     }
+    /** Whether this clan member is an Elder. */
     get isElder() {
         return this.role === 'elder';
     }
+    /** Whether this clan member is a Co-Leader. */
     get isCoLeader() {
         return this.role === 'coLeader';
     }
+    /** Whether this clan member is a Leader. */
     get isLeader() {
         return this.role === 'leader';
     }

package/dist/struct/ClanWar.d.ts

@@ -135,8 +135,11 @@ export declare class ClanWar {
     getAttack(attackerTag: string, defenderTag: string): ClanWarAttack | null;
     /** Return a list of {@link ClanWarAttack} for the defenderTag provided. */
     getDefenses(defenderTag: string): ClanWarAttack[];
+    /** Whether this is a Battle Day. */
     get isBattleDay(): boolean;
+    /** Whether this is a Preparation Day. */
     get isPreparationDay(): boolean;
+    /** Whether this War has Ended. */
     get isWarEnded(): boolean;
     /** Returns either `friendly`, `cwl` or `normal`. */
     get type(): "friendly" | "cwl" | "normal";

package/dist/struct/ClanWar.js

@@ -178,12 +178,15 @@ class ClanWar {
         }
         return this.opponent.attacks.filter((atk) => atk.defenderTag === defenderTag);
     }
+    /** Whether this is a Battle Day. */
     get isBattleDay() {
         return this.state === 'inWar';
     }
+    /** Whether this is a Preparation Day. */
     get isPreparationDay() {
         return this.state === 'preparation';
     }
+    /** Whether this War has Ended. */
     get isWarEnded() {
         return this.state === 'warEnded';
     }

package/dist/struct/ClanWarLeagueGroup.d.ts

@@ -54,6 +54,7 @@ export declare class ClanWarLeagueGroup {
     /** An array containing all war tags for each round. */
     rounds: ClanWarLeagueRound[];
     constructor(client: Client, data: APIClanWarLeagueGroup);
+    /** Total number of rounds for this CWL. */
     get totalRounds(): number;
     /**
      * This returns an array of {@link ClanWar} which fetches all wars in parallel.

package/dist/struct/ClanWarLeagueGroup.js

@@ -55,6 +55,7 @@ class ClanWarLeagueGroup {
         this.clans = data.clans.map((clan) => new ClanWarLeagueClan(client, clan));
         this.rounds = data.rounds.map((round, i) => new ClanWarLeagueRound(round, i));
     }
+    /** Total number of rounds for this CWL. */
     get totalRounds() {
         return this.clans.length - 1;
     }

package/dist/struct/ClanWarLog.d.ts

@@ -51,7 +51,10 @@ export declare class ClanWarLog {
     constructor(client: Client, data: APIClanWarLogEntry);
     /** Returns either `friendly`, `cwl` or `normal`. */
     get type(): "friendly" | "cwl" | "normal";
+    /** Whether this is a friendly war. */
     get isFriendly(): boolean;
+    /** Whether this is a CWL. */
     get isCWL(): boolean;
+    /** Whether this is a normal war. */
     get isNormal(): boolean;
 }

package/dist/struct/ClanWarLog.js

@@ -44,12 +44,15 @@ class ClanWarLog {
             return 'cwl';
         return 'normal';
     }
+    /** Whether this is a friendly war. */
     get isFriendly() {
         return this.type === 'friendly';
     }
+    /** Whether this is a CWL. */
     get isCWL() {
         return this.type === 'cwl';
     }
+    /** Whether this is a normal war. */
     get isNormal() {
         return this.type === 'normal';
     }

package/dist/struct/Player.d.ts

@@ -62,10 +62,15 @@ export declare class Player {
     /** An array of player's heroes (both home base and build base). */
     heroes: Hero[];
     constructor(client: Client, data: APIPlayer);
+    /** Whether this clan member is in the clan. */
     get inClan(): boolean;
+    /** Whether this clan member is in the clan. */
     get isMember(): boolean | null;
+    /** Whether this clan member is a Leader. */
     get isLeader(): boolean | null;
+    /** Whether this clan member is a Co-Leader. */
     get isCoLeader(): boolean | null;
+    /** Whether this clan member is an Elder. */
     get isElder(): boolean | null;
     /** Fetch detailed clan info for the player's clan. */
     fetchClan(options?: OverrideOptions): Promise<import("./Clan").Clan | null>;

package/dist/struct/Player.js

@@ -40,18 +40,23 @@ class Player {
         this.spells = data.spells.map((unit) => new Unit_1.Spell(data, unit));
         this.heroes = data.heroes.map((unit) => new Unit_1.Hero(data, unit));
     }
+    /** Whether this clan member is in the clan. */
     get inClan() {
         return this.clan !== null;
     }
+    /** Whether this clan member is in the clan. */
     get isMember() {
         return this.clan ? this.role === 'member' : null;
     }
+    /** Whether this clan member is a Leader. */
     get isLeader() {
         return this.clan ? this.role === 'leader' : null;
     }
+    /** Whether this clan member is a Co-Leader. */
     get isCoLeader() {
         return this.clan ? this.role === 'coLeader' : null;
     }
+    /** Whether this clan member is an Elder. */
     get isElder() {
         return this.clan ? this.role === 'elder' : null;
     }

package/dist/util/Util.d.ts

@@ -1,4 +1,3 @@
-import { Clan, ClanMember } from '../struct';
 import { ClanSearchOptions, SearchOptions } from '../types';
 /** Contains various general-purpose utility methods. */
 export declare class Util extends null {
@@ -40,6 +39,4 @@ 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>;
-    static joinedMembers(oldClan: Clan, newClan: Clan): ClanMember[];
-    static leftMembers(oldClan: Clan, newClan: Clan): ClanMember[];
 }

package/dist/util/Util.js

@@ -111,17 +111,5 @@ class Util extends null {
     static async delay(ms) {
         return new Promise((res) => setTimeout(res, ms));
     }
-    static joinedMembers(oldClan, newClan) {
-        const oldMembers = oldClan.members.map((member) => member.tag);
-        return newClan.members.filter((member) => {
-            return !oldMembers.includes(member.tag);
-        });
-    }
-    static leftMembers(oldClan, newClan) {
-        const newMembers = newClan.members.map((member) => member.tag);
-        return oldClan.members.filter((member) => {
-            return !newMembers.includes(member.tag);
-        });
-    }
 }
 exports.Util = Util;

package/package.json

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