clashofclans.js 2.3.0 → 2.4.0-dev.0d3fbc6

package/CHANGELOG.md

@@ -2,6 +2,19 @@
 
 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.4.0 (2021-12-28)
+
+### Features
+
+-   `ClanWar.getClanWarLeague`, `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` class. ([#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

package/LICENSE

@@ -1,7 +1,6 @@
 MIT License
 
-Copyright (c) 2020 - 2021 csuvajit
-Copyright (c) 2020 - 2021 TheLearneer
+Copyright (c) 2020 - 2021 ClashPerk
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/dist/rest/HTTPError.d.ts

@@ -8,7 +8,7 @@ export declare class HTTPError extends Error {
      * The reason of this errored request.
      *
      * Expected values are `notFound`, `notInWar`, `accessDenied`, `accessDenied.invalidIp`, `privateWarLog`,
-     * `badRequest`, `requestThrottled`, `serviceUnavailable`, `requestAborted` and `unknownException`.
+     * `badRequest`, `requestThrottled`, `inMaintenance`, `requestAborted` and `unknownException`.
      */
     reason: string;
     /** The HTTP status code of this request. */

package/dist/rest/RESTManager.d.ts

@@ -1,10 +1,10 @@
-import { RequestHandler, SearchOptions, ClanSearchOptions, ClientOptions, OverrideOptions } from './RequestHandler';
+import { RequestHandler, SearchOptions, ClanSearchOptions, RESTOptions, OverrideOptions } from './RequestHandler';
 import { APIClan, APIClanList, APIClanMemberList, APIClanRankingList, APIClanVersusRankingList, APIClanWar, APIClanWarLeagueGroup, APIClanWarLog, APIGoldPassSeason, APILabelList, APILeague, APILeagueList, APILeagueSeasonList, APILocation, APILocationList, APIPlayer, APIPlayerRankingList, APIPlayerSeasonRankingList, APIPlayerVersusRankingList, APIVerifyToken, APIWarLeague, APIWarLeagueList } from '../types';
 /** Represents a REST Manager of the client. */
 export declare class RESTManager {
     /** Request Handler for the RESTManager. */
     readonly handler: RequestHandler;
-    constructor(options?: ClientOptions);
+    constructor(options?: RESTOptions);
     /** Search all clans by name and/or filtering the results using various criteria. */
     getClans(query: ClanSearchOptions, options?: OverrideOptions): Promise<import("./RequestHandler").Response<APIClanList>>;
     /** Get info about a clan. */

package/dist/rest/RequestHandler.d.ts

@@ -10,11 +10,12 @@ export declare class RequestHandler {
     private keyDescription?;
     private keys;
     private readonly baseURL;
+    private readonly rejectIfNotValid;
     private readonly retryLimit;
     private readonly restRequestTimeout;
     private readonly throttler?;
     private readonly cached;
-    constructor(options?: ClientOptions);
+    constructor(options?: RESTOptions);
     private get _keys();
     private get _key();
     setKeys(keys: string[]): this;
@@ -28,7 +29,7 @@ export declare class RequestHandler {
     private createKey;
     private getIp;
 }
-/** Options for a client. */
+/** Options for a Client. */
 export interface ClientOptions {
     /** Keys from Clash of Clans API developer site. */
     keys?: string[];
@@ -61,6 +62,11 @@ export interface ClientOptions {
      */
     throttler?: QueueThrottler | BatchThrottler;
 }
+/** Options for a RESTManager. */
+export interface RESTOptions extends ClientOptions {
+    /** Set this `false` to use `res.ok` property. */
+    rejectIfNotValid?: boolean;
+}
 /** Search options for request. */
 export interface SearchOptions extends OverrideOptions {
     /** Limit the number of items returned in the response. */
@@ -98,6 +104,8 @@ export interface RequestOptions extends OverrideOptions {
     method?: string;
 }
 export interface Response<T> {
+    /** Whether the response is ok. */
+    ok: boolean;
     /** The response body. */
     data: T;
     /** Path of the request for this response. */

package/dist/rest/RequestHandler.js

@@ -32,6 +32,7 @@ class RequestHandler {
         this.throttler = options?.throttler ?? null;
         this.baseURL = options?.baseURL ?? Constants_1.API_BASE_URL;
         this.restRequestTimeout = options?.restRequestTimeout ?? 0;
+        this.rejectIfNotValid = options?.rejectIfNotValid ?? true;
         if (options?.cache instanceof keyv_1.default)
             this.cached = options.cache;
         else
@@ -52,7 +53,7 @@ class RequestHandler {
     async request(path, options = {}) {
         const cached = (await this.cached?.get(path)) ?? null;
         if (cached && options.force !== true) {
-            return { data: cached.data, maxAge: cached.ttl - Date.now(), status: 200, path };
+            return { data: cached.data, maxAge: cached.ttl - Date.now(), status: cached.status, path, ok: cached.status === 200 };
         }
         if (!this.throttler || options.ignoreRateLimit)
             return this.exec(path, options);
@@ -81,14 +82,16 @@ class RequestHandler {
                 return this.exec(path, options, ++retries);
         }
         const maxAge = Number(res?.headers.get('cache-control')?.split('=')?.[1] ?? 0) * 1000;
-        if (res?.status === 403 && !data?.message)
+        if (res?.status === 403 && !data?.message && this.rejectIfNotValid) {
             throw new HTTPError_1.HTTPError(HTTPError_1.PrivateWarLogError, res.status, path, maxAge);
-        if (!res?.ok)
+        }
+        if (!res?.ok && this.rejectIfNotValid) {
             throw new HTTPError_1.HTTPError(data, res?.status ?? 504, path, maxAge, options.method);
+        }
         if (this.cached && maxAge > 0 && options.cache !== false) {
-            await this.cached.set(path, { data, ttl: Date.now() + maxAge }, maxAge);
+            await this.cached.set(path, { data, ttl: Date.now() + maxAge, status: res?.status ?? 504 }, maxAge);
         }
-        return { data, maxAge, status: res.status, path };
+        return { data, maxAge, status: res?.status ?? 504, path, ok: res?.status === 200 };
     }
     async init(options) {
         if (!(options.email && options.password))

package/dist/struct/Badge.d.ts

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

package/dist/struct/Badge.js

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

package/dist/struct/ClanWar.d.ts

@@ -61,6 +61,8 @@ export declare class ClanWarMember {
     /**
      * Returns the previous best opponent attack on this village.
      * This is useful for calculating the new stars or destruction for new attacks.
+     *
+     * @deprecated `order` is affecting this method. Use {@link ClanWarAttack#previousBestAttack} instead.
      */
     previousBestOpponentAttack(): ClanWarAttack | null;
 }
@@ -131,7 +133,12 @@ export declare class ClanWar {
     getDefenses(defenderTag: string): ClanWarAttack[];
     /** Returns either `friendly`, `cwl` or `normal`. */
     get type(): "friendly" | "cwl" | "normal";
-    private get _isFriendly();
+    /** Whether this is a friendly war. */
+    get isFriendly(): boolean;
+    /** Whether this is a CWL. */
+    get isCWL(): boolean;
     /** Returns the war status, based off the home clan. */
     get status(): "win" | "lose" | "tie" | "pending";
+    /** Returns the Clan War League Group. */
+    getClanWarLeagueGroup(): Promise<import("./ClanWarLeagueGroup").ClanWarLeagueGroup> | null;
 }

package/dist/struct/ClanWar.js

@@ -75,6 +75,8 @@ class ClanWarMember {
     /**
      * Returns the previous best opponent attack on this village.
      * This is useful for calculating the new stars or destruction for new attacks.
+     *
+     * @deprecated `order` is affecting this method. Use {@link ClanWarAttack#previousBestAttack} instead.
      */
     previousBestOpponentAttack() {
         return (
@@ -170,16 +172,21 @@ class ClanWar {
     }
     /** Returns either `friendly`, `cwl` or `normal`. */
     get type() {
-        if (this._isFriendly)
+        if (this.isFriendly)
             return 'friendly';
         if (this.warTag)
             return 'cwl';
         return 'normal';
     }
-    get _isFriendly() {
+    /** Whether this is a friendly war. */
+    get isFriendly() {
         const preparationTime = this.startTime.getTime() - this.preparationStartTime.getTime();
         return Constants_1.FRIENDLY_WAR_PREPARATION_TIMES.includes(preparationTime);
     }
+    /** Whether this is a CWL. */
+    get isCWL() {
+        return typeof this.warTag === 'string';
+    }
     /** Returns the war status, based off the home clan. */
     get status() {
         if (this.state === 'preparation')
@@ -194,5 +201,11 @@ class ClanWar {
         }
         return 'lose';
     }
+    /** Returns the Clan War League Group. */
+    getClanWarLeagueGroup() {
+        if (!this.isCWL)
+            return null;
+        return this.client.getClanWarLeagueGroup(this.clan.tag);
+    }
 }
 exports.ClanWar = ClanWar;

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/package.json

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