fix: getLeaderboard return type

tusharlock10 · Jan 28, 2024 · beb0b9f · beb0b9f
1 parent 30b19a7
commit beb0b9f
Show file tree

Hide file tree

Showing 7 changed files with 28 additions and 9 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,4 @@
-# v4.0.0
+# v4.0.1
 - *BREAKING CHANGE*: Removed `getBountyItems` api
 - Added `getPlayerQueueStatsBatch` api
 - Added `getLeaderboard` api
@@ -47,4 +47,4 @@
 - Added `TaskForce` to `Enums`
 - Fixed `champion_id` type in `ChampionCard` 
 
-View release on [npm](https://www.npmjs.com/package/pe-paladins.js/v/4.0.0)
+View release on [npm](https://www.npmjs.com/package/pe-paladins.js/v/4.0.1)
diff --git a/README.md b/README.md
@@ -12,7 +12,7 @@ A strongly typed fork of [paladins.js](https://www.npmjs.com/package/paladins.js
 
 ## Changelog
 
-### v4.0.0
+### v4.0.1
 - *BREAKING CHANGE*: Removed `getBountyItems` api
 - Added `getPlayerQueueStatsBatch` api
 - Added `getLeaderboard` api

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "pe-paladins.js",
-  "version": "4.0.0",
+  "version": "4.0.1",
   "description": "A strongly typed fork of paladins.js, used by Paladins Edge",
   "keywords": [
     "paladins",
@@ -58,4 +58,4 @@
     "typedoc": "^0.22.18",
     "typescript": "^4.7.4"
   }
-}
+}
diff --git a/src/api.ts b/src/api.ts
@@ -204,7 +204,7 @@ export class API {
      */
     public getLeaderboard(rank: Enums.Ranks, round = 1) {
         const queue = Queue.Ranked;
-        return this.endpoint<ApiResponse.GetPlayerQueueStats>('getleagueleaderboard', [null, null, null, null, queue, rank, null, null, round]);
+        return this.endpoint<ApiResponse.GetLeaderboard>('getleagueleaderboard', [null, null, null, null, queue, rank, null, null, round]);
     }
 
     /**

diff --git a/src/apiResponse/getLeaderboard.ts b/src/apiResponse/getLeaderboard.ts
@@ -0,0 +1,18 @@
+import { Ranks } from '../enums';
+
+interface LeaderboardPlayer {
+  Leaves: number,
+  Losses: number,
+  Name: string,
+  Points: number,
+  PrevRank: number,
+  Rank: number,
+  Season: number,
+  Tier: Ranks,
+  Trend: number,
+  Wins: number,
+  player_id: string,
+  ret_msg: string | null;
+}
+
+export type GetLeaderboard = LeaderboardPlayer[];
diff --git a/src/apiResponse/index.ts b/src/apiResponse/index.ts
@@ -1,10 +1,11 @@
 export * from './getActiveMatchDetails';
 export * from './getBountyItems';
 export * from './getChampionCards';
-export * from './getChampions';
 export * from './getChampionSkins';
+export * from './getChampions';
 export * from './getDataUsage';
 export * from './getItems';
+export * from './getLeaderboard';
 export * from './getMatchDetails';
 export * from './getMatchIdsByQueue';
 export * from './getPlayer';