@retroachievements/api 1.5.0 → 1.5.2

package/src/achievement/getAchievementUnlocks.test.ts

@@ -23,7 +23,7 @@ describe("Function: getAchievementUnlocks", () => {
     // ARRANGE
     const authorization = buildAuthorization({
       userName: "mockUserName",
-      webApiKey: "mockWebApiKey"
+      webApiKey: "mockWebApiKey",
     });
 
     const mockResponse: GetAchievementUnlocksResponse = {
@@ -35,7 +35,7 @@ describe("Function: getAchievementUnlocks", () => {
         TrueRatio: "6",
         Author: "Scott",
         DateCreated: "2012-11-02 00:03:12",
-        DateModified: "2022-06-11 16:52:35"
+        DateModified: "2022-06-11 16:52:35",
       },
       Console: { ID: "1", Title: "Mega Drive" },
       Game: { ID: "1", Title: "Sonic the Hedgehog" },
@@ -46,9 +46,9 @@ describe("Function: getAchievementUnlocks", () => {
           User: "Tiotroll2022",
           RAPoints: "348",
           DateAwarded: "2023-01-29 21:45:41",
-          HardcoreMode: "0"
-        }
-      ]
+          HardcoreMode: "0",
+        },
+      ],
     };
 
     let requestUrl = "";
@@ -64,7 +64,7 @@ describe("Function: getAchievementUnlocks", () => {
     const response = await getAchievementUnlocks(authorization, {
       achievementId: 18_000,
       count: 1,
-      offset: 1
+      offset: 1,
     });
 
     // ASSERT
@@ -81,7 +81,7 @@ describe("Function: getAchievementUnlocks", () => {
         trueRatio: 6,
         author: "Scott",
         dateCreated: "2012-11-02 00:03:12",
-        dateModified: "2022-06-11 16:52:35"
+        dateModified: "2022-06-11 16:52:35",
       },
       console: { id: 1, title: "Mega Drive" },
       game: { id: 1, title: "Sonic the Hedgehog" },
@@ -92,9 +92,9 @@ describe("Function: getAchievementUnlocks", () => {
           user: "Tiotroll2022",
           raPoints: 348,
           dateAwarded: "2023-01-29 21:45:41",
-          hardcoreMode: false
-        }
-      ]
+          hardcoreMode: false,
+        },
+      ],
     });
   });
 });

package/src/achievement/getAchievementUnlocks.ts

@@ -3,12 +3,12 @@ import {
   apiBaseUrl,
   buildRequestUrl,
   call,
-  serializeProperties
+  serializeProperties,
 } from "../utils/internal";
 import type { AuthObject } from "../utils/public";
 import type {
   AchievementUnlocksMetadata,
-  GetAchievementUnlocksResponse
+  GetAchievementUnlocksResponse,
 } from "./models";
 
 /**
@@ -76,6 +76,6 @@ export const getAchievementUnlocks = async (
 
   return serializeProperties(rawResponse, {
     shouldCastToNumbers: ["ID", "Points", "TrueRatio", "RAPoints"],
-    shouldMapToBooleans: ["HardcoreMode"]
+    shouldMapToBooleans: ["HardcoreMode"],
   });
 };

package/src/console/getConsoleIds.test.ts

@@ -6,7 +6,7 @@ import { setupServer } from "msw/node";
 import { apiBaseUrl } from "../utils/internal";
 import { buildAuthorization } from "../utils/public";
 import { getConsoleIds } from "./getConsoleIds";
-import type { GetConsoleIdsResponse } from "./models";
+import type { ConsoleId, GetConsoleIdsResponse } from "./models";
 
 const server = setupServer();
 
@@ -25,13 +25,28 @@ describe("Function: getConsoleIds", () => {
     // ARRANGE
     const authorization = buildAuthorization({
       userName: "mockUserName",
-      webApiKey: "mockWebApiKey"
+      webApiKey: "mockWebApiKey",
     });
 
     const mockResponse: GetConsoleIdsResponse = [
-      { ID: "1", Name: "Mega Drive" },
-      { ID: "2", Name: "Nintendo 64" },
-      { ID: "3", Name: "SNES" }
+      {
+        ID: "1",
+        Name: "Mega Drive",
+        IconURL:
+          "https://static.retroachievements.org/assets/images/system/md.png",
+      },
+      {
+        ID: "2",
+        Name: "Nintendo 64",
+        IconURL:
+          "https://static.retroachievements.org/assets/images/system/n64.png",
+      },
+      {
+        ID: "3",
+        Name: "SNES",
+        IconURL:
+          "https://static.retroachievements.org/assets/images/system/snes.png",
+      },
     ];
 
     server.use(
@@ -44,10 +59,27 @@ describe("Function: getConsoleIds", () => {
     const response = await getConsoleIds(authorization);
 
     // ASSERT
-    expect(response).toEqual([
-      { id: 1, name: "Mega Drive" },
-      { id: 2, name: "Nintendo 64" },
-      { id: 3, name: "SNES" }
-    ]);
+    const expectedResponse: ConsoleId[] = [
+      {
+        id: 1,
+        name: "Mega Drive",
+        iconUrl:
+          "https://static.retroachievements.org/assets/images/system/md.png",
+      },
+      {
+        id: 2,
+        name: "Nintendo 64",
+        iconUrl:
+          "https://static.retroachievements.org/assets/images/system/n64.png",
+      },
+      {
+        id: 3,
+        name: "SNES",
+        iconUrl:
+          "https://static.retroachievements.org/assets/images/system/snes.png",
+      },
+    ];
+
+    expect(response).toEqual(expectedResponse);
   });
 });

package/src/console/getConsoleIds.ts

@@ -2,7 +2,7 @@ import {
   apiBaseUrl,
   buildRequestUrl,
   call,
-  serializeProperties
+  serializeProperties,
 } from "../utils/internal";
 import type { AuthObject } from "../utils/public";
 import type { ConsoleId, GetConsoleIdsResponse } from "./models";
@@ -22,8 +22,12 @@ import type { ConsoleId, GetConsoleIdsResponse } from "./models";
  *
  * @returns An array containing a complete list of console ID
  * and name pairs for RetroAchievements.org.
- * ```
- * { id: "1", name: "Mega Drive" }
+ * ```json
+ * {
+ *   id: "1",
+ *   name: "Mega Drive",
+ *   iconUrl: "https://static.retroachievements.org/assets/images/system/md.png"
+ * }
  * ```
  */
 export const getConsoleIds = async (
@@ -38,6 +42,6 @@ export const getConsoleIds = async (
   const rawResponse = await call<GetConsoleIdsResponse>({ url });
 
   return serializeProperties(rawResponse, {
-    shouldCastToNumbers: ["ID"]
+    shouldCastToNumbers: ["ID"],
   });
 };

package/src/console/getGameList.test.ts

@@ -25,7 +25,7 @@ describe("Function: getGameList", () => {
     // ARRANGE
     const authorization = buildAuthorization({
       userName: "mockUserName",
-      webApiKey: "mockWebApiKey"
+      webApiKey: "mockWebApiKey",
     });
 
     const mockResponse: GetGameListResponse = [
@@ -42,9 +42,9 @@ describe("Function: getGameList", () => {
         ForumTopicID: 1972,
         Hashes: [
           "32e1a15161ef1f070b023738353bde51",
-          "9b04970a603ace521c7cca2acaf69804"
-        ]
-      }
+          "9b04970a603ace521c7cca2acaf69804",
+        ],
+      },
     ];
 
     server.use(
@@ -56,7 +56,7 @@ describe("Function: getGameList", () => {
     // ACT
     const response = await getGameList(authorization, {
       consoleId: 1,
-      shouldRetrieveGameHashes: true
+      shouldRetrieveGameHashes: true,
     });
 
     // ASSERT
@@ -74,9 +74,9 @@ describe("Function: getGameList", () => {
         forumTopicId: 1972,
         hashes: [
           "32e1a15161ef1f070b023738353bde51",
-          "9b04970a603ace521c7cca2acaf69804"
-        ]
-      }
+          "9b04970a603ace521c7cca2acaf69804",
+        ],
+      },
     ]);
   });
 });

package/src/console/getGameList.ts

@@ -3,7 +3,7 @@ import {
   apiBaseUrl,
   buildRequestUrl,
   call,
-  serializeProperties
+  serializeProperties,
 } from "../utils/internal";
 import type { AuthObject } from "../utils/public";
 import type { GameList, GetGameListResponse } from "./models";
@@ -63,7 +63,7 @@ export const getGameList = async (
   const {
     consoleId,
     shouldOnlyRetrieveGamesWithAchievements,
-    shouldRetrieveGameHashes
+    shouldRetrieveGameHashes,
   } = payload;
 
   let callPayload: Record<string, any> = { i: consoleId };
@@ -71,7 +71,7 @@ export const getGameList = async (
   if (shouldOnlyRetrieveGamesWithAchievements !== undefined) {
     callPayload = {
       ...callPayload,
-      f: shouldOnlyRetrieveGamesWithAchievements ? 1 : 0
+      f: shouldOnlyRetrieveGamesWithAchievements ? 1 : 0,
     };
   }
 
@@ -89,6 +89,6 @@ export const getGameList = async (
   const rawResponse = await call<GetGameListResponse>({ url });
 
   return serializeProperties(rawResponse, {
-    shouldCastToNumbers: ["ID", "ConsoleID"]
+    shouldCastToNumbers: ["ID", "ConsoleID"],
   });
 };

package/src/console/models/console-id.model.ts

@@ -1,4 +1,5 @@
 export interface ConsoleId {
   id: number;
   name: string;
+  iconUrl: string;
 }

package/src/console/models/get-console-ids-response.model.ts

@@ -1 +1,5 @@
-export type GetConsoleIdsResponse = readonly { ID: string; Name: string }[];
+export type GetConsoleIdsResponse = readonly {
+  ID: string;
+  Name: string;
+  IconURL: string;
+}[];

package/src/feed/getAchievementOfTheWeek.test.ts

@@ -6,7 +6,10 @@ import { setupServer } from "msw/node";
 import { apiBaseUrl } from "../utils/internal";
 import { buildAuthorization } from "../utils/public";
 import { getAchievementOfTheWeek } from "./getAchievementOfTheWeek";
-import type { GetAchievementOfTheWeekResponse } from "./models";
+import type {
+  AchievementOfTheWeek,
+  GetAchievementOfTheWeekResponse,
+} from "./models";
 
 const server = setupServer();
 
@@ -25,7 +28,7 @@ describe("Function: getAchievementOfTheWeek", () => {
     // ARRANGE
     const authorization = buildAuthorization({
       userName: "mockUserName",
-      webApiKey: "mockWebApiKey"
+      webApiKey: "mockWebApiKey",
     });
 
     const mockResponse: GetAchievementOfTheWeekResponse = {
@@ -37,7 +40,9 @@ describe("Function: getAchievementOfTheWeek", () => {
         TrueRatio: "22",
         Author: "BigWeedSmokerMan",
         DateCreated: "2021-08-08 17:47:46",
-        DateModified: "2021-08-09 12:20:05"
+        DateModified: "2021-08-09 12:20:05",
+        BadgeName: "185805",
+        BadgeURL: "/Badge/185805.png",
       },
       Console: { ID: "39", Title: "Saturn" },
       ForumTopic: { ID: "14767" },
@@ -49,10 +54,10 @@ describe("Function: getAchievementOfTheWeek", () => {
           User: "Tirbaba2",
           RAPoints: "72",
           DateAwarded: "2022-10-10 01:42:19",
-          HardcoreMode: "1"
-        }
+          HardcoreMode: "1",
+        },
       ],
-      UnlocksCount: "40"
+      UnlocksCount: "40",
     };
 
     server.use(
@@ -64,8 +69,7 @@ describe("Function: getAchievementOfTheWeek", () => {
     // ACT
     const response = await getAchievementOfTheWeek(authorization);
 
-    // ASSERT
-    expect(response).toEqual({
+    const expectedResponse: AchievementOfTheWeek = {
       achievement: {
         id: 165_062,
         title: "The True Hero",
@@ -74,7 +78,9 @@ describe("Function: getAchievementOfTheWeek", () => {
         trueRatio: 22,
         author: "BigWeedSmokerMan",
         dateCreated: "2021-08-08 17:47:46",
-        dateModified: "2021-08-09 12:20:05"
+        dateModified: "2021-08-09 12:20:05",
+        badgeName: "185805",
+        badgeUrl: "/Badge/185805.png",
       },
       console: { id: 39, title: "Saturn" },
       forumTopic: { id: 14_767 },
@@ -86,18 +92,21 @@ describe("Function: getAchievementOfTheWeek", () => {
           user: "Tirbaba2",
           raPoints: 72,
           dateAwarded: "2022-10-10 01:42:19",
-          hardcoreMode: true
-        }
+          hardcoreMode: true,
+        },
       ],
-      unlocksCount: 40
-    });
+      unlocksCount: 40,
+    };
+
+    // ASSERT
+    expect(response).toEqual(expectedResponse);
   });
 
   it("properly sets the hardcore boolean value when cleaning properties", async () => {
     // ARRANGE
     const authorization = buildAuthorization({
       userName: "mockUserName",
-      webApiKey: "mockWebApiKey"
+      webApiKey: "mockWebApiKey",
     });
 
     const mockResponse: GetAchievementOfTheWeekResponse = {
@@ -109,7 +118,9 @@ describe("Function: getAchievementOfTheWeek", () => {
         TrueRatio: "22",
         Author: "BigWeedSmokerMan",
         DateCreated: "2021-08-08 17:47:46",
-        DateModified: "2021-08-09 12:20:05"
+        DateModified: "2021-08-09 12:20:05",
+        BadgeName: "185805",
+        BadgeURL: "/Badge/185805.png",
       },
       Console: { ID: "39", Title: "Saturn" },
       ForumTopic: { ID: "14767" },
@@ -121,10 +132,10 @@ describe("Function: getAchievementOfTheWeek", () => {
           User: "Tirbaba2",
           RAPoints: "72",
           DateAwarded: "2022-10-10 01:42:19",
-          HardcoreMode: "0"
-        }
+          HardcoreMode: "0",
+        },
       ],
-      UnlocksCount: "40"
+      UnlocksCount: "40",
     };
 
     server.use(
@@ -136,8 +147,7 @@ describe("Function: getAchievementOfTheWeek", () => {
     // ACT
     const response = await getAchievementOfTheWeek(authorization);
 
-    // ASSERT
-    expect(response).toEqual({
+    const expectedResponse: AchievementOfTheWeek = {
       achievement: {
         id: 165_062,
         title: "The True Hero",
@@ -146,7 +156,9 @@ describe("Function: getAchievementOfTheWeek", () => {
         trueRatio: 22,
         author: "BigWeedSmokerMan",
         dateCreated: "2021-08-08 17:47:46",
-        dateModified: "2021-08-09 12:20:05"
+        dateModified: "2021-08-09 12:20:05",
+        badgeName: "185805",
+        badgeUrl: "/Badge/185805.png",
       },
       console: { id: 39, title: "Saturn" },
       forumTopic: { id: 14_767 },
@@ -158,10 +170,13 @@ describe("Function: getAchievementOfTheWeek", () => {
           user: "Tirbaba2",
           raPoints: 72,
           dateAwarded: "2022-10-10 01:42:19",
-          hardcoreMode: false
-        }
+          hardcoreMode: false,
+        },
       ],
-      unlocksCount: 40
-    });
+      unlocksCount: 40,
+    };
+
+    // ASSERT
+    expect(response).toEqual(expectedResponse);
   });
 });

package/src/feed/getAchievementOfTheWeek.ts

@@ -2,12 +2,12 @@ import {
   apiBaseUrl,
   buildRequestUrl,
   call,
-  serializeProperties
+  serializeProperties,
 } from "../utils/internal";
 import type { AuthObject } from "../utils/public";
 import type {
   AchievementOfTheWeek,
-  GetAchievementOfTheWeekResponse
+  GetAchievementOfTheWeekResponse,
 } from "./models";
 
 /**
@@ -36,7 +36,9 @@ import type {
  *     trueRatio: "22",
  *     author: "BigWeedSmokerMan",
  *     dateCreated: "2021-08-08 17:47:46",
- *     dateModified: "2021-08-09 12:20:05"
+ *     dateModified: "2021-08-09 12:20:05",
+ *     badgeName: "185805",
+ *     badgeUrl: "/Badge/185805.png"
  *   },
  *   console: { id: "39", title: "Saturn" },
  *   forumTopic: { id: "14767" },
@@ -73,8 +75,8 @@ export const getAchievementOfTheWeek = async (
       "TrueRatio",
       "TotalPlayers",
       "RAPoints",
-      "UnlocksCount"
+      "UnlocksCount",
     ],
-    shouldMapToBooleans: ["HardcoreMode"]
+    shouldMapToBooleans: ["HardcoreMode"],
   });
 };

package/src/feed/getActiveClaims.test.ts

@@ -25,7 +25,7 @@ describe("Function: getActiveClaims", () => {
     // ARRANGE
     const authorization = buildAuthorization({
       userName: "mockUserName",
-      webApiKey: "mockWebApiKey"
+      webApiKey: "mockWebApiKey",
     });
 
     const mockResponse: GetSetClaimsResponse = [
@@ -46,8 +46,8 @@ describe("Function: getActiveClaims", () => {
         DoneTime: "2023-01-03 20:29:45",
         Updated: "2022-10-03 20:29:45",
         MinutesLeft: 112_285,
-        UserIsJrDev: 1
-      }
+        UserIsJrDev: 1,
+      },
     ];
 
     server.use(
@@ -78,8 +78,8 @@ describe("Function: getActiveClaims", () => {
         doneTime: "2023-01-03 20:29:45",
         updated: "2022-10-03 20:29:45",
         minutesLeft: 112_285,
-        userIsJrDev: true
-      }
+        userIsJrDev: true,
+      },
     ]);
   });
 });

package/src/feed/getActiveClaims.ts

@@ -2,7 +2,7 @@ import {
   apiBaseUrl,
   buildRequestUrl,
   call,
-  serializeProperties
+  serializeProperties,
 } from "../utils/internal";
 import type { AuthObject } from "../utils/public";
 import type { GetSetClaimsResponse, SetClaim } from "./models";
@@ -56,6 +56,6 @@ export const getActiveClaims = async (
   const rawResponse = await call<GetSetClaimsResponse>({ url });
 
   return serializeProperties(rawResponse, {
-    shouldMapToBooleans: ["UserIsJrDev"]
+    shouldMapToBooleans: ["UserIsJrDev"],
   });
 };

package/src/feed/getClaims.test.ts

@@ -25,7 +25,7 @@ describe("Function: getClaims", () => {
     // ARRANGE
     const authorization = buildAuthorization({
       userName: "mockUserName",
-      webApiKey: "mockWebApiKey"
+      webApiKey: "mockWebApiKey",
     });
 
     const mockResponse: GetSetClaimsResponse = [
@@ -46,8 +46,8 @@ describe("Function: getClaims", () => {
         DoneTime: "2023-01-03 20:29:45",
         Updated: "2022-10-03 20:29:45",
         MinutesLeft: 112_285,
-        UserIsJrDev: 1
-      }
+        UserIsJrDev: 1,
+      },
     ];
 
     server.use(
@@ -78,8 +78,8 @@ describe("Function: getClaims", () => {
         doneTime: "2023-01-03 20:29:45",
         updated: "2022-10-03 20:29:45",
         minutesLeft: 112_285,
-        userIsJrDev: true
-      }
+        userIsJrDev: true,
+      },
     ]);
   });
 });

package/src/feed/getClaims.ts

@@ -2,7 +2,7 @@ import {
   apiBaseUrl,
   buildRequestUrl,
   call,
-  serializeProperties
+  serializeProperties,
 } from "../utils/internal";
 import type { AuthObject } from "../utils/public";
 import type { GetSetClaimsResponse, SetClaim } from "./models";
@@ -16,18 +16,18 @@ export const getClaims = async (
   const { claimKind } = payload;
 
   const url = buildRequestUrl(apiBaseUrl, "/API_GetClaims.php", authorization, {
-    k: claimKindValueMap[claimKind]
+    k: claimKindValueMap[claimKind],
   });
 
   const rawResponse = await call<GetSetClaimsResponse>({ url });
 
   return serializeProperties(rawResponse, {
-    shouldMapToBooleans: ["UserIsJrDev"]
+    shouldMapToBooleans: ["UserIsJrDev"],
   });
 };
 
 const claimKindValueMap: Record<ClaimKind, `${number}`> = {
   completed: "1",
   dropped: "2",
-  expired: "3"
+  expired: "3",
 };

package/src/feed/getTopTenUsers.test.ts

@@ -23,7 +23,7 @@ describe("Function: getTopTenUsers", () => {
     // ARRANGE
     const authorization = buildAuthorization({
       userName: "mockUserName",
-      webApiKey: "mockWebApiKey"
+      webApiKey: "mockWebApiKey",
     });
 
     const mockResponse: GetTopTenUsersResponse = [
@@ -36,7 +36,7 @@ describe("Function: getTopTenUsers", () => {
       { "1": "donutweegee", "2": "204701", "3": "587221" },
       { "1": "AmericanNinja", "2": "202980", "3": "567618" },
       { "1": "Infernum", "2": "202171", "3": "689967" },
-      { "1": "FabricioPrie", "2": "196974", "3": "450436" }
+      { "1": "FabricioPrie", "2": "196974", "3": "450436" },
     ];
 
     server.use(
@@ -53,49 +53,49 @@ describe("Function: getTopTenUsers", () => {
       {
         userName: "MaxMilyin",
         totalPoints: 346_289,
-        totalRatioPoints: 995_092
+        totalRatioPoints: 995_092,
       },
       {
         userName: "HippopotamusRex",
         totalPoints: 312_118,
-        totalRatioPoints: 1_151_351
+        totalRatioPoints: 1_151_351,
       },
       {
         userName: "Sarconius",
         totalPoints: 257_862,
-        totalRatioPoints: 1_181_770
+        totalRatioPoints: 1_181_770,
       },
       { userName: "guineu", totalPoints: 241_623, totalRatioPoints: 672_597 },
       {
         userName: "Andrey199650",
         totalPoints: 240_101,
-        totalRatioPoints: 567_522
+        totalRatioPoints: 567_522,
       },
       {
         userName: "Wendigo",
         totalPoints: 227_903,
-        totalRatioPoints: 1_099_685
+        totalRatioPoints: 1_099_685,
       },
       {
         userName: "donutweegee",
         totalPoints: 204_701,
-        totalRatioPoints: 587_221
+        totalRatioPoints: 587_221,
       },
       {
         userName: "AmericanNinja",
         totalPoints: 202_980,
-        totalRatioPoints: 567_618
+        totalRatioPoints: 567_618,
       },
       {
         userName: "Infernum",
         totalPoints: 202_171,
-        totalRatioPoints: 689_967
+        totalRatioPoints: 689_967,
       },
       {
         userName: "FabricioPrie",
         totalPoints: 196_974,
-        totalRatioPoints: 450_436
-      }
+        totalRatioPoints: 450_436,
+      },
     ]);
   });
 });

package/src/feed/getTopTenUsers.ts

@@ -3,7 +3,7 @@ import type { AuthObject } from "../utils/public";
 import type {
   GetTopTenUsersResponse,
   TopTenUsers,
-  TopTenUsersEntity
+  TopTenUsersEntity,
 } from "./models";
 
 /**
@@ -43,7 +43,7 @@ export const getTopTenUsers = async (
     sanitizedTopTenUsers.push({
       userName: rawUser["1"],
       totalPoints: Number(rawUser["2"]),
-      totalRatioPoints: Number(rawUser["3"])
+      totalRatioPoints: Number(rawUser["3"]),
     });
   }