@retroachievements/api 1.5.0 → 1.5.2

package/src/user/getUserPoints.ts

@@ -2,7 +2,7 @@ import {
   apiBaseUrl,
   buildRequestUrl,
   call,
-  serializeProperties
+  serializeProperties,
 } from "../utils/internal";
 import type { AuthObject } from "../utils/public";
 import type { GetUserPointsResponse, UserPoints } from "./models";

package/src/user/getUserProfile.test.ts

@@ -23,7 +23,7 @@ describe("Function: getUserProfile", () => {
     // ARRANGE
     const authorization = buildAuthorization({
       userName: "mockUserName",
-      webApiKey: "mockWebApiKey"
+      webApiKey: "mockWebApiKey",
     });
 
     const mockResponse: GetUserProfileResponse = {
@@ -42,7 +42,7 @@ describe("Function: getUserProfile", () => {
       Untracked: 0,
       ID: 16_446,
       UserWallActive: 1,
-      Motto: "Join me on Twitch! GameSquadSquad for live RA"
+      Motto: "Join me on Twitch! GameSquadSquad for live RA",
     };
 
     server.use(
@@ -53,7 +53,7 @@ describe("Function: getUserProfile", () => {
 
     // ACT
     const response = await getUserProfile(authorization, {
-      userName: "WCopeland"
+      userName: "WCopeland",
     });
 
     // ASSERT
@@ -73,7 +73,7 @@ describe("Function: getUserProfile", () => {
       untracked: false,
       id: 16_446,
       userWallActive: true,
-      motto: "Join me on Twitch! GameSquadSquad for live RA"
+      motto: "Join me on Twitch! GameSquadSquad for live RA",
     });
   });
 });

package/src/user/getUserProfile.ts

@@ -2,7 +2,7 @@ import {
   apiBaseUrl,
   buildRequestUrl,
   call,
-  serializeProperties
+  serializeProperties,
 } from "../utils/internal";
 import type { AuthObject } from "../utils/public";
 import type { GetUserProfileResponse, UserProfile } from "./models";
@@ -48,8 +48,8 @@ export const getUserProfile = async (
       "TotalPoints",
       "TotalSoftcorePoints",
       "TotalTruePoints",
-      "Permissions"
+      "Permissions",
     ],
-    shouldMapToBooleans: ["Untracked", "UserWallActive"]
+    shouldMapToBooleans: ["Untracked", "UserWallActive"],
   });
 };

package/src/user/getUserProgress.test.ts

@@ -23,7 +23,7 @@ describe("Function: getUserProgress", () => {
     // ARRANGE
     const authorization = buildAuthorization({
       userName: "mockUserName",
-      webApiKey: "mockWebApiKey"
+      webApiKey: "mockWebApiKey",
     });
 
     const mockResponse: GetUserProgressResponse = {
@@ -33,7 +33,7 @@ describe("Function: getUserProgress", () => {
         NumAchieved: "4",
         ScoreAchieved: "80",
         NumAchievedHardcore: "4",
-        ScoreAchievedHardcore: "80"
+        ScoreAchievedHardcore: "80",
       },
       "14402": {
         NumPossibleAchievements: "10",
@@ -41,8 +41,8 @@ describe("Function: getUserProgress", () => {
         NumAchieved: "4",
         ScoreAchieved: "80",
         NumAchievedHardcore: "4",
-        ScoreAchievedHardcore: "80"
-      }
+        ScoreAchievedHardcore: "80",
+      },
     };
 
     server.use(
@@ -54,7 +54,7 @@ describe("Function: getUserProgress", () => {
     // ACT
     const response = await getUserProgress(authorization, {
       userName: "xelnia",
-      gameIds: [1, 14_402]
+      gameIds: [1, 14_402],
     });
 
     // ASSERT
@@ -65,7 +65,7 @@ describe("Function: getUserProgress", () => {
         numAchieved: 4,
         scoreAchieved: 80,
         numAchievedHardcore: 4,
-        scoreAchievedHardcore: 80
+        scoreAchievedHardcore: 80,
       },
       "14402": {
         numPossibleAchievements: 10,
@@ -73,8 +73,8 @@ describe("Function: getUserProgress", () => {
         numAchieved: 4,
         scoreAchieved: 80,
         numAchievedHardcore: 4,
-        scoreAchievedHardcore: 80
-      }
+        scoreAchievedHardcore: 80,
+      },
     });
   });
 });

package/src/user/getUserProgress.ts

@@ -3,7 +3,7 @@ import {
   apiBaseUrl,
   buildRequestUrl,
   call,
-  serializeProperties
+  serializeProperties,
 } from "../utils/internal";
 import type { AuthObject } from "../utils/public";
 import type { GetUserProgressResponse, UserProgress } from "./models";
@@ -73,7 +73,7 @@ export const getUserProgress = async (
       "NumAchieved",
       "ScoreAchieved",
       "NumAchievedHardcore",
-      "ScoreAchievedHardcore"
-    ]
+      "ScoreAchievedHardcore",
+    ],
   });
 };

package/src/user/getUserRecentAchievements.test.ts

@@ -23,7 +23,7 @@ describe("Function: getUserRecentAchievements", () => {
     // ARRANGE
     const authorization = buildAuthorization({
       userName: "mockUserName",
-      webApiKey: "mockWebApiKey"
+      webApiKey: "mockWebApiKey",
     });
 
     const mockResponse: GetUserRecentAchievementsResponse = [
@@ -42,8 +42,8 @@ describe("Function: getUserRecentAchievements", () => {
         GameID: 6316,
         ConsoleName: "Game Boy",
         BadgeURL: "/Badge/121991.png",
-        GameURL: "/game/6316"
-      }
+        GameURL: "/game/6316",
+      },
     ];
 
     server.use(
@@ -54,7 +54,7 @@ describe("Function: getUserRecentAchievements", () => {
 
     // ACT
     const response = await getUserRecentAchievements(authorization, {
-      userName: "xelnia"
+      userName: "xelnia",
     });
 
     // ASSERT
@@ -74,8 +74,8 @@ describe("Function: getUserRecentAchievements", () => {
         gameId: 6316,
         consoleName: "Game Boy",
         badgeUrl: "/Badge/121991.png",
-        gameUrl: "/game/6316"
-      }
+        gameUrl: "/game/6316",
+      },
     ]);
   });
 });

package/src/user/getUserRecentAchievements.ts

@@ -2,12 +2,12 @@ import {
   apiBaseUrl,
   buildRequestUrl,
   call,
-  serializeProperties
+  serializeProperties,
 } from "../utils/internal";
 import type { AuthObject } from "../utils/public";
 import type {
   GetUserRecentAchievementsResponse,
-  UserRecentAchievement
+  UserRecentAchievement,
 } from "./models";
 
 /**
@@ -75,6 +75,6 @@ export const getUserRecentAchievements = async (
   const rawResponse = await call<GetUserRecentAchievementsResponse>({ url });
 
   return serializeProperties(rawResponse, {
-    shouldMapToBooleans: ["HardcoreMode"]
+    shouldMapToBooleans: ["HardcoreMode"],
   });
 };

package/src/user/getUserRecentlyPlayedGames.test.ts

@@ -23,7 +23,7 @@ describe("Function: getUserRecentlyPlayedGames", () => {
     // ARRANGE
     const authorization = buildAuthorization({
       userName: "mockUserName",
-      webApiKey: "mockWebApiKey"
+      webApiKey: "mockWebApiKey",
     });
 
     const mockResponse: GetUserRecentlyPlayedGamesResponse = [
@@ -40,8 +40,8 @@ describe("Function: getUserRecentlyPlayedGames", () => {
         ScoreAchieved: 0,
         NumAchievedHardcore: 0,
         ScoreAchievedHardcore: 0,
-        MyVote: "2"
-      }
+        MyVote: "2",
+      },
     ];
 
     server.use(
@@ -52,7 +52,7 @@ describe("Function: getUserRecentlyPlayedGames", () => {
 
     // ACT
     const response = await getUserRecentlyPlayedGames(authorization, {
-      userName: "xelnia"
+      userName: "xelnia",
     });
 
     // ASSERT
@@ -70,8 +70,8 @@ describe("Function: getUserRecentlyPlayedGames", () => {
         scoreAchieved: 0,
         numAchievedHardcore: 0,
         scoreAchievedHardcore: 0,
-        myVote: 2
-      }
+        myVote: 2,
+      },
     ]);
   });
 });

package/src/user/getUserRecentlyPlayedGames.ts

@@ -2,12 +2,12 @@ import {
   apiBaseUrl,
   buildRequestUrl,
   call,
-  serializeProperties
+  serializeProperties,
 } from "../utils/internal";
 import type { AuthObject } from "../utils/public";
 import type {
   GetUserRecentlyPlayedGamesResponse,
-  UserRecentlyPlayedGames
+  UserRecentlyPlayedGames,
 } from "./models";
 
 /**
@@ -88,7 +88,7 @@ export const getUserRecentlyPlayedGames = async (
       "ScoreAchieved",
       "NumAchievedHardcore",
       "ScoreAchievedHardcore",
-      "MyVote"
-    ]
+      "MyVote",
+    ],
   });
 };

package/src/user/getUserSummary.test.ts

@@ -25,7 +25,7 @@ describe("Function: getUserSummary", () => {
     // ARRANGE
     const authorization = buildAuthorization({
       userName: "mockUserName",
-      webApiKey: "mockWebApiKey"
+      webApiKey: "mockWebApiKey",
     });
 
     const mockResponse = mockGetUserSummaryResponse;
@@ -38,7 +38,7 @@ describe("Function: getUserSummary", () => {
 
     // ACT
     const response = await getUserSummary(authorization, {
-      userName: "WCopeland"
+      userName: "WCopeland",
     });
 
     // ASSERT
@@ -49,7 +49,7 @@ describe("Function: getUserSummary", () => {
     // ARRANGE
     const authorization = buildAuthorization({
       userName: "mockUserName",
-      webApiKey: "mockWebApiKey"
+      webApiKey: "mockWebApiKey",
     });
 
     const mockResponse = "<html><body>the api is down</body></html>";
@@ -76,7 +76,7 @@ const mockGetUserSummaryResponse: GetUserSummaryResponse = {
       ConsoleName: "PlayStation 2",
       Title: "Mortal Kombat: Deadly Alliance",
       ImageIcon: "/Images/064938.png",
-      LastPlayed: "2023-01-27 02:05:02"
+      LastPlayed: "2023-01-27 02:05:02",
     },
     {
       GameID: "15922",
@@ -84,8 +84,8 @@ const mockGetUserSummaryResponse: GetUserSummaryResponse = {
       ConsoleName: "NES",
       Title: "~Hack~ Mega Man 3 Revamped",
       ImageIcon: "/Images/061792.png",
-      LastPlayed: "2022-11-07 21:49:09"
-    }
+      LastPlayed: "2022-11-07 21:49:09",
+    },
   ],
   MemberSince: "2020-02-02 20:10:35",
   LastActivity: {
@@ -95,7 +95,7 @@ const mockGetUserSummaryResponse: GetUserSummaryResponse = {
     activitytype: "1",
     User: "WCopeland",
     data: "281263",
-    data2: "1"
+    data2: "1",
   },
   RichPresenceMsg: "Arcade [Match 2] - Nitara vs Drahmin (Novice difficulty)",
   LastGameID: "19020",
@@ -115,7 +115,7 @@ const mockGetUserSummaryResponse: GetUserSummaryResponse = {
     Released: "November 16, 2002",
     IsFinal: false,
     ConsoleName: "PlayStation 2",
-    RichPresencePatch: "MockRichPresencePatch"
+    RichPresencePatch: "MockRichPresencePatch",
   },
   ContribCount: "0",
   ContribYield: "0",
@@ -135,7 +135,7 @@ const mockGetUserSummaryResponse: GetUserSummaryResponse = {
       NumAchieved: "16",
       ScoreAchieved: "95",
       NumAchievedHardcore: "16",
-      ScoreAchievedHardcore: "95"
+      ScoreAchievedHardcore: "95",
     },
     "6278": {
       NumPossibleAchievements: "42",
@@ -143,8 +143,8 @@ const mockGetUserSummaryResponse: GetUserSummaryResponse = {
       NumAchieved: 0,
       ScoreAchieved: 0,
       NumAchievedHardcore: 0,
-      ScoreAchievedHardcore: 0
-    }
+      ScoreAchievedHardcore: 0,
+    },
   },
   RecentAchievements: {
     "19020": {
@@ -158,15 +158,15 @@ const mockGetUserSummaryResponse: GetUserSummaryResponse = {
         BadgeName: "311063",
         IsAwarded: "1",
         DateAwarded: "2023-01-27 02:04:36",
-        HardcoreAchieved: "0"
-      }
-    }
+        HardcoreAchieved: "0",
+      },
+    },
   },
   Points: "18817",
   SoftcorePoints: "25",
   UserPic: "/UserPic/WCopeland.png",
   TotalRanked: 34_572,
-  Status: "Offline"
+  Status: "Offline",
 };
 
 const mockExpectedSummaryValue: UserSummary = {
@@ -178,7 +178,7 @@ const mockExpectedSummaryValue: UserSummary = {
       consoleName: "PlayStation 2",
       title: "Mortal Kombat: Deadly Alliance",
       imageIcon: "/Images/064938.png",
-      lastPlayed: "2023-01-27 02:05:02"
+      lastPlayed: "2023-01-27 02:05:02",
     },
     {
       gameId: 15_922,
@@ -186,8 +186,8 @@ const mockExpectedSummaryValue: UserSummary = {
       consoleName: "NES",
       title: "~Hack~ Mega Man 3 Revamped",
       imageIcon: "/Images/061792.png",
-      lastPlayed: "2022-11-07 21:49:09"
-    }
+      lastPlayed: "2022-11-07 21:49:09",
+    },
   ],
   memberSince: "2020-02-02 20:10:35",
   lastActivity: {
@@ -197,7 +197,7 @@ const mockExpectedSummaryValue: UserSummary = {
     activitytype: 1,
     user: "WCopeland",
     data: "281263",
-    data2: "1"
+    data2: "1",
   },
   richPresenceMsg: "Arcade [Match 2] - Nitara vs Drahmin (Novice difficulty)",
   lastGameId: 19_020,
@@ -217,7 +217,7 @@ const mockExpectedSummaryValue: UserSummary = {
     released: "November 16, 2002",
     isFinal: false,
     consoleName: "PlayStation 2",
-    richPresencePatch: "MockRichPresencePatch"
+    richPresencePatch: "MockRichPresencePatch",
   },
   contribCount: 0,
   contribYield: 0,
@@ -237,7 +237,7 @@ const mockExpectedSummaryValue: UserSummary = {
       numAchieved: 16,
       scoreAchieved: 95,
       numAchievedHardcore: 16,
-      scoreAchievedHardcore: 95
+      scoreAchievedHardcore: 95,
     },
     "6278": {
       numPossibleAchievements: 42,
@@ -245,8 +245,8 @@ const mockExpectedSummaryValue: UserSummary = {
       numAchieved: 0,
       scoreAchieved: 0,
       numAchievedHardcore: 0,
-      scoreAchievedHardcore: 0
-    }
+      scoreAchievedHardcore: 0,
+    },
   },
   recentAchievements: {
     19_020: {
@@ -260,13 +260,13 @@ const mockExpectedSummaryValue: UserSummary = {
         badgeName: "311063",
         isAwarded: true,
         dateAwarded: "2023-01-27 02:04:36",
-        hardcoreAchieved: false
-      }
-    }
+        hardcoreAchieved: false,
+      },
+    },
   },
   points: 18_817,
   softcorePoints: 25,
   userPic: "/UserPic/WCopeland.png",
   totalRanked: 34_572,
-  status: "Offline"
+  status: "Offline",
 };

package/src/user/getUserSummary.ts

@@ -2,7 +2,7 @@ import {
   apiBaseUrl,
   buildRequestUrl,
   call,
-  serializeProperties
+  serializeProperties,
 } from "../utils/internal";
 import type { AuthObject } from "../utils/public";
 import type { GetUserSummaryResponse, UserSummary } from "./models";
@@ -82,13 +82,13 @@ export const getUserSummary = async (
       "NumAchievedHardcore",
       "ScoreAchievedHardcore",
       "Points",
-      "SoftcorePoints"
+      "SoftcorePoints",
     ],
     shouldMapToBooleans: [
       "Untracked",
       "UserWallActive",
       "IsAwarded",
-      "HardcoreAchieved"
-    ]
+      "HardcoreAchieved",
+    ],
   });
 };

package/src/user/models/achievement-type.model.ts

@@ -0,0 +1,5 @@
+export type AchievementType =
+  | "progression"
+  | "win_condition"
+  | "missable"
+  | null;

package/src/user/models/dated-user-achievement.model.ts

@@ -1,3 +1,5 @@
+import type { AchievementType } from "./achievement-type.model";
+
 export type DatedUserAchievement = {
   date: string;
   hardcoreMode: boolean;
@@ -14,4 +16,5 @@ export type DatedUserAchievement = {
   cumulScore: number;
   badgeUrl: string;
   gameUrl: string;
+  type: AchievementType;
 };

package/src/user/models/dated-user-achievements-response.model.ts

@@ -1,3 +1,5 @@
+import type { AchievementType } from "./achievement-type.model";
+
 interface DatedUserAchievementResponseEntity {
   Date: string;
   HardcoreMode: string;
@@ -14,6 +16,7 @@ interface DatedUserAchievementResponseEntity {
   CumulScore: number;
   BadgeURL: string;
   GameURL: string;
+  Type: AchievementType;
 }
 
 export type DatedUserAchievementsResponse =

package/src/user/models/game-info-and-user-progress.model.ts

@@ -1,6 +1,6 @@
 import type {
   GameExtended,
-  GameExtendedAchievementEntity
+  GameExtendedAchievementEntity,
 } from "../../game/models";
 
 export type GameExtendedAchievementEntityWithUserProgress =

package/src/user/models/get-game-info-and-user-progress-response.model.ts

@@ -1,6 +1,6 @@
 import type {
   GameExtendedRawAchievementEntity,
-  GetGameExtendedResponse
+  GetGameExtendedResponse,
 } from "../../game/models";
 
 type GetGameExtendedResponseWithoutClaims = Omit<

package/src/user/models/index.ts

@@ -1,3 +1,4 @@
+export * from "./achievement-type.model";
 export * from "./award-type.model";
 export * from "./dated-user-achievement.model";
 export * from "./dated-user-achievements-response.model";

package/src/utils/internal/buildRequestUrl.test.ts

@@ -15,7 +15,7 @@ describe("Util: buildRequestUrl", () => {
       baz: "myBazValue",
       limit: 10,
       offset: 2,
-      notDefined: undefined
+      notDefined: undefined,
     };
 
     // ACT
@@ -40,7 +40,7 @@ describe("Util: buildRequestUrl", () => {
     // ACT
     const requestUrl = buildRequestUrl(baseUrl, endpointUrl, {
       userName: "TestUser",
-      webApiKey: "mockWebApiKey"
+      webApiKey: "mockWebApiKey",
     });
 
     // ASSERT

package/src/utils/internal/buildRequestUrl.ts

@@ -15,7 +15,7 @@ export const buildRequestUrl = (
   // Authentication is handled purely by query params.
   const queryParamValues: Record<string, string> = {
     z: authObject.userName,
-    y: authObject.webApiKey
+    y: authObject.webApiKey,
   };
 
   for (const [argKey, argValue] of Object.entries(args)) {

package/src/utils/internal/call.test.ts

@@ -44,7 +44,7 @@ describe("Util: call", () => {
     server.use(
       http.get(mockRequestUrl, () =>
         HttpResponse.text("<HTML><BODY>something bad happened</BODY></HTML>", {
-          status: 503
+          status: 503,
         })
       )
     );

package/src/utils/internal/call.ts

@@ -16,7 +16,7 @@ export const call = async <
   const { url } = config;
 
   const headers = new Headers({
-    "User-Agent": `RetroAchievements-api-js/${packageVersion}`
+    "User-Agent": `RetroAchievements-api-js/${packageVersion}`,
   });
 
   const rawResponse = await fetch(url, { headers });