clashofclans.js 3.3.4 → 3.3.5-dev.560656b

package/dist/client/PollingClient.js

@@ -175,7 +175,7 @@ class PollingClient extends Client_1.Client {
         }
     }
     seasonEndHandler() {
-        const end = this.util.getSeasonEndTime().getTime() - Date.now();
+        const end = this.util.getSeason().endTime.getTime() - Date.now();
         // Why this? setTimeout can be up to 24.8 days or 2147483647ms [(2^31 - 1) Max 32bit Integer]
         if (end > 24 * 60 * 60 * 1000) {
             setTimeout(this.seasonEndHandler.bind(this), 60 * 60 * 1000);

package/dist/rest/RequestHandler.d.ts

@@ -43,6 +43,7 @@ export declare class RequestHandler extends EventEmitter {
     private readonly restRequestTimeout;
     private readonly throttler?;
     private readonly cached;
+    private readonly onError?;
     private readonly dispatcher;
     constructor(options?: RequestHandlerOptions);
     private get _keys();
@@ -52,6 +53,7 @@ export declare class RequestHandler extends EventEmitter {
     request<T>(path: string, options?: RequestOptions): Promise<Result<T>>;
     rawRequest<T>(path: string, options?: RequestOptions): Promise<T>;
     private exec;
+    private dispatch;
     init(options: LoginOptions): Promise<string[]>;
     private reValidateKeys;
     private login;

package/dist/rest/RequestHandler.js

@@ -25,6 +25,7 @@ class RequestHandler extends node_events_1.EventEmitter {
     constructor(options) {
         super();
         _RequestHandler_keyIndex.set(this, 0); // eslint-disable-line
+        this.onError = options?.onError;
         this.keys = options?.keys ?? [];
         this.retryLimit = options?.retryLimit ?? 0;
         this.throttler = options?.throttler ?? null;
@@ -76,9 +77,15 @@ class RequestHandler extends node_events_1.EventEmitter {
         if (!this.throttler || options.ignoreRateLimit)
             return this.exec(path, options).then((res) => res.body);
         await this.throttler.wait();
-        return this.exec(path, options).then((res) => res.body);
+        const result = await this.exec(path, options);
+        return result.body;
     }
     async exec(path, options = {}, retries = 0) {
+        const result = await this.dispatch(path, options, retries);
+        this.onError?.({ path, status: result.res.status, body: result.body });
+        return result;
+    }
+    async dispatch(path, options = {}, retries = 0) {
         try {
             const res = await this.dispatcher.request({
                 path: `/v1${path}`,

package/dist/root.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/root.spec.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const Client_1 = require("./client/Client");
+describe('root', () => {
+    const client = new Client_1.Client({ baseURL: process.env.BASE_URL });
+    it('should return a player', async () => {
+        const result = await client.getPlayer('#LUV2PG2Y9');
+        console.log({
+            name: result.name,
+            tag: result.tag,
+            troops: result.troops.map((troop) => troop.name),
+            spells: result.spells.map((spell) => spell.name),
+            heroes: result.heroes.map((hero) => hero.name)
+        });
+        expect(result).toHaveProperty('tag');
+    });
+    it('should return a clan', async () => {
+        const result = await client.getClan('#8QU8J9LP');
+        console.log({
+            name: result.name,
+            tag: result.tag
+        });
+        expect(result).toHaveProperty('tag');
+    });
+});

package/dist/types/lib.d.ts

@@ -55,6 +55,11 @@ export interface RequestHandlerOptions extends ClientOptions {
     connections?: number;
     /** The amount of concurrent requests to be sent over the single TCP/TLS connection according to RFC7230. Default: 1 */
     pipelining?: number;
+    onError?: (args: {
+        path: string;
+        status: number;
+        body: unknown;
+    }) => unknown;
 }
 /** Search options for request. */
 export interface SearchOptions extends OverrideOptions {

package/dist/util/Util.d.ts

@@ -33,11 +33,19 @@ export declare class Util extends null {
     static formatDate(date: string): Date;
     /** Returns a string containing a query string suitable for use in a URL. */
     static queryString(options?: SearchOptions | ClanSearchOptions): string;
-    private static getSeasonEnd;
-    /** Get current trophy season Id. */
+    static getSeasonStart(inputDate: Date): Date;
+    static getSeasonEnd(inputDate: Date, forward?: boolean): Date;
+    /** Get the current season ID. */
     static getSeasonId(): string;
-    /** Get trophy season end timestamp. */
-    static getSeasonEndTime(timestamp?: Date): Date;
+    /**
+     * Get the season start and end timestamp.
+     * @param {Date} timestamp - The reference date. Defaults to the current date if not provided.
+     * @param {boolean} forward - Whether to forward to the next month if the returned date is in the past relative to the given timestamp. Defaults to true.
+     */
+    static getSeason(timestamp?: Date, forward?: boolean): {
+        endTime: Date;
+        startTime: Date;
+    };
     static allSettled<T>(values: Promise<T>[]): Promise<T[]>;
     static delay(ms: number): Promise<unknown>;
     /** Parse in-game army link into troops and spells count with respective Id's. */

package/dist/util/Util.js

@@ -63,7 +63,7 @@ class Util extends null {
      * ```
      */
     static encodeTag(tag) {
-        const formatted = this.formatTag(tag).substring(1);
+        const formatted = this.formatTag(tag).slice(1);
         if (!this.isValidTag(formatted)) {
             throw new TypeError(`Failed to encode tag ${formatted}. RegExp matching failed.`);
         }
@@ -96,27 +96,43 @@ class Util extends null {
         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();
-        now.setUTCFullYear(year);
-        now.setUTCMonth(month, 0);
-        now.setUTCHours(5, 0, 0, 0);
-        const newDate = now.getUTCDay() === 0 ? now.getUTCDate() - 6 : now.getUTCDate() - (now.getUTCDay() - 1);
-        now.setUTCDate(newDate);
-        if (Date.now() >= now.getTime() && autoFix) {
-            return this.getSeasonEnd(month + 1, year);
+    static getSeasonStart(inputDate) {
+        const lastMonthLastDay = new Date(Date.UTC(inputDate.getUTCFullYear(), inputDate.getUTCMonth(), 0));
+        const lastMonthLastMonday = new Date(lastMonthLastDay);
+        lastMonthLastMonday.setUTCDate(lastMonthLastMonday.getUTCDate() - ((lastMonthLastDay.getUTCDay() + 6) % 7));
+        lastMonthLastMonday.setUTCHours(5, 0, 0, 0);
+        return lastMonthLastMonday;
+    }
+    static getSeasonEnd(inputDate, forward = true) {
+        const lastDayOfMonth = new Date(Date.UTC(inputDate.getUTCFullYear(), inputDate.getUTCMonth() + 1, 0));
+        const lastMonday = new Date(lastDayOfMonth);
+        lastMonday.setUTCDate(lastMonday.getUTCDate() - ((lastDayOfMonth.getUTCDay() + 6) % 7));
+        lastMonday.setUTCHours(5, 0, 0, 0);
+        // check if the last Monday is in the past relative to the input date
+        if (lastMonday.getTime() < inputDate.getTime() && forward) {
+            // calculate the last Monday of the next month
+            const nextMonth = new Date(Date.UTC(inputDate.getUTCFullYear(), inputDate.getUTCMonth() + 1, 1));
+            const nextMonthLastDay = new Date(Date.UTC(nextMonth.getUTCFullYear(), nextMonth.getUTCMonth() + 1, 0));
+            const nextMonthLastMonday = new Date(nextMonthLastDay);
+            nextMonthLastMonday.setUTCDate(nextMonthLastMonday.getUTCDate() - ((nextMonthLastDay.getUTCDay() + 6) % 7));
+            nextMonthLastMonday.setUTCHours(5, 0, 0, 0);
+            return nextMonthLastMonday;
         }
-        return now;
+        return lastMonday;
     }
-    /** Get current trophy season Id. */
+    /** Get the current season ID. */
     static getSeasonId() {
-        return this.getSeasonEndTime().toISOString().substring(0, 7);
+        return this.getSeasonEnd(new Date()).toISOString().slice(0, 7);
     }
-    /** Get trophy season end timestamp. */
-    static getSeasonEndTime(timestamp) {
-        const autoFix = !(timestamp instanceof Date);
-        const date = timestamp instanceof Date ? timestamp : new Date();
-        return this.getSeasonEnd(date.getUTCMonth() + 1, date.getUTCFullYear(), autoFix);
+    /**
+     * Get the season start and end timestamp.
+     * @param {Date} timestamp - The reference date. Defaults to the current date if not provided.
+     * @param {boolean} forward - Whether to forward to the next month if the returned date is in the past relative to the given timestamp. Defaults to true.
+     */
+    static getSeason(timestamp, forward = true) {
+        const endTime = this.getSeasonEnd(timestamp ?? new Date(), forward);
+        const startTime = this.getSeasonStart(endTime);
+        return { endTime, startTime };
     }
     static async allSettled(values) {
         return (await Promise.allSettled(values))

package/dist/util.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/util.spec.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const Util_1 = require("./util/Util");
+describe('util', () => {
+    it('should always be UTC', () => {
+        expect(new Date().getTimezoneOffset()).toBe(0);
+    });
+    it('should forward to next month if the given date is in the past', async () => {
+        const timestamp = new Date('2024-03-25T05:01');
+        const { endTime, startTime } = Util_1.Util.getSeason(timestamp);
+        const expectedEndTime = new Date('2024-04-29T05:00').toISOString();
+        const expectedStartTime = new Date('2024-03-25T05:00').toISOString();
+        expect(endTime.toISOString()).toBe(expectedEndTime);
+        expect(startTime.toISOString()).toBe(expectedStartTime);
+    });
+    it('should not forward to next month even if the given date is in the past', async () => {
+        const timestamp = new Date('2024-03-25T05:01');
+        const { endTime, startTime } = Util_1.Util.getSeason(timestamp, false);
+        const expectedEndTime = new Date('2024-03-25T05:00').toISOString();
+        const expectedStartTime = new Date('2024-02-26T05:00').toISOString();
+        expect(endTime.toISOString()).toBe(expectedEndTime);
+        expect(startTime.toISOString()).toBe(expectedStartTime);
+    });
+    it('should return the correct season against a date', async () => {
+        const timestamp = new Date('2024-03-16T05:01');
+        const { endTime, startTime } = Util_1.Util.getSeason(timestamp);
+        const expectedEndTime = new Date('2024-03-25T05:00').toISOString();
+        const expectedStartTime = new Date('2024-02-26T05:00').toISOString();
+        expect(endTime.toISOString()).toBe(expectedEndTime);
+        expect(startTime.toISOString()).toBe(expectedStartTime);
+    });
+    it('should forward to the next year at the end of the year', async () => {
+        const timestamp = new Date('2024-12-30T05:01');
+        const { endTime, startTime } = Util_1.Util.getSeason(timestamp);
+        const expectedEndTime = new Date('2025-01-27T05:00').toISOString();
+        const expectedStartTime = new Date('2024-12-30T05:00').toISOString();
+        expect(endTime.toISOString()).toBe(expectedEndTime);
+        expect(startTime.toISOString()).toBe(expectedStartTime);
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "clashofclans.js",
-	"version": "3.3.4",
+	"version": "3.3.5-dev.560656b",
 	"description": "JavaScript library for interacting with the Clash of Clans API",
 	"author": "https://clashofclans.js.org",
 	"license": "MIT",
@@ -20,8 +20,10 @@
 	"scripts": {
 		"build": "tsc && gen-esm-wrapper dist/index.js dist/index.mjs",
 		"prepare": "rimraf dist && npm run build",
-		"test": "eslint --ext .ts --ignore-path .gitignore .",
-		"lint": "eslint --fix --ext .ts --ignore-path .gitignore ."
+		"lint:test": "eslint --ext .ts --ignore-path .gitignore .",
+		"lint:fix": "eslint --fix --ext .ts --ignore-path .gitignore .",
+		"test": "TZ=UTC jest --setupFiles dotenv/config --config ./jest.config.json",
+		"test:watch": "npm run test -- --watch"
 	},
 	"files": [
 		"dist"
@@ -49,9 +51,12 @@
 		}
 	},
 	"dependencies": {
+		"jest": "^29.7.0",
 		"undici": "^5.23.0"
 	},
 	"devDependencies": {
+		"@jest/globals": "^29.7.0",
+		"@types/jest": "^29.5.12",
 		"@types/node": "^18.17.5",
 		"@typescript-eslint/eslint-plugin": "^6.3.0",
 		"@typescript-eslint/parser": "^6.3.0",
@@ -62,9 +67,10 @@
 		"gen-esm-wrapper": "^1.1.3",
 		"prettier": "^3.0.1",
 		"rimraf": "^5.0.1",
+		"ts-jest": "^29.1.2",
 		"typescript": "^5.1.6"
 	},
 	"engines": {
 		"node": ">=16.x"
 	}
-}
+}

package/CHANGELOG.md

@@ -1,173 +0,0 @@
-# Changelog
-
-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.
-
-## 3.1.3 (24-12-2023)
-
-### Features
-
-- Town Hall 16 updates.
-- Removed deprecated builder base properties.
-
-## 3.1.3 (13-08-2023)
-
-### Features
-
-- Switched to `undici` from `node-fetch` for better performance.
-
-## 3.1.0 (2023-07-28)
-
-### Features
-
-- Builder base update and new troop levels.
-
-## 3.0.2 (2023-01-15)
-
-### Bug Fixes
-
-- Conflict with the same name of builder base and home base troops. (#123)
-- Fix the issue with the `Client#getLeagueWar()` method.
-- Typings and documentation for clan capital.
-- Fix the issue with the `Clan#clanCapital` property.
-
-### Features
-
-- Added `Client#getCapitalRaidSeasons()` method.
-- Added `Client#getCapitalLeagues()` method.
-- Added `Client#getClanCapitalRanks()` method.
-- Added new Super Troops in raw.json file.
-
-### Breaking Changes
-
-- Using PascalCase instead of SCREAMING_SNAKE_CASE ([#115](https://github.com/clashperk/clashofclans.js/pull/115))
-- `Client#events` and `EventManager` have been removed in favor of `PollingClient` ([#117](https://github.com/clashperk/clashofclans.js/pull/117), [#127](https://github.com/clashperk/clashofclans.js/pull/127))
-
-## 2.8.0 (2022-07-22)
-
-### Features
-
-- Better Throttler with JS generator function. ([#111](https://github.com/clashperk/clashofclans.js/pull/111))
-- Updated raw data from game files. ([#111](https://github.com/clashperk/clashofclans.js/pull/111))
-- New method Util#parseArmyLink has been added. ([#110](https://github.com/clashperk/clashofclans.js/pull/110))
-
-## 2.7.0 (2022-05-22)
-
-### Features
-
-- Some useful QOL methods have been added. ([#106](https://github.com/clashperk/clashofclans.js/pull/106))
-
-## 2.6.1 (2022-02-03)
-
-### Bug Fixes
-
-- New value and typings `notInWar` added for `ClanWarLeagueGroup#state` ([#101](https://github.com/clashperk/clashofclans.js/pull/101))
-- Throw error if `Util.formatTag` / `Util.parseTag` is called with invalid argument ([#102](https://github.com/clashperk/clashofclans.js/pull/101))
-
-## 2.6.0 (2022-01-29)
-
-## 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
-
-- Fix `ClanWar#attacksPerMembers` property ([#97](https://github.com/clashperk/clashofclans.js/pull/97))
-- Bump `node-fetch` from 2.6.6 to 2.6.7 ([#96](https://github.com/clashperk/clashofclans.js/pull/96))
-
-## 2.5.1 (2022-01-11)
-
-### Bug Fixes
-
-- Typings for `ClanWarLeagueGroup#state` property. ([#94](https://github.com/clashperk/clashofclans.js/pull/94))
-
-## 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
-
-- `ClanWar#getClanWarLeagueGroup`, `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` methods. [Know more?](https://clashofclans.js.org/guide/access-raw-data#easy-access) ([#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
-
-- BigInt literals issue fixed. ([#84](https://github.com/clashperk/clashofclans.js/pull/84))
-- Some Utility methods renamed. ([#84](https://github.com/clashperk/clashofclans.js/pull/84))
-  - `Util.encodeTag()` to `Util.encodeURI()`
-  - `Util.encodeTagToId()` to `Util.encodeTag()`
-  - `Util.decodeIdToTag()` to `Util.decodeTag()`
-- Added `dps`, `resourceType`, `trainingTime` and `regenerationTime` to the `Unit` class. ([#85](https://github.com/clashperk/clashofclans.js/pull/85))
-
-## 2.2.0 (2021-12-16)
-
-### Bug Fixes
-
-- Show units as per in-game orders. ([#82](https://github.com/clashperk/clashofclans.js/pull/82)) ([6e23d2f](https://github.com/clashperk/clashofclans.js/commit/95cf3001059fd3ede9262e249814178631660d5b))
-- Season end time utility method. ([#82](https://github.com/clashperk/clashofclans.js/pull/82)) ([6e23d2f](https://github.com/clashperk/clashofclans.js/commit/95cf3001059fd3ede9262e249814178631660d5b))
-- Updated raw files for new Troops. ([#82](https://github.com/clashperk/clashofclans.js/pull/82)) ([6e23d2f](https://github.com/clashperk/clashofclans.js/commit/95cf3001059fd3ede9262e249814178631660d5b))
-
-### Features
-
-- Added `seasonal`, `boostable` and `isLoaded` property to `Unit` class. ([#82](https://github.com/clashperk/clashofclans.js/pull/82)) ([6e23d2f](https://github.com/clashperk/clashofclans.js/commit/95cf3001059fd3ede9262e249814178631660d5b))
-
-## 2.1.0 (2021-12-06)
-
-### Bug Fixes
-
-- Consistency of `ClanWar.attacksPerMember` property. ([#75](https://github.com/clashperk/clashofclans.js/pull/75)) ([6e23d2f](https://github.com/clashperk/clashofclans.js/commit/6e23d2fe0373f56268ffa55d5ac2807c9a2dc2fc))
-
-### Features
-
-- More utility methods added to `Util` class. ([#76](https://github.com/clashperk/clashofclans.js/pull/76)) ([ff41115](https://github.com/clashperk/clashofclans.js/commit/ff4111530d6293ef1fc54aa916436130fc30a09c))
-
-  - `Util.formatTag(tag: string): string`
-  - `Util.formatDate(date: string): Date`
-  - `Util.isValidTag(tag: string): boolean`
-  - `Util.encodeTagToId(tag: string): string` (Removed on 2.3.0)
-  - `Util.decodeIdToTag(id: string): string` (Removed on 2.3.0)
-
-- Support of async/await for custom events ([#79](https://github.com/clashperk/clashofclans.js/pull/79)) ([ff41115](https://github.com/clashperk/clashofclans.js/commit/a23db3786bcca44b8547c70f27773bdb1216f990))
-
-## 2.0.2 (2021-11-30)
-
-### Bug Fixes
-
-- Return `null` for `RankedPlayer.clan` if they are not in the clan. ([#73](https://github.com/clashperk/clashofclans.js/pull/73)) ([ba82327](https://github.com/clashperk/clashofclans.js/commit/ba8232740f4ca9af2bcc7971aca3574612ef25b6))
-- `OverrideOptions` added for `Client#getClans` and `RESTManager#getClans` ([#73](https://github.com/clashperk/clashofclans.js/pull/73)) ([ba82327](https://github.com/clashperk/clashofclans.js/commit/ba8232740f4ca9af2bcc7971aca3574612ef25b6))
-- `SeasonRankedPlayer` class for legend league ranking. ([#73](https://github.com/clashperk/clashofclans.js/pull/73)) ([ba82327](https://github.com/clashperk/clashofclans.js/commit/ba8232740f4ca9af2bcc7971aca3574612ef25b6))
-
-## 2.0.1 (2021-11-27)
-
-### Bug Fixes
-
-- IP retrieval method and Event Loop ([#70](https://github.com/clashperk/clashofclans.js/issues/70)) ([82b84ba](https://github.com/clashperk/clashofclans.js/commit/82b84ba5d96505c43b75e53aa07f547ef0b77778))
-
-## 2.0.0 (2021-11-26)
-
-This new version is a complete TypeScript rewrite to convert everything from plain (literal JSON) objects to class (constructor) objects and support a lot more features.
-
-### Features
-
-- HTTP Request Request Retries ([#26](https://github.com/clashperk/clashofclans.js/issues/26)) ([94585f3](https://github.com/clashperk/clashofclans.js/commit/94585f3a84a7175b2d07872f9eb9e42372b95e12))
-- Event Manager and Custom Events ([#37](https://github.com/clashperk/clashofclans.js/issues/37)) ([5027ae6](https://github.com/clashperk/clashofclans.js/commit/5027ae663a8e07175e17384c7e5706f4a1a7afb4))
-- Email Password Login ([#31](https://github.com/clashperk/clashofclans.js/issues/31)) ([4153cd3](https://github.com/clashperk/clashofclans.js/commit/4153cd37ea0e1c71550b9e892105b84d5a407e23))
-- Queue Throttler and Batch Throttler ([#34](https://github.com/clashperk/clashofclans.js/issues/34)) ([3a8f051](https://github.com/clashperk/clashofclans.js/commit/3a8f051552e93b98f89bc7d524acdecddf242718))
-- Override Request Options ([#36](https://github.com/clashperk/clashofclans.js/issues/36)) ([42d7fdd](https://github.com/clashperk/clashofclans.js/commit/42d7fdd36262cc46f23b731f8cffb9daea19d3b0))
-- Internal Caching Options ([#53](https://github.com/clashperk/clashofclans.js/issues/53)) ([984451d](https://github.com/clashperk/clashofclans.js/commit/30ea3240c11866008d0dae514468c0fdbb34ffd0))
-- Additional Properties for Player Units ([#65](https://github.com/clashperk/clashofclans.js/pull/65)) ([aa1696](https://github.com/clashperk/clashofclans.js/commit/aa1696243d96d4fed0250b4282c60522a6482343))