clashofclans.js 2.5.2-dev.09bde37 → 2.6.0-dev.3d6d64a

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

@@ -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/index.d.ts

@@ -8,3 +8,4 @@ export * from './util/Util';
 export * from './struct';
 export * from './types';
 export * from './util/Constants';
+export * from './util/Store';

package/dist/index.js

@@ -20,3 +20,4 @@ __exportStar(require("./util/Util"), exports);
 __exportStar(require("./struct"), exports);
 __exportStar(require("./types"), exports);
 __exportStar(require("./util/Constants"), exports);
+__exportStar(require("./util/Store"), exports);

package/dist/rest/HTTPError.js

@@ -11,7 +11,7 @@ const messages = {
     403: 'Access denied, either because of missing/incorrect credentials or used API token does not grant access to the requested resource.'
 };
 const reasons = {
-    503: 'serviceUnavailable',
+    503: 'inMaintenance',
     429: 'requestThrottled',
     400: 'badRequest',
     403: 'accessDenied',

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

@@ -18,9 +18,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.RequestHandler = void 0;
 const Constants_1 = require("../util/Constants");
 const HTTPError_1 = require("./HTTPError");
+const Store_1 = require("../util/Store");
 const node_fetch_1 = __importDefault(require("node-fetch"));
 const https_1 = __importDefault(require("https"));
-const keyv_1 = __importDefault(require("keyv"));
 const IP_REGEX = /\d{1,3}.\d{1,3}.\d{1,3}.\d{1,3}/g;
 const agent = new https_1.default.Agent({ keepAlive: true });
 /** Represents a Request Handler. */
@@ -33,10 +33,10 @@ class RequestHandler {
         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)
+        if (typeof options?.cache === 'object')
             this.cached = options.cache;
         else
-            this.cached = options?.cache ? new keyv_1.default() : null;
+            this.cached = options?.cache === true ? new Store_1.CacheStore() : null;
     }
     get _keys() {
         return Array.isArray(this.keys) ? this.keys : [this.keys];
@@ -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

@@ -1,5 +1,10 @@
 import { QueueThrottler, BatchThrottler } from '../rest/Throttler';
-import Keyv from 'keyv';
+export interface Store<T = any> {
+    set(key: string, value: T, ttl?: number): boolean | Promise<boolean>;
+    get(key: string): T | null | Promise<T | null>;
+    delete(key: string): boolean | Promise<boolean>;
+    clear(): void | Promise<void>;
+}
 /** Options for a Client. */
 export interface ClientOptions {
     /** Keys from Clash of Clans API developer site. */
@@ -17,7 +22,7 @@ export interface ClientOptions {
      * const client = new Client({ cache: true });
      * ```
      */
-    cache?: boolean | Keyv;
+    cache?: boolean | Store;
     /** Time to wait before cancelling a REST request, in milliseconds. */
     restRequestTimeout?: number;
     /**
@@ -62,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

@@ -0,0 +1,28 @@
+import { Store } from '../types';
+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 seconds)
+     *
+     * @default 120000 (2 minutes)
+     */
+    sweepInterval?: number;
+    /**
+     * How long a data should stay in the cache until it is considered sweepable (in milliseconds, 0 for forever)
+     *
+     * @default 0
+     */
+    ttl?: number;
+}
+export declare class CacheStore<T = any> implements Store<T> {
+    private readonly ttl;
+    private readonly sweepInterval?;
+    private readonly store;
+    constructor(options?: CacheOptions);
+    private _sweep;
+    set(key: string, value: T, ttl?: number): boolean;
+    get(key: string): T | null;
+    delete(key: string): boolean;
+    clear(): void;
+}

package/dist/util/Store.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CacheStore = void 0;
+class CacheStore {
+    constructor(options) {
+        this.store = new Map();
+        this.ttl = options?.ttl ?? 0;
+        this.sweepInterval = options?.sweepInterval ?? 2 * 60 * 1000;
+        if (this.sweepInterval > 0)
+            this._sweep(); // sweep expired cache
+    }
+    _sweep() {
+        setInterval(() => {
+            for (const cache of this.store.values()) {
+                if (cache.expires > 0 && Date.now() > cache.expires) {
+                    this.store.delete(cache.key);
+                }
+            }
+        }, Math.max(this.sweepInterval, 30 * 1000));
+    }
+    set(key, value, ttl = 0) {
+        const expires = ttl > 0 ? Date.now() + ttl : this.ttl > 0 ? Date.now() + this.ttl : 0;
+        this.store.set(key, { value, expires, key });
+        return true;
+    }
+    get(key) {
+        const data = this.store.get(key);
+        if (!data)
+            return null;
+        if (data.expires > 0 && Date.now() > data.expires) {
+            this.store.delete(key);
+            return null;
+        }
+        return data.value;
+    }
+    delete(key) {
+        return this.store.delete(key);
+    }
+    clear() {
+        return this.store.clear();
+    }
+}
+exports.CacheStore = CacheStore;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "clashofclans.js",
-	"version": "2.5.2-dev.09bde37",
+	"version": "2.6.0-dev.3d6d64a",
 	"description": "JavaScript library for interacting with the Clash of Clans API",
 	"author": "SUVAJIT <suvajit.me@gmail.com>",
 	"license": "MIT",
@@ -93,11 +93,9 @@
 		}
 	},
 	"dependencies": {
-		"keyv": "^4.0.4",
 		"node-fetch": "^2.6.7"
 	},
 	"devDependencies": {
-		"@types/keyv": "^3.1.3",
 		"@types/node": "^16.10.3",
 		"@types/node-fetch": "^2.5.12",
 		"@typescript-eslint/eslint-plugin": "^5.4.0",