clashofclans.js 2.4.0-dev.cedc2ac → 2.5.0-dev.597dedf

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.5.0 (2021-12-30)
+
+### Bug Fixes
+
+-   Fix caching issue with unnecessary/invalid query params. ([#91](https://github.com/clashperk/clashofclans.js/pull/91))
+-   Added necessary methods to `RESTManager` class. ([#92](https://github.com/clashperk/clashofclans.js/pull/92))
+
 ## 2.4.0 (2021-12-28)
 
 ### Features

package/dist/rest/RESTManager.d.ts

@@ -1,10 +1,24 @@
 import { RequestHandler } 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, SearchOptions, ClanSearchOptions, RESTOptions, OverrideOptions } from '../types';
+import { Util } from '../util/Util';
+import { APIClan, APIClanList, APIClanMemberList, APIClanRankingList, APIClanVersusRankingList, APIClanWar, APIClanWarLeagueGroup, APIClanWarLog, APIGoldPassSeason, APILabelList, APILeague, APILeagueList, APILeagueSeasonList, APILocation, APILocationList, APIPlayer, APIPlayerRankingList, APIPlayerSeasonRankingList, APIPlayerVersusRankingList, APIVerifyToken, APIWarLeague, APIWarLeagueList, SearchOptions, ClanSearchOptions, RESTOptions, OverrideOptions, LoginOptions } from '../types';
 /** Represents a REST Manager of the client. */
 export declare class RESTManager {
     /** Request Handler for the RESTManager. */
     readonly handler: RequestHandler;
     constructor(options?: RESTOptions);
+    /** Contains various general-purpose utility methods. */
+    get util(): typeof Util;
+    /**
+     * Initialize the client to create keys.
+     * @example
+     * ```
+     * const rest = new RESTManager();
+     * rest.login({ email: 'developer@email.com', password: '***' });
+     * ```
+     */
+    login(options: LoginOptions): Promise<string[]>;
+    /** Set Clash of Clans API keys. */
+    setKeys(keys: string[]): this;
     /** Search all clans by name and/or filtering the results using various criteria. */
     getClans(query: ClanSearchOptions, options?: OverrideOptions): Promise<import("../types").Response<APIClanList>>;
     /** Get info about a clan. */

package/dist/rest/RESTManager.js

@@ -8,9 +8,29 @@ class RESTManager {
     constructor(options) {
         this.handler = new RequestHandler_1.RequestHandler(options);
     }
+    /** Contains various general-purpose utility methods. */
+    get util() {
+        return Util_1.Util;
+    }
+    /**
+     * Initialize the client to create keys.
+     * @example
+     * ```
+     * const rest = new RESTManager();
+     * rest.login({ email: 'developer@email.com', password: '***' });
+     * ```
+     */
+    login(options) {
+        return this.handler.init(options);
+    }
+    /** Set Clash of Clans API keys. */
+    setKeys(keys) {
+        this.handler.setKeys(keys);
+        return this;
+    }
     /** Search all clans by name and/or filtering the results using various criteria. */
     getClans(query, options) {
-        return this.handler.request(`/clans?${Util_1.Util.queryString(query)}`, options);
+        return this.handler.request(`/clans${Util_1.Util.queryString(query)}`, options);
     }
     /** Get info about a clan. */
     getClan(clanTag, options) {
@@ -19,12 +39,12 @@ class RESTManager {
     /** Get list of clan members. */
     getClanMembers(clanTag, options) {
         const query = Util_1.Util.queryString(options);
-        return this.handler.request(`/clans/${Util_1.Util.encodeURI(clanTag)}/members?${query}`, options);
+        return this.handler.request(`/clans/${Util_1.Util.encodeURI(clanTag)}/members${query}`, options);
     }
     /** Get clan war log. */
     getClanWarLog(clanTag, options) {
         const query = Util_1.Util.queryString(options);
-        return this.handler.request(`/clans/${Util_1.Util.encodeURI(clanTag)}/warlog?${query}`, options);
+        return this.handler.request(`/clans/${Util_1.Util.encodeURI(clanTag)}/warlog${query}`, options);
     }
     /** Get info about currently running war in the clan. */
     getCurrentWar(clanTag, options) {
@@ -50,7 +70,7 @@ class RESTManager {
     /** Get list of Leagues. */
     getLeagues(options) {
         const query = Util_1.Util.queryString(options);
-        return this.handler.request(`/leagues?${query}`, options);
+        return this.handler.request(`/leagues${query}`, options);
     }
     /** Get a League info. */
     getLeague(leagueId, options) {
@@ -59,17 +79,17 @@ class RESTManager {
     /** Get Legend League season Ids. */
     getLeagueSeasons(leagueId, options) {
         const query = Util_1.Util.queryString(options);
-        return this.handler.request(`/leagues/${leagueId}/seasons?${query}`, options);
+        return this.handler.request(`/leagues/${leagueId}/seasons${query}`, options);
     }
     /** Get Legend League season rankings by season Id. */
     getSeasonRankings(leagueId, seasonId, options) {
         const query = Util_1.Util.queryString(options);
-        return this.handler.request(`/leagues/${leagueId}/seasons/${seasonId}?${query}`, options);
+        return this.handler.request(`/leagues/${leagueId}/seasons/${seasonId}${query}`, options);
     }
     /** Get list of Clan War Leagues. */
     getWarLeagues(options) {
         const query = Util_1.Util.queryString(options);
-        return this.handler.request(`/warleagues?${query}`, options);
+        return this.handler.request(`/warleagues${query}`, options);
     }
     /** Get info about a Clan War League. */
     getWarLeague(leagueId, options) {
@@ -78,7 +98,7 @@ class RESTManager {
     /** Get list of Locations. */
     getLocations(options) {
         const query = Util_1.Util.queryString(options);
-        return this.handler.request(`/locations?${query}`, options);
+        return this.handler.request(`/locations${query}`, options);
     }
     /** Get info about a Location. */
     getLocation(locationId, options) {
@@ -87,32 +107,32 @@ class RESTManager {
     /** Get clan rankings for a specific location. */
     getClanRanks(locationId, options) {
         const query = Util_1.Util.queryString(options);
-        return this.handler.request(`/locations/${locationId}/rankings/clans?${query}`, options);
+        return this.handler.request(`/locations/${locationId}/rankings/clans${query}`, options);
     }
     /** Get player rankings for a specific location. */
     getPlayerRanks(locationId, options) {
         const query = Util_1.Util.queryString(options);
-        return this.handler.request(`/locations/${locationId}/rankings/players?${query}`, options);
+        return this.handler.request(`/locations/${locationId}/rankings/players${query}`, options);
     }
     /** Get clan versus rankings for a specific location. */
     getVersusClanRanks(locationId, options) {
         const query = Util_1.Util.queryString(options);
-        return this.handler.request(`/locations/${locationId}/rankings/clans-versus?${query}`, options);
+        return this.handler.request(`/locations/${locationId}/rankings/clans-versus${query}`, options);
     }
     /** Get player versus rankings for a specific location. */
     getVersusPlayerRanks(locationId, options) {
         const query = Util_1.Util.queryString(options);
-        return this.handler.request(`/locations/${locationId}/rankings/players-versus?${query}`, options);
+        return this.handler.request(`/locations/${locationId}/rankings/players-versus${query}`, options);
     }
     /** Get list of clan labels. */
     getClanLabels(options) {
         const query = Util_1.Util.queryString(options);
-        return this.handler.request(`/labels/clans?${query}`, options);
+        return this.handler.request(`/labels/clans${query}`, options);
     }
     /** Get list of player labels. */
     getPlayerLabels(options) {
         const query = Util_1.Util.queryString(options);
-        return this.handler.request(`/labels/players?${query}`, options);
+        return this.handler.request(`/labels/players${query}`, options);
     }
     /** Get info about gold pass season. */
     getGoldPassSeason(options) {

package/dist/rest/RequestHandler.js

@@ -88,8 +88,8 @@ class RequestHandler {
         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, status: res?.status ?? 504 }, maxAge);
+        if (this.cached && maxAge > 0 && options.cache !== false && res?.ok) {
+            await this.cached.set(path, { data, ttl: Date.now() + maxAge, status: res.status }, maxAge);
         }
         return { data, maxAge, status: res?.status ?? 504, path, ok: res?.status === 200 };
     }

package/dist/util/Util.d.ts

@@ -1,3 +1,4 @@
+import { ClanSearchOptions, SearchOptions } from '../types';
 /** Contains various general-purpose utility methods. */
 export declare class Util extends null {
     /**
@@ -30,7 +31,7 @@ export declare class Util extends null {
     /** Converts API Date to JavaScript Date. */
     static formatDate(date: string): Date;
     /** Returns a string containing a query string suitable for use in a URL. */
-    static queryString(options?: {}): string;
+    static queryString(options?: SearchOptions | ClanSearchOptions): string;
     private static getSeasonEnd;
     /** Get current trophy season Id. */
     static getSeasonId(): string;

package/dist/util/Util.js

@@ -2,6 +2,19 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Util = void 0;
 const TAG_CHARACTERS = '0289PYLQGRJCUV';
+const params = [
+    'name',
+    'minMembers',
+    'maxMembers',
+    'minClanPoints',
+    'minClanLevel',
+    'warFrequency',
+    'locationId',
+    'labelIds',
+    'limit',
+    'after',
+    'before'
+];
 /** Contains various general-purpose utility methods. */
 class Util extends null {
     /**
@@ -62,10 +75,8 @@ class Util extends null {
     }
     /** Returns a string containing a query string suitable for use in a URL. */
     static queryString(options = {}) {
-        const query = new URLSearchParams(options);
-        for (const key of ['cache', 'force', 'retryLimit', 'ignoreRateLimit', 'restRequestTimeout'])
-            query.delete(key);
-        return query.toString();
+        const query = new URLSearchParams(Object.entries(options).filter(([key]) => params.includes(key))).toString();
+        return query.length ? `?${query}` : query;
     }
     static getSeasonEnd(month, year, autoFix = true) {
         const now = new Date();

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "clashofclans.js",
-	"version": "2.4.0-dev.cedc2ac",
+	"version": "2.5.0-dev.597dedf",
 	"description": "JavaScript library for interacting with the Clash of Clans API",
 	"author": "SUVAJIT <suvajit.me@gmail.com>",
 	"license": "MIT",
@@ -22,7 +22,9 @@
 	"keywords": [
 		"clash-of-clans-api",
 		"clash-of-clans",
-		"clash-api"
+		"clash-api",
+		"supercell",
+		"coc"
 	],
 	"bugs": {
 		"url": "https://github.com/clashperk/clashofclans.js/issues"