feat(leaderboards): adds leaderboards

wrapper now also provides leaderboard info

Author: AndreVarandas

README.md

@@ -113,6 +113,11 @@ All api calls are asynchronous and used in the same way as above in the getCards
 - `getPlayerRankingsForLocation(id: string, params: ILocationFullRequestParams)` - Get player rankings for a specific location.
 - `getClanWarRankingsForLocation(id: string, params: ILocationFullRequestParams)` - Get clan rankings for a specific location.
 
+**Leaderboards**
+
+- `getLeaderboards()` - List leaderboards for different trophy roads.
+- `getLeaderboardById(leaderboardId: number, params: ILeaderboardRequestParams)` - Get players on a specific leaderboard.
+
 ## Configuration Objects
 
 **IClanRequestParams**
@@ -222,6 +227,29 @@ export interface ILocationRequestParams {
 }
 ```
 
+**ILeaderboardRequestParams**
+
+```typescript
+export interface ILeaderboardRequestParams {
+  /**
+   * Limit the number of items returned in the response.
+   */
+  limit?: number
+  /**
+   * Return only items that occur after this marker.
+   * After marker can be found from the response, inside the 'paging' property.
+   * Note that only after or before can be specified for a request, not both.
+   */
+  after?: string
+  /**
+   * Return only items that occur before this marker.
+   * Before marker can be found from the response, inside the 'paging' property.
+   * Note that only after or before can be specified for a request, not both.
+   */
+  before?: string
+}
+```
+
 [LICENSE - MIT](LICENSE)
 
 ---

src/__tests__/ClashRoyaleAPI.test.ts

@@ -6,4 +6,9 @@ describe('ClashRoyaleAPI', () => {
   test('should have been successfully instantiated', () => {
     expect(ClashRoyale).toBeDefined()
   })
+
+  test('should have leaderboard methods', () => {
+    expect(ClashRoyale.getLeaderboards).toBeDefined()
+    expect(ClashRoyale.getLeaderboardById).toBeDefined()
+  })
 })

src/endpoints/index.ts

@@ -3,3 +3,4 @@ export * from './clans.endpoint'
 export * from './players.endpoint'
 export * from './tournaments.endpoint'
 export * from './locations.endpoint'
+export * from './leaderboards.endpoint'

src/endpoints/leaderboards.endpoint.ts

@@ -0,0 +1,39 @@
+import { AxiosInstance } from 'axios'
+
+import {
+  ILeaderboard,
+  ILeaderboardPlayer,
+  ILeaderboardRequestParams,
+} from '../interfaces'
+
+/**
+ * List leaderboards for different trophy roads.
+ *
+ * @param {AxiosInstance} apiClient
+ */
+const getLeaderboards = async (
+  apiClient: AxiosInstance,
+): Promise<ILeaderboard[]> => {
+  const leaderboards = await apiClient.get('/leaderboards')
+  return leaderboards.data.items
+}
+
+/**
+ * Get players on a specific leaderboard.
+ *
+ * @param {number} leaderboardId
+ * @param {ILeaderboardRequestParams} params
+ * @param {AxiosInstance} apiClient
+ */
+const getLeaderboardById = async (
+  leaderboardId: number,
+  params: ILeaderboardRequestParams,
+  apiClient: AxiosInstance,
+): Promise<ILeaderboardPlayer[]> => {
+  const leaderboard = await apiClient.get(`/leaderboard/${leaderboardId}`, {
+    params,
+  })
+  return leaderboard.data.items
+}
+
+export { getLeaderboards, getLeaderboardById }

src/index.ts

@@ -11,6 +11,8 @@ import {
   getClans,
   getClanWarlog,
   getGlobalTournaments,
+  getLeaderboardById,
+  getLeaderboards,
   getLocationById,
   getLocations,
   getPlayerBattleLog,
@@ -31,6 +33,9 @@ import {
   ICurrentRiverRace,
   ICurrentWar,
   IGlobalTournaments,
+  ILeaderboard,
+  ILeaderboardPlayer,
+  ILeaderboardRequestParams,
   ILocation,
   ILocationFullRequestParams,
   ILocationRequestParams,
@@ -247,4 +252,24 @@ export class ClashRoyaleAPI {
   ): Promise<IClan[]> {
     return await getClanRankingsForLocation(id, params, this.apiClient)
   }
+
+  /**
+   * List leaderboards for different trophy roads.
+   */
+  public async getLeaderboards(): Promise<ILeaderboard[]> {
+    return await getLeaderboards(this.apiClient)
+  }
+
+  /**
+   * Get players on a specific leaderboard.
+   *
+   * @param {number} leaderboardId
+   * @param {ILeaderboardRequestParams} params
+   */
+  public async getLeaderboardById(
+    leaderboardId: number,
+    params: ILeaderboardRequestParams = {},
+  ): Promise<ILeaderboardPlayer[]> {
+    return await getLeaderboardById(leaderboardId, params, this.apiClient)
+  }
 }

src/interfaces/index.ts

@@ -9,3 +9,4 @@ export * from './war.interface'
 export * from './battle.interface'
 export * from './river_race.interface'
 export * from './CardResponse.interface'
+export * from './leaderboard.interface'

src/interfaces/leaderboard.interface.ts

@@ -0,0 +1,38 @@
+export interface ILeaderboard {
+  id: number
+  name: string
+  iconUrl?: string
+}
+
+export interface ILeaderboardPlayer {
+  tag: string
+  name: string
+  expLevel: number
+  trophies: number
+  rank: number
+  previousRank?: number
+  clan?: {
+    tag: string
+    name: string
+    badgeId: number
+  }
+}
+
+export interface ILeaderboardRequestParams {
+  /**
+   * Limit the number of items returned in the response.
+   */
+  limit?: number
+  /**
+   * Return only items that occur after this marker.
+   * After marker can be found from the response, inside the 'paging' property.
+   * Note that only after or before can be specified for a request, not both.
+   */
+  after?: string
+  /**
+   * Return only items that occur before this marker.
+   * Before marker can be found from the response, inside the 'paging' property.
+   * Note that only after or before can be specified for a request, not both.
+   */
+  before?: string
+}