@retroachievements/api 1.5.0 → 1.5.2

package/src/ticket/getTicketData.ts

@@ -3,7 +3,7 @@ import {
   apiBaseUrl,
   buildRequestUrl,
   call,
-  serializeProperties
+  serializeProperties,
 } from "../utils/internal";
 import type { AuthObject } from "../utils/public";
 import type {
@@ -12,7 +12,7 @@ import type {
   MostTicketedGames,
   RecentTickets,
   TicketEntity,
-  UserTicketStats
+  UserTicketStats,
 } from "./models";
 
 interface GetTicketDataAllPayloadValues {
@@ -222,9 +222,9 @@ export async function getTicketData(
       "GameID",
       "ReportType",
       "ReportState",
-      "OpenTickets"
+      "OpenTickets",
     ],
-    shouldMapToBooleans: ["Hardcore"]
+    shouldMapToBooleans: ["Hardcore"],
   });
 }
 
@@ -238,7 +238,7 @@ const buildGetTicketDataQueryParams = (
     gameId,
     isGettingTicketsForUnofficialAchievements,
     shouldReturnTicketsList,
-    achievementId
+    achievementId,
   } = payload;
 
   let queryParams: Record<string, string | number> = {};

package/src/user/getAchievementsEarnedBetween.test.ts

@@ -4,7 +4,10 @@ import { setupServer } from "msw/node";
 import { apiBaseUrl } from "../utils/internal";
 import { buildAuthorization } from "../utils/public";
 import { getAchievementsEarnedBetween } from "./getAchievementsEarnedBetween";
-import type { DatedUserAchievementsResponse } from "./models";
+import type {
+  DatedUserAchievement,
+  DatedUserAchievementsResponse,
+} from "./models";
 
 const server = setupServer();
 
@@ -23,7 +26,7 @@ describe("Function: getAchievementsEarnedBetween", () => {
     // ARRANGE
     const authorization = buildAuthorization({
       userName: "mockUserName",
-      webApiKey: "mockWebApiKey"
+      webApiKey: "mockWebApiKey",
     });
 
     const mockResponse: DatedUserAchievementsResponse = [
@@ -42,8 +45,9 @@ describe("Function: getAchievementsEarnedBetween", () => {
         ConsoleName: "PlayStation Portable",
         CumulScore: 40,
         BadgeURL: "/Badge/193797.png",
-        GameURL: "/game/3571"
-      }
+        GameURL: "/game/3571",
+        Type: "progression",
+      },
     ];
 
     server.use(
@@ -56,11 +60,10 @@ describe("Function: getAchievementsEarnedBetween", () => {
     const response = await getAchievementsEarnedBetween(authorization, {
       userName: "xelnia",
       fromDate: new Date("2022-10-12"),
-      toDate: new Date("2022-10-13")
+      toDate: new Date("2022-10-13"),
     });
 
-    // ASSERT
-    expect(response).toEqual([
+    const expectedResponse: DatedUserAchievement[] = [
       {
         date: "2022-10-12 07:36:31",
         hardcoreMode: true,
@@ -76,8 +79,12 @@ describe("Function: getAchievementsEarnedBetween", () => {
         consoleName: "PlayStation Portable",
         cumulScore: 40,
         badgeUrl: "/Badge/193797.png",
-        gameUrl: "/game/3571"
-      }
-    ]);
+        gameUrl: "/game/3571",
+        type: "progression",
+      },
+    ];
+
+    // ASSERT
+    expect(response).toEqual(expectedResponse);
   });
 });

package/src/user/getAchievementsEarnedBetween.ts

@@ -2,12 +2,12 @@ import {
   apiBaseUrl,
   buildRequestUrl,
   call,
-  serializeProperties
+  serializeProperties,
 } from "../utils/internal";
 import type { AuthObject } from "../utils/public";
 import type {
   DatedUserAchievement,
-  DatedUserAchievementsResponse
+  DatedUserAchievementsResponse,
 } from "./models";
 
 /**
@@ -57,7 +57,8 @@ import type {
  *     consoleName: 'PlayStation Portable',
  *     cumulScore: 120,
  *     badgeUrl: '/Badge/193756.png',
- *     gameUrl: '/game/3571'
+ *     gameUrl: '/game/3571',
+ *     type: 'progression'
  *   }
  * ]
  * ```
@@ -75,7 +76,7 @@ export const getAchievementsEarnedBetween = async (
     {
       u: userName,
       f: (fromDate.getTime() / 1000).toFixed(0),
-      t: (toDate.getTime() / 1000).toFixed(0)
+      t: (toDate.getTime() / 1000).toFixed(0),
     }
   );
 
@@ -83,6 +84,6 @@ export const getAchievementsEarnedBetween = async (
 
   return serializeProperties(rawResponse, {
     shouldCastToNumbers: ["AchievementID", "Points", "GameID"],
-    shouldMapToBooleans: ["HardcoreMode"]
+    shouldMapToBooleans: ["HardcoreMode"],
   });
 };

package/src/user/getAchievementsEarnedOnDay.test.ts

@@ -4,7 +4,10 @@ import { setupServer } from "msw/node";
 import { apiBaseUrl } from "../utils/internal";
 import { buildAuthorization } from "../utils/public";
 import { getAchievementsEarnedOnDay } from "./getAchievementsEarnedOnDay";
-import type { DatedUserAchievementsResponse } from "./models";
+import type {
+  DatedUserAchievement,
+  DatedUserAchievementsResponse,
+} from "./models";
 
 const server = setupServer();
 
@@ -23,7 +26,7 @@ describe("Function: getAchievementsEarnedOnDay", () => {
     // ARRANGE
     const authorization = buildAuthorization({
       userName: "mockUserName",
-      webApiKey: "mockWebApiKey"
+      webApiKey: "mockWebApiKey",
     });
 
     const mockResponse: DatedUserAchievementsResponse = [
@@ -42,8 +45,9 @@ describe("Function: getAchievementsEarnedOnDay", () => {
         ConsoleName: "PlayStation Portable",
         CumulScore: 40,
         BadgeURL: "/Badge/193797.png",
-        GameURL: "/game/3571"
-      }
+        GameURL: "/game/3571",
+        Type: null,
+      },
     ];
 
     server.use(
@@ -55,11 +59,10 @@ describe("Function: getAchievementsEarnedOnDay", () => {
     // ACT
     const response = await getAchievementsEarnedOnDay(authorization, {
       userName: "xelnia",
-      onDate: new Date("2022-10-12")
+      onDate: new Date("2022-10-12"),
     });
 
-    // ASSERT
-    expect(response).toEqual([
+    const expectedResponse: DatedUserAchievement[] = [
       {
         date: "2022-10-12 07:36:31",
         hardcoreMode: true,
@@ -75,8 +78,12 @@ describe("Function: getAchievementsEarnedOnDay", () => {
         consoleName: "PlayStation Portable",
         cumulScore: 40,
         badgeUrl: "/Badge/193797.png",
-        gameUrl: "/game/3571"
-      }
-    ]);
+        gameUrl: "/game/3571",
+        type: null,
+      },
+    ];
+
+    // ASSERT
+    expect(response).toEqual(expectedResponse);
   });
 });

package/src/user/getAchievementsEarnedOnDay.ts

@@ -2,12 +2,12 @@ import {
   apiBaseUrl,
   buildRequestUrl,
   call,
-  serializeProperties
+  serializeProperties,
 } from "../utils/internal";
 import type { AuthObject } from "../utils/public";
 import type {
   DatedUserAchievement,
-  DatedUserAchievementsResponse
+  DatedUserAchievementsResponse,
 } from "./models";
 
 /**
@@ -56,7 +56,8 @@ import type {
  *      consoleName: 'PlayStation Portable',
  *      cumulScore: 120,
  *      badgeUrl: '/Badge/193756.png',
- *      gameUrl: '/game/3571'
+ *      gameUrl: '/game/3571',
+ *      type: 'progression'
  *    }
  *  ]
  * ```
@@ -74,7 +75,7 @@ export const getAchievementsEarnedOnDay = async (
     {
       u: userName,
       // YYYY-MM-DD
-      d: `${onDate.getFullYear()}-${onDate.getMonth() + 1}-${onDate.getDate()}`
+      d: `${onDate.getFullYear()}-${onDate.getMonth() + 1}-${onDate.getDate()}`,
     }
   );
 
@@ -82,6 +83,6 @@ export const getAchievementsEarnedOnDay = async (
 
   return serializeProperties(rawResponse, {
     shouldCastToNumbers: ["AchievementID", "Points", "GameID"],
-    shouldMapToBooleans: ["HardcoreMode"]
+    shouldMapToBooleans: ["HardcoreMode"],
   });
 };

package/src/user/getGameInfoAndUserProgress.test.ts

@@ -25,7 +25,7 @@ describe("Function: getGameInfoAndUserProgress", () => {
     // ARRANGE
     const authorization = buildAuthorization({
       userName: "mockUserName",
-      webApiKey: "mockWebApiKey"
+      webApiKey: "mockWebApiKey",
     });
 
     const mockResponse: GetGameInfoAndUserProgressResponse = {
@@ -64,13 +64,13 @@ describe("Function: getGameInfoAndUserProgress", () => {
           DisplayOrder: "0",
           MemAddr: "f5c41fa0b5fa0d5fbb8a74c598f18582",
           DateEarned: "2022-08-23 22:56:38",
-          DateEarnedHardcore: "2022-08-23 22:56:38"
-        }
+          DateEarnedHardcore: "2022-08-23 22:56:38",
+        },
       },
       NumAwardedToUser: 12,
       NumAwardedToUserHardcore: 12,
       UserCompletion: "100.00%",
-      UserCompletionHardcore: "100.00%"
+      UserCompletionHardcore: "100.00%",
     };
 
     server.use(
@@ -82,7 +82,7 @@ describe("Function: getGameInfoAndUserProgress", () => {
     // ACT
     const response = await getGameInfoAndUserProgress(authorization, {
       gameId: 14_402,
-      userName: "xelnia"
+      userName: "xelnia",
     });
 
     // ASSERT
@@ -122,13 +122,13 @@ describe("Function: getGameInfoAndUserProgress", () => {
           displayOrder: 0,
           memAddr: "f5c41fa0b5fa0d5fbb8a74c598f18582",
           dateEarned: "2022-08-23 22:56:38",
-          dateEarnedHardcore: "2022-08-23 22:56:38"
-        }
+          dateEarnedHardcore: "2022-08-23 22:56:38",
+        },
       },
       numAwardedToUser: 12,
       numAwardedToUserHardcore: 12,
       userCompletion: "100.00%",
-      userCompletionHardcore: "100.00%"
+      userCompletionHardcore: "100.00%",
     });
   });
 });

package/src/user/getGameInfoAndUserProgress.ts

@@ -3,12 +3,12 @@ import {
   apiBaseUrl,
   buildRequestUrl,
   call,
-  serializeProperties
+  serializeProperties,
 } from "../utils/internal";
 import type { AuthObject } from "../utils/public";
 import type {
   GameInfoAndUserProgress,
-  GetGameInfoAndUserProgressResponse
+  GetGameInfoAndUserProgressResponse,
 } from "./models";
 
 /**
@@ -97,7 +97,7 @@ export const getGameInfoAndUserProgress = async (
     authorization,
     {
       g: gameId,
-      u: userName
+      u: userName,
     }
   );
 
@@ -113,7 +113,7 @@ export const getGameInfoAndUserProgress = async (
       "DisplayOrder",
       "NumDistinctPlayersCasual",
       "NumDistinctPlayersHardcore",
-      "Released"
-    ]
+      "Released",
+    ],
   });
 };

package/src/user/getUserAwards.test.ts

@@ -23,7 +23,7 @@ describe("Function: getUserAwards", () => {
     // ARRANGE
     const authorization = buildAuthorization({
       userName: "mockUserName",
-      webApiKey: "mockWebApiKey"
+      webApiKey: "mockWebApiKey",
     });
 
     const mockResponse: GetUserAwardsResponse = {
@@ -45,9 +45,9 @@ describe("Function: getUserAwards", () => {
           Title: "WarioWare, Inc.: Mega Microgames!",
           ConsoleName: "Game Boy Advance",
           Flags: null,
-          ImageIcon: "/Images/034678.png"
-        }
-      ]
+          ImageIcon: "/Images/034678.png",
+        },
+      ],
     };
 
     server.use(
@@ -79,9 +79,9 @@ describe("Function: getUserAwards", () => {
           title: "WarioWare, Inc.: Mega Microgames!",
           consoleName: "Game Boy Advance",
           flags: null,
-          imageIcon: "/Images/034678.png"
-        }
-      ]
+          imageIcon: "/Images/034678.png",
+        },
+      ],
     });
   });
 });

package/src/user/getUserAwards.ts

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

package/src/user/getUserClaims.test.ts

@@ -24,7 +24,7 @@ describe("Function: getUserClaims", () => {
   it("given a username, retrieves a list of achievement set claims for the user", async () => {
     const authorization = buildAuthorization({
       userName: "mockUserName",
-      webApiKey: "mockWebApiKey"
+      webApiKey: "mockWebApiKey",
     });
 
     const mockResponse: GetUserClaimsResponse = [
@@ -43,8 +43,8 @@ describe("Function: getUserClaims", () => {
         Created: "2017-08-20 00:00:00",
         DoneTime: "2017-08-20 00:00:00",
         Updated: "2022-06-28 17:15:59",
-        MinutesLeft: "-2862348"
-      }
+        MinutesLeft: "-2862348",
+      },
     ];
 
     server.use(
@@ -55,7 +55,7 @@ describe("Function: getUserClaims", () => {
 
     // ACT
     const response = await getUserClaims(authorization, {
-      userName: "Jamiras"
+      userName: "Jamiras",
     });
 
     // ASSERT
@@ -75,8 +75,8 @@ describe("Function: getUserClaims", () => {
         created: "2017-08-20 00:00:00",
         doneTime: "2017-08-20 00:00:00",
         updated: "2022-06-28 17:15:59",
-        minutesLeft: -2_862_348
-      }
+        minutesLeft: -2_862_348,
+      },
     ]);
   });
 });

package/src/user/getUserClaims.ts

@@ -2,7 +2,7 @@ import {
   apiBaseUrl,
   buildRequestUrl,
   call,
-  serializeProperties
+  serializeProperties,
 } from "../utils/internal";
 import type { AuthObject } from "../utils/public";
 import type { GetUserClaimsResponse, UserClaims } from "./models";
@@ -53,7 +53,7 @@ export const getUserClaims = async (
       "Status",
       "Extension",
       "Special",
-      "MinutesLeft"
-    ]
+      "MinutesLeft",
+    ],
   });
 };

package/src/user/getUserCompletedGames.test.ts

@@ -25,7 +25,7 @@ describe("Function: getUserCompletedGames", () => {
     // ARRANGE
     const authorization = buildAuthorization({
       userName: "mockUserName",
-      webApiKey: "mockWebApiKey"
+      webApiKey: "mockWebApiKey",
     });
 
     const mockResponse: GetUserCompletedGamesResponse = [
@@ -38,7 +38,7 @@ describe("Function: getUserCompletedGames", () => {
         MaxPossible: "26",
         NumAwarded: "12",
         PctWon: "0.4615",
-        HardcoreMode: "0"
+        HardcoreMode: "0",
       },
       {
         GameID: "1881",
@@ -49,8 +49,8 @@ describe("Function: getUserCompletedGames", () => {
         MaxPossible: "26",
         NumAwarded: "12",
         PctWon: "0.4615",
-        HardcoreMode: "1"
-      }
+        HardcoreMode: "1",
+      },
     ];
 
     server.use(
@@ -61,7 +61,7 @@ describe("Function: getUserCompletedGames", () => {
 
     // ACT
     const response = await getUserCompletedGames(authorization, {
-      userName: "xelnia"
+      userName: "xelnia",
     });
 
     // ASSERT
@@ -75,7 +75,7 @@ describe("Function: getUserCompletedGames", () => {
         maxPossible: 26,
         numAwarded: 12,
         pctWon: 0.4615,
-        hardcoreMode: false
+        hardcoreMode: false,
       },
       {
         gameId: 1881,
@@ -86,8 +86,8 @@ describe("Function: getUserCompletedGames", () => {
         maxPossible: 26,
         numAwarded: 12,
         pctWon: 0.4615,
-        hardcoreMode: true
-      }
+        hardcoreMode: true,
+      },
     ]);
   });
 });

package/src/user/getUserCompletedGames.ts

@@ -2,12 +2,12 @@ import {
   apiBaseUrl,
   buildRequestUrl,
   call,
-  serializeProperties
+  serializeProperties,
 } from "../utils/internal";
 import type { AuthObject } from "../utils/public";
 import type {
   GetUserCompletedGamesResponse,
-  UserCompletedGames
+  UserCompletedGames,
 } from "./models";
 
 /**
@@ -82,8 +82,8 @@ export const getUserCompletedGames = async (
       "ConsoleID",
       "MaxPossible",
       "NumAwarded",
-      "PctWon"
+      "PctWon",
     ],
-    shouldMapToBooleans: ["HardcoreMode"]
+    shouldMapToBooleans: ["HardcoreMode"],
   });
 };

package/src/user/getUserCompletionProgress.test.ts

@@ -23,7 +23,7 @@ describe("Function: getUserCompletionProgress", () => {
     // ARRANGE
     const authorization = buildAuthorization({
       userName: "mockUserName",
-      webApiKey: "mockWebApiKey"
+      webApiKey: "mockWebApiKey",
     });
 
     const mockResponse: GetUserCompletionProgressResponse = {
@@ -41,9 +41,9 @@ describe("Function: getUserCompletionProgress", () => {
           NumAwardedHardcore: 8,
           MostRecentAwardedDate: "2022-07-26T23:56:15+00:00",
           HighestAwardKind: null,
-          HighestAwardDate: null
-        }
-      ]
+          HighestAwardDate: null,
+        },
+      ],
     };
 
     server.use(
@@ -54,7 +54,7 @@ describe("Function: getUserCompletionProgress", () => {
 
     // ACT
     const response = await getUserCompletionProgress(authorization, {
-      userName: "xelnia"
+      userName: "xelnia",
     });
 
     // ASSERT
@@ -73,9 +73,9 @@ describe("Function: getUserCompletionProgress", () => {
           numAwardedHardcore: 8,
           mostRecentAwardedDate: "2022-07-26T23:56:15+00:00",
           highestAwardKind: null,
-          highestAwardDate: null
-        }
-      ]
+          highestAwardDate: null,
+        },
+      ],
     });
   });
 });

package/src/user/getUserCompletionProgress.ts

@@ -2,12 +2,12 @@ import {
   apiBaseUrl,
   buildRequestUrl,
   call,
-  serializeProperties
+  serializeProperties,
 } from "../utils/internal";
 import type { AuthObject } from "../utils/public";
 import type {
   GetUserCompletionProgressResponse,
-  UserCompletionProgress
+  UserCompletionProgress,
 } from "./models";
 
 /**
@@ -61,7 +61,7 @@ export const getUserCompletionProgress = async (
   const { userName, offset, count } = payload;
 
   const params: Record<string, string | number> = {
-    u: userName
+    u: userName,
   };
   if (offset) {
     params["o"] = offset;

package/src/user/getUserGameRankAndScore.test.ts

@@ -23,7 +23,7 @@ describe("Function: getUserGameRankAndScore", () => {
     // ARRANGE
     const authorization = buildAuthorization({
       userName: "mockUserName",
-      webApiKey: "mockWebApiKey"
+      webApiKey: "mockWebApiKey",
     });
 
     const mockResponse: GetUserGameRankAndScoreResponse = [
@@ -31,8 +31,8 @@ describe("Function: getUserGameRankAndScore", () => {
         User: "xelnia",
         TotalScore: "1000",
         LastAward: "2022-09-01 21:51:23",
-        UserRank: "4"
-      }
+        UserRank: "4",
+      },
     ];
 
     server.use(
@@ -44,7 +44,7 @@ describe("Function: getUserGameRankAndScore", () => {
     // ACT
     const response = await getUserGameRankAndScore(authorization, {
       userName: "xelnia",
-      gameId: 14_402
+      gameId: 14_402,
     });
 
     // ASSERT
@@ -53,8 +53,8 @@ describe("Function: getUserGameRankAndScore", () => {
         user: "xelnia",
         totalScore: 1000,
         lastAward: "2022-09-01 21:51:23",
-        userRank: 4
-      }
+        userRank: 4,
+      },
     ]);
   });
 });

package/src/user/getUserGameRankAndScore.ts

@@ -3,12 +3,12 @@ import {
   apiBaseUrl,
   buildRequestUrl,
   call,
-  serializeProperties
+  serializeProperties,
 } from "../utils/internal";
 import type { AuthObject } from "../utils/public";
 import type {
   GetUserGameRankAndScoreResponse,
-  UserGameRankAndScore
+  UserGameRankAndScore,
 } from "./models";
 
 /**
@@ -65,6 +65,6 @@ export const getUserGameRankAndScore = async (
   const rawResponse = await call<GetUserGameRankAndScoreResponse>({ url });
 
   return serializeProperties(rawResponse, {
-    shouldCastToNumbers: ["TotalScore", "UserRank"]
+    shouldCastToNumbers: ["TotalScore", "UserRank"],
   });
 };

package/src/user/getUserPoints.test.ts

@@ -23,12 +23,12 @@ describe("Function: getUserPoints", () => {
     // ARRANGE
     const authorization = buildAuthorization({
       userName: "mockUserName",
-      webApiKey: "mockWebApiKey"
+      webApiKey: "mockWebApiKey",
     });
 
     const mockResponse: GetUserPointsResponse = {
       Points: 10_000,
-      SoftcorePoints: 5400
+      SoftcorePoints: 5400,
     };
 
     server.use(
@@ -43,7 +43,7 @@ describe("Function: getUserPoints", () => {
     // ASSERT
     expect(response).toEqual({
       points: 10_000,
-      softcorePoints: 5400
+      softcorePoints: 5400,
     });
   });
 });