clashofclans.js 2.5.2-dev.12b59ce → 2.6.0-dev.8cacb3e

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 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.0
+
+## Features
+
+-   Replaced Keyv with customizable cache store ([#99](https://github.com/clashperk/clashofclans.js/pull/99))
+-   Guide for [Internal Caching](https://clashofclans.js.org/guide/internal-caching)
+
 ## 2.5.2 (2022-01-23)
 
 ### Bug Fixes

package/dist/client/Client.js

@@ -18,7 +18,7 @@ const struct_1 = require("../struct");
 class Client extends events_1.EventEmitter {
     constructor(options) {
         super();
-        this.rest = new RESTManager_1.RESTManager(options);
+        this.rest = new RESTManager_1.RESTManager({ ...options, rejectIfNotValid: true });
         this.events = new EventManager_1.EventManager(this);
     }
     /** Contains various general-purpose utility methods. */
@@ -150,7 +150,10 @@ class Client extends events_1.EventEmitter {
     }
     /** Get info about clan war league. */
     async getClanWarLeagueGroup(clanTag, options) {
-        const { data } = await this.rest.getClanWarLeagueGroup(clanTag, options);
+        const { data, status, path, maxAge } = await this.rest.getClanWarLeagueGroup(clanTag, options);
+        if (data.state === 'notInWar') {
+            throw new HTTPError_1.HTTPError(HTTPError_1.NotInWarError, status, path, maxAge);
+        }
         return new struct_1.ClanWarLeagueGroup(this, data);
     }
     /** Get info about a CWL round by WarTag. */

package/dist/rest/RequestHandler.d.ts

@@ -18,6 +18,7 @@ export declare class RequestHandler {
     private get _keys();
     private get _key();
     setKeys(keys: string[]): this;
+    private get creds();
     request<T>(path: string, options?: RequestOptions): Promise<Response<T>>;
     private exec;
     init(options: LoginOptions): Promise<string[]>;

package/dist/rest/RequestHandler.js

@@ -50,6 +50,9 @@ class RequestHandler {
         this.keys = keys;
         return this;
     }
+    get creds() {
+        return Boolean(this.email && this.password);
+    }
     async request(path, options = {}) {
         const cached = (await this.cached?.get(path)) ?? null;
         if (cached && options.force !== true) {
@@ -76,8 +79,11 @@ class RequestHandler {
         const data = await res?.json().catch(() => null);
         if (!res && retries < (options.retryLimit ?? this.retryLimit))
             return this.exec(path, options, ++retries);
-        if (res?.status === 403 && data?.reason === 'accessDenied.invalidIp' && this.email && this.password) {
-            const keys = await this.reValidateKeys().then(() => this.login());
+        if (this.creds &&
+            res?.status === 403 &&
+            data?.reason === 'accessDenied.invalidIp' &&
+            retries < (options.retryLimit ?? this.retryLimit)) {
+            const keys = await this.reValidateKeys().then(() => () => this.login());
             if (keys.length)
                 return this.exec(path, options, ++retries);
         }
@@ -114,7 +120,7 @@ class RequestHandler {
             if (res?.status === 403) {
                 const index = this.keys.indexOf(key);
                 this.keys.splice(index, 1);
-                process.emitWarning(`Pre-defined key #${index + 1} is no longer valid. Removed from the key list.`);
+                process.emitWarning(`Key #${index + 1} is no longer valid. Removed from the key list.`);
             }
         }
     }
@@ -145,14 +151,14 @@ class RequestHandler {
         // Get all available keys from the developer site.
         const keys = (data.keys ?? []);
         // Revoke keys for specified key name but not matching current IP address.
-        for (const key of keys.filter((key) => key.name === this.keyName && !key.cidrRanges.includes(ip))) {
+        for (const key of keys.filter((key) => key.name === this.keyName && !key.cidrRanges?.includes(ip))) {
             if (!(await this.revokeKey(key.id, cookie)))
                 continue;
             const index = keys.findIndex(({ id }) => id === key.id);
             keys.splice(index, 1);
         }
         // Filter keys for current IP address and specified key name.
-        for (const key of keys.filter((key) => key.name === this.keyName && key.cidrRanges.includes(ip))) {
+        for (const key of keys.filter((key) => key.name === this.keyName && key.cidrRanges?.includes(ip))) {
             if (this.keys.length >= this.keyCount)
                 break;
             if (!this.keys.includes(key.key))

package/dist/struct/ClanWarLeagueGroup.js

@@ -41,6 +41,7 @@ exports.ClanWarLeagueRound = ClanWarLeagueRound;
 class ClanWarLeagueGroup {
     constructor(client, data) {
         this.client = client;
+        // @ts-expect-error
         this.state = data.state;
         this.season = data.season;
         this.clans = data.clans.map((clan) => new ClanWarLeagueClan(client, clan));

package/dist/types/api.d.ts

@@ -139,7 +139,7 @@ export interface APIClanWarLog {
 }
 /** /clans/{clanTag}/currentwar/leaguegroup */
 export interface APIClanWarLeagueGroup {
-    state: 'preparation' | 'inWar' | 'ended';
+    state: 'notInWar' | 'preparation' | 'inWar' | 'ended';
     season: string;
     clans: APIClanWarLeagueClan[];
     rounds: APIClanWarLeagueRound[];

package/dist/types/lib.d.ts

@@ -67,7 +67,7 @@ export interface OverrideOptions {
     /** Whether to skip the cache check and request the API. */
     force?: boolean;
     /** How many times to retry on 5XX errors. */
-    retryLimit?: string;
+    retryLimit?: number;
     /** Whether to ignore throttlers. */
     ignoreRateLimit?: boolean;
     /** Time to wait before cancelling a REST request, in milliseconds. */

package/dist/util/Store.d.ts

@@ -3,7 +3,7 @@ export interface CacheOptions {
     /**
      * How frequently to remove data from cache that are older than the lifetime/ttl (in milliseconds, 0 for never)
      *
-     * To prevent high CPU usage, set a higher value (30-60 seconds recommended)
+     * To prevent high CPU usage, set a higher value (>= 30 seconds)
      *
      * @default 120000 (2 minutes)
      */
@@ -15,9 +15,9 @@ export interface CacheOptions {
      */
     ttl?: number;
 }
-export declare class CacheStore<T = any> implements Store<T> {
+export declare class CacheStore<T> implements Store<T> {
     private readonly ttl;
-    private readonly sweepInterval?;
+    private readonly sweepInterval;
     private readonly store;
     constructor(options?: CacheOptions);
     private _sweep;

package/dist/util/Util.js

@@ -28,7 +28,10 @@ class Util extends null {
     }
     /** @internal */
     static parseTag(tag) {
-        return `#${tag.toUpperCase().replace(/O/g, '0').replace(/^#/g, '').replace(/\s/g, '')}`;
+        if (tag && typeof tag === 'string') {
+            return `#${tag.toUpperCase().replace(/O/g, '0').replace(/^#/g, '').replace(/\s/g, '')}`;
+        }
+        throw new TypeError('The "tag" argument must be of type string.');
     }
     /** Encodes a tag as a valid component of a URI. */
     static encodeURI(tag) {
@@ -47,7 +50,7 @@ class Util extends null {
     static encodeTag(tag) {
         const formatted = this.formatTag(tag).substring(1);
         if (!this.isValidTag(formatted)) {
-            throw new Error(`Failed to encode tag ${formatted}. RegExp matching failed.`);
+            throw new TypeError(`Failed to encode tag ${formatted}. RegExp matching failed.`);
         }
         const result = formatted.split('').reduce((sum, char) => sum * BigInt(14) + BigInt(TAG_CHARACTERS.indexOf(char)), BigInt(0));
         return result.toString();

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "clashofclans.js",
-	"version": "2.5.2-dev.12b59ce",
+	"version": "2.6.0-dev.8cacb3e",
 	"description": "JavaScript library for interacting with the Clash of Clans API",
 	"author": "SUVAJIT <suvajit.me@gmail.com>",
 	"license": "MIT",