clashofclans.js 2.3.0 → 2.4.0-dev.e127930

package/dist/struct/ClanWarLog.d.ts

@@ -4,10 +4,8 @@ import { Badge } from './Badge';
 /**
  * Represents War Log Clan.
  *
- * :::caution
  * If this is called via {@link ClanWarLog.opponent}, then {@link WarLogClan.attackCount} and {@link WarLogClan.expEarned} will be `null`.
  * For CWL entries {@link WarLogClan.name} and {@link WarLogClan.tag} are `null`.
- * :::
  */
 export declare class WarLogClan {
     /** The clan's name. This property is `null` CWL entries. */

package/dist/struct/ClanWarLog.js

@@ -6,10 +6,8 @@ const Badge_1 = require("./Badge");
 /**
  * Represents War Log Clan.
  *
- * :::caution
  * If this is called via {@link ClanWarLog.opponent}, then {@link WarLogClan.attackCount} and {@link WarLogClan.expEarned} will be `null`.
  * For CWL entries {@link WarLogClan.name} and {@link WarLogClan.tag} are `null`.
- * :::
  */
 class WarLogClan {
     constructor(data) {

package/dist/struct/Icon.d.ts

@@ -1,16 +1,17 @@
 import { APIIcon } from '../types';
 /** Represents a Clash of Clans Icon. */
 export declare class Icon {
-    private readonly _data;
     /** The default icon URL. */
     url: string;
-    constructor(data: APIIcon);
     /** The medium icon URL. */
-    get medium(): string;
-    /** The tiny icon URL. */
-    get tiny(): string;
+    medium: string;
     /** The small icon URL. */
-    get small(): string;
-    /** Get unique hash of this Badge. */
-    get hash(): string;
+    small: string;
+    /** The tiny icon URL. */
+    tiny: string;
+    constructor(data: APIIcon);
+    /** Get unique file name of this Icon. */
+    get fileName(): string;
+    /** Sizes of this Icon. */
+    get sizes(): string[];
 }

package/dist/struct/Icon.js

@@ -4,24 +4,18 @@ exports.Icon = void 0;
 /** Represents a Clash of Clans Icon. */
 class Icon {
     constructor(data) {
-        Object.defineProperty(this, '_data', { value: data });
         this.url = data.medium ?? data.small;
+        Object.defineProperty(this, 'medium', { value: data.medium ?? data.small });
+        Object.defineProperty(this, 'tiny', { value: data.tiny ?? data.small });
+        Object.defineProperty(this, 'small', { value: data.small });
     }
-    /** The medium icon URL. */
-    get medium() {
-        return this._data.medium ?? this._data.small;
-    }
-    /** The tiny icon URL. */
-    get tiny() {
-        return this._data.tiny ?? this._data.small;
-    }
-    /** The small icon URL. */
-    get small() {
-        return this._data.small;
-    }
-    /** Get unique hash of this Badge. */
-    get hash() {
+    /** Get unique file name of this Icon. */
+    get fileName() {
         return this.url.split('/').pop();
     }
+    /** Sizes of this Icon. */
+    get sizes() {
+        return [this.medium, this.small, this.tiny].map((url) => /\/(\d+)\//g.exec(url)[1]);
+    }
 }
 exports.Icon = Icon;

package/dist/struct/Player.d.ts

@@ -1,10 +1,9 @@
-import { OverrideOptions } from '../rest/RequestHandler';
+import { APIPlayer, OverrideOptions } from '../types';
 import { LegendStatistics } from './LegendStatistics';
 import { Achievement } from './Achievement';
 import { Hero, Spell, Troop } from './Unit';
 import { PlayerClan } from './PlayerClan';
 import { Client } from '../client/Client';
-import { APIPlayer } from '../types';
 import { League } from './League';
 import { Label } from './Label';
 /** Represents a Clash of Clans Player. */

package/dist/struct/PlayerClan.d.ts

@@ -1,6 +1,5 @@
-import { OverrideOptions } from '../rest/RequestHandler';
+import { OverrideOptions, APIPlayerClan } from '../types';
 import { Client } from '../client/Client';
-import { APIPlayerClan } from '../types';
 import { Badge } from './Badge';
 /** Represents a Player's clan. */
 export declare class PlayerClan {

package/dist/types/api.d.ts

@@ -0,0 +1,351 @@
+export interface APIPaging {
+    cursors?: APICursors;
+}
+export interface APICursors {
+    after?: string;
+    before?: string;
+}
+export interface APIIcon {
+    small: string;
+    /** Tiny Icon is not available for Labels. */
+    tiny?: string;
+    /** Medium Icon is not available for Unranked Icon. */
+    medium?: string;
+}
+export interface APIBadge {
+    small: string;
+    large: string;
+    medium: string;
+}
+export interface APISeason {
+    id: string;
+    rank: number;
+    trophies: number;
+}
+/** /clans?name={name}&limit={limit} */
+export interface APIClanList {
+    items: Omit<APIClan, 'memberList'>[];
+    paging: APIPaging;
+}
+export interface APIChatLanguage {
+    name: string;
+    id: number;
+    languageCode: string;
+}
+/** /clans/{clanTag} */
+export interface APIClan {
+    tag: string;
+    name: string;
+    type: 'open' | 'inviteOnly' | 'closed';
+    description: string;
+    location?: APILocation;
+    chatLanguage?: APIChatLanguage;
+    badgeUrls: APIBadge;
+    clanLevel: number;
+    clanPoints: number;
+    clanVersusPoints: number;
+    requiredTrophies: number;
+    requiredTownhallLevel?: number;
+    warFrequency: 'always' | 'moreThanOncePerWeek' | 'oncePerWeek' | 'lessThanOncePerWeek' | 'never' | 'unknown';
+    warWinStreak: number;
+    warWins: number;
+    warTies?: number;
+    warLosses?: number;
+    isWarLogPublic: boolean;
+    warLeague?: APIWarLeague;
+    members: number;
+    labels: APILabel[];
+    memberList: APIClanMember[];
+}
+export interface APIClanMember {
+    name: string;
+    tag: string;
+    role: 'member' | 'admin' | 'coLeader' | 'leader';
+    expLevel: number;
+    league: APILeague;
+    trophies: number;
+    versusTrophies?: number;
+    clanRank: number;
+    previousClanRank: number;
+    donations: number;
+    donationsReceived: number;
+}
+/** /clans/{clanTag}/members */
+export interface APIClanMemberList {
+    items: APIClanMember[];
+    paging: APIPaging;
+}
+/** /clans/{clanTag}/currentwar and /clanwarleagues/wars/{warTag} */
+export interface APIClanWar {
+    state: 'notInWar' | 'preparation' | 'inWar' | 'warEnded';
+    teamSize: number;
+    startTime: string;
+    preparationStartTime: string;
+    endTime: string;
+    clan: APIWarClan;
+    opponent: APIWarClan;
+    /** This property is not available for CWL */
+    attacksPerMember?: number;
+}
+export interface APIWarClan {
+    tag: string;
+    name: string;
+    badgeUrls: APIBadge;
+    clanLevel: number;
+    attacks: number;
+    stars: number;
+    destructionPercentage: number;
+    members: APIClanWarMember[];
+}
+export interface APIClanWarMember {
+    tag: string;
+    name: string;
+    mapPosition: number;
+    townhallLevel: number;
+    opponentAttacks: number;
+    bestOpponentAttack?: APIClanWarAttack;
+    attacks?: APIClanWarAttack[];
+}
+export interface APIClanWarAttack {
+    order: number;
+    attackerTag: string;
+    defenderTag: string;
+    stars: number;
+    duration: number;
+    destructionPercentage: number;
+}
+export interface APIWarLogClan {
+    tag?: string;
+    name?: string;
+    badgeUrls: APIBadge;
+    clanLevel: number;
+    attacks?: number;
+    stars: number;
+    destructionPercentage: number;
+    expEarned?: number;
+}
+export interface APIClanWarLogEntry {
+    result: 'win' | 'lose' | 'tie' | null;
+    endTime: string;
+    teamSize: number;
+    attacksPerMember?: number;
+    clan: APIWarLogClan;
+    opponent: APIWarLogClan;
+}
+/** /clans/{clanTag}/warlog */
+export interface APIClanWarLog {
+    items: APIClanWarLogEntry[];
+    paging: APIPaging;
+}
+/** /clans/{clanTag}/currentwar/leaguegroup */
+export interface APIClanWarLeagueGroup {
+    state: 'preparation' | 'inWar' | 'warEnded';
+    season: string;
+    clans: APIClanWarLeagueClan[];
+    rounds: APIClanWarLeagueRound[];
+}
+export interface APIClanWarLeagueClan {
+    name: string;
+    tag: string;
+    clanLevel: number;
+    badgeUrls: APIBadge;
+    members: APIClanWarLeagueClanMember[];
+}
+export interface APIClanWarLeagueClanMember {
+    name: string;
+    tag: string;
+    townHallLevel: number;
+}
+export interface APIClanWarLeagueRound {
+    warTags: string[];
+}
+/** /players/{playerTag} */
+export interface APIPlayer {
+    name: string;
+    tag: string;
+    townHallLevel: number;
+    townHallWeaponLevel?: number;
+    expLevel: number;
+    trophies: number;
+    bestTrophies: number;
+    warStars: number;
+    attackWins: number;
+    defenseWins: number;
+    builderHallLevel?: number;
+    versusTrophies?: number;
+    bestVersusTrophies?: number;
+    versusBattleWins?: number;
+    donations: number;
+    donationsReceived: number;
+    role?: string;
+    warPreference?: 'in' | 'out';
+    clan?: APIPlayerClan;
+    league?: APILeague;
+    legendStatistics?: APILegendStatistics;
+    achievements: APIPlayerAchievement[];
+    troops: APIPlayerItem[];
+    heroes: APIPlayerItem[];
+    spells: APIPlayerItem[];
+    labels: APILabel[];
+}
+export interface APILegendStatistics {
+    previousSeason?: APISeason;
+    previousVersusSeason?: APISeason;
+    bestVersusSeason?: APISeason;
+    currentSeason?: APISeason;
+    bestSeason?: APISeason;
+    legendTrophies: number;
+}
+export interface APIPlayerClan {
+    tag: string;
+    name: string;
+    clanLevel: number;
+    badgeUrls: APIBadge;
+}
+export interface APIPlayerAchievement {
+    name: string;
+    stars: number;
+    value: number;
+    target: number;
+    info: string;
+    completionInfo: string | null;
+    village: 'home' | 'builderBase';
+}
+export interface APIPlayerItem {
+    name: string;
+    level: number;
+    maxLevel: number;
+    superTroopIsActive?: boolean;
+    village: 'home' | 'builderBase';
+}
+/** /players/{playerTag}/verifytoken */
+export interface APIVerifyToken {
+    tag: string;
+    token: string;
+    status: 'ok' | 'invalid';
+}
+/** /locations */
+export interface APILocationList {
+    items: APILocation[];
+    paging: APIPaging;
+}
+/** /locations/{locationId} */
+export interface APILocation {
+    localizedName?: string;
+    id: number;
+    name: string;
+    isCountry: boolean;
+    countryCode?: string;
+}
+/** /locations/{locationId}/rankings/clans */
+export interface APIClanRankingList {
+    items: APIClanRanking[];
+    paging: APIPaging;
+}
+export interface APIClanRanking {
+    clanLevel: number;
+    clanPoints: number;
+    location: APILocation;
+    members: number;
+    tag: string;
+    name: string;
+    rank: number;
+    previousRank: number;
+    badgeUrls: APIBadge;
+}
+/** /locations/{locationId}/rankings/players */
+export interface APIPlayerRankingList {
+    items: APIPlayerRanking[];
+    paging: APIPaging;
+}
+export interface APIPlayerRanking {
+    tag: string;
+    name: string;
+    expLevel: number;
+    trophies: number;
+    attackWins: number;
+    defenseWins: number;
+    rank: number;
+    previousRank: number;
+    clan?: Omit<APIPlayerClan, 'clanLevel'>;
+    league: APILeague;
+}
+/** /locations/{locationId}/rankings/clans-versus */
+export interface APIClanVersusRankingList {
+    items: APIClanVersusRanking[];
+    paging: APIPaging;
+}
+export interface APIClanVersusRanking {
+    clanLevel: number;
+    location: APILocation;
+    members: number;
+    tag: string;
+    name: string;
+    rank: number;
+    previousRank: number;
+    badgeUrls: APIBadge;
+    clanVersusPoints: number;
+}
+/** /locations/{locationId}/rankings/players-versus */
+export interface APIPlayerVersusRankingList {
+    items: APIPlayerVersusRanking[];
+    paging: APIPaging;
+}
+export interface APIPlayerVersusRanking {
+    tag: string;
+    name: string;
+    expLevel: number;
+    versusTrophies: number;
+    versusBattleWins: number;
+    rank: number;
+    previousRank: number;
+    clan?: APIPlayerClan;
+}
+/** /leagues */
+export interface APILeagueList {
+    items: APILeague[];
+    paging: APIPaging;
+}
+/** /leagues/{leagueId} */
+export interface APILeague {
+    id: number;
+    name: string;
+    iconUrls: APIIcon;
+}
+/** /leagues/{leagueId}/seasons/{seasonId} */
+export interface APIPlayerSeasonRankingList {
+    items: Omit<APIPlayerRanking, 'league'>[];
+    paging: APIPaging;
+}
+/** /leagues/{leagueId}/seasons */
+export interface APILeagueSeasonList {
+    items: {
+        id: string;
+    }[];
+    paging: APIPaging;
+}
+/** /warleagues */
+export interface APIWarLeagueList {
+    items: APIWarLeague[];
+    paging: APIPaging;
+}
+/** /warleagues/{leagueId} */
+export interface APIWarLeague {
+    id: number;
+    name: string;
+}
+export interface APILabel {
+    id: number;
+    name: string;
+    iconUrls: APIIcon;
+}
+/** /labels/clans and /labels/players */
+export interface APILabelList {
+    items: APILabel[];
+    paging: APIPaging;
+}
+/** /goldpass/seasons/current */
+export interface APIGoldPassSeason {
+    startTime: string;
+    endTime: string;
+}

package/dist/types/api.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });