@retroachievements/api 1.2.0 → 1.3.0

package/src/achievement/getAchievementUnlocks.test.ts

@@ -1,4 +1,4 @@
-import { rest } from "msw";
+import { http, HttpResponse } from "msw";
 import { setupServer } from "msw/node";
 
 import { apiBaseUrl } from "../utils/internal";
@@ -51,16 +51,13 @@ describe("Function: getAchievementUnlocks", () => {
       ]
     };
 
-    let searchParams = "";
+    let requestUrl = "";
 
     server.use(
-      rest.get(
-        `${apiBaseUrl}/API_GetAchievementUnlocks.php`,
-        (req, res, ctx) => {
-          searchParams = req.url.search;
-          return res(ctx.json(mockResponse));
-        }
-      )
+      http.get(`${apiBaseUrl}/API_GetAchievementUnlocks.php`, (info) => {
+        requestUrl = info.request.url;
+        return HttpResponse.json(mockResponse);
+      })
     );
 
     // ACT
@@ -71,9 +68,9 @@ describe("Function: getAchievementUnlocks", () => {
     });
 
     // ASSERT
-    expect(searchParams).toContain("a=18000");
-    expect(searchParams).toContain("o=1");
-    expect(searchParams).toContain("c=1");
+    expect(requestUrl).toContain("a=18000");
+    expect(requestUrl).toContain("o=1");
+    expect(requestUrl).toContain("c=1");
 
     expect(response).toEqual({
       achievement: {

package/src/console/getConsoleIds.test.ts

@@ -1,6 +1,6 @@
 /* eslint-disable sonarjs/no-duplicate-string */
 
-import { rest } from "msw";
+import { http, HttpResponse } from "msw";
 import { setupServer } from "msw/node";
 
 import { apiBaseUrl } from "../utils/internal";
@@ -35,8 +35,8 @@ describe("Function: getConsoleIds", () => {
     ];
 
     server.use(
-      rest.get(`${apiBaseUrl}/API_GetConsoleIDs.php`, (_, res, ctx) =>
-        res(ctx.json(mockResponse))
+      http.get(`${apiBaseUrl}/API_GetConsoleIDs.php`, () =>
+        HttpResponse.json(mockResponse)
       )
     );
 

package/src/console/getGameList.test.ts

@@ -1,6 +1,6 @@
 /* eslint-disable sonarjs/no-duplicate-string */
 
-import { rest } from "msw";
+import { http, HttpResponse } from "msw";
 import { setupServer } from "msw/node";
 
 import { apiBaseUrl } from "../utils/internal";
@@ -48,8 +48,8 @@ describe("Function: getGameList", () => {
     ];
 
     server.use(
-      rest.get(`${apiBaseUrl}/API_GetGameList.php`, (_, res, ctx) =>
-        res(ctx.json(mockResponse))
+      http.get(`${apiBaseUrl}/API_GetGameList.php`, () =>
+        HttpResponse.json(mockResponse)
       )
     );
 

package/src/feed/getAchievementOfTheWeek.test.ts

@@ -1,6 +1,6 @@
 /* eslint-disable sonarjs/no-duplicate-string */
 
-import { rest } from "msw";
+import { http, HttpResponse } from "msw";
 import { setupServer } from "msw/node";
 
 import { apiBaseUrl } from "../utils/internal";
@@ -56,8 +56,8 @@ describe("Function: getAchievementOfTheWeek", () => {
     };
 
     server.use(
-      rest.get(`${apiBaseUrl}/API_GetAchievementOfTheWeek.php`, (_, res, ctx) =>
-        res(ctx.json(mockResponse))
+      http.get(`${apiBaseUrl}/API_GetAchievementOfTheWeek.php`, () =>
+        HttpResponse.json(mockResponse)
       )
     );
 
@@ -128,8 +128,8 @@ describe("Function: getAchievementOfTheWeek", () => {
     };
 
     server.use(
-      rest.get(`${apiBaseUrl}/API_GetAchievementOfTheWeek.php`, (_, res, ctx) =>
-        res(ctx.json(mockResponse))
+      http.get(`${apiBaseUrl}/API_GetAchievementOfTheWeek.php`, () =>
+        HttpResponse.json(mockResponse)
       )
     );
 

package/src/feed/getActiveClaims.test.ts

@@ -1,6 +1,6 @@
 /* eslint-disable sonarjs/no-duplicate-string */
 
-import { rest } from "msw";
+import { http, HttpResponse } from "msw";
 import { setupServer } from "msw/node";
 
 import { apiBaseUrl } from "../utils/internal";
@@ -51,8 +51,8 @@ describe("Function: getActiveClaims", () => {
     ];
 
     server.use(
-      rest.get(`${apiBaseUrl}/API_GetActiveClaims.php`, (_, res, ctx) =>
-        res(ctx.json(mockResponse))
+      http.get(`${apiBaseUrl}/API_GetActiveClaims.php`, () =>
+        HttpResponse.json(mockResponse)
       )
     );
 

package/src/feed/getClaims.test.ts

@@ -1,6 +1,6 @@
 /* eslint-disable sonarjs/no-duplicate-string */
 
-import { rest } from "msw";
+import { http, HttpResponse } from "msw";
 import { setupServer } from "msw/node";
 
 import { apiBaseUrl } from "../utils/internal";
@@ -51,8 +51,8 @@ describe("Function: getClaims", () => {
     ];
 
     server.use(
-      rest.get(`${apiBaseUrl}/API_GetClaims.php`, (_, res, ctx) =>
-        res(ctx.json(mockResponse))
+      http.get(`${apiBaseUrl}/API_GetClaims.php`, () =>
+        HttpResponse.json(mockResponse)
       )
     );
 

package/src/feed/getTopTenUsers.test.ts

@@ -1,4 +1,4 @@
-import { rest } from "msw";
+import { http, HttpResponse } from "msw";
 import { setupServer } from "msw/node";
 
 import { apiBaseUrl } from "../utils/internal";
@@ -40,8 +40,8 @@ describe("Function: getTopTenUsers", () => {
     ];
 
     server.use(
-      rest.get(`${apiBaseUrl}/API_GetTopTenUsers.php`, (_, res, ctx) =>
-        res(ctx.json(mockResponse))
+      http.get(`${apiBaseUrl}/API_GetTopTenUsers.php`, () =>
+        HttpResponse.json(mockResponse)
       )
     );
 

package/src/game/getAchievementCount.test.ts

@@ -1,4 +1,4 @@
-import { rest } from "msw";
+import { http, HttpResponse } from "msw";
 import { setupServer } from "msw/node";
 
 import { apiBaseUrl } from "../utils/internal";
@@ -32,8 +32,8 @@ describe("Function: getAchievementCount", () => {
     };
 
     server.use(
-      rest.get(`${apiBaseUrl}/API_GetAchievementCount.php`, (_, res, ctx) =>
-        res(ctx.json(mockResponse))
+      http.get(`${apiBaseUrl}/API_GetAchievementCount.php`, () =>
+        HttpResponse.json(mockResponse)
       )
     );
 

package/src/game/getAchievementDistribution.test.ts

@@ -1,4 +1,4 @@
-import { rest } from "msw";
+import { http, HttpResponse } from "msw";
 import { setupServer } from "msw/node";
 
 import { apiBaseUrl } from "../utils/internal";
@@ -35,16 +35,14 @@ describe("Function: getAchievementDistribution", () => {
       "5": 1
     };
 
-    let detectedSearchParams: URLSearchParams;
+    let requestUrl = "";
 
     server.use(
-      rest.get(
-        `${apiBaseUrl}/API_GetAchievementDistribution.php`,
-        (req, res, ctx) => {
-          detectedSearchParams = req.url.searchParams;
-          return res(ctx.json(mockResponse));
-        }
-      )
+      http.get(`${apiBaseUrl}/API_GetAchievementDistribution.php`, (info) => {
+        requestUrl = info.request.url;
+
+        return HttpResponse.json(mockResponse);
+      })
     );
 
     // ACT
@@ -55,9 +53,9 @@ describe("Function: getAchievementDistribution", () => {
     // ASSERT
     expect(response).toEqual(mockResponse);
 
-    expect(detectedSearchParams!.get("i")).toEqual("14402");
-    expect(detectedSearchParams!.has("f")).toBeFalsy();
-    expect(detectedSearchParams!.has("h")).toBeFalsy();
+    expect(requestUrl).toContain("i=14402");
+    expect(requestUrl).not.toContain("f=");
+    expect(requestUrl).not.toContain("h=");
   });
 
   it("given flags, successfully attaches the option to the call", async () => {
@@ -75,16 +73,13 @@ describe("Function: getAchievementDistribution", () => {
       "5": 1
     };
 
-    let detectedSearchParams: URLSearchParams;
+    let requestUrl = "";
 
     server.use(
-      rest.get(
-        `${apiBaseUrl}/API_GetAchievementDistribution.php`,
-        (req, res, ctx) => {
-          detectedSearchParams = req.url.searchParams;
-          return res(ctx.json(mockResponse));
-        }
-      )
+      http.get(`${apiBaseUrl}/API_GetAchievementDistribution.php`, (info) => {
+        requestUrl = info.request.url;
+        return HttpResponse.json(mockResponse);
+      })
     );
 
     // ACT
@@ -96,11 +91,11 @@ describe("Function: getAchievementDistribution", () => {
     // ASSERT
     expect(response).toEqual(mockResponse);
 
-    expect(detectedSearchParams!.get("i")).toEqual("14402");
-    expect(detectedSearchParams!.get("f")).toEqual(
-      String(AchievementDistributionFlags.UnofficialAchievements)
+    expect(requestUrl).toContain("i=14402");
+    expect(requestUrl).toContain(
+      `f=${AchievementDistributionFlags.UnofficialAchievements}`
     );
-    expect(detectedSearchParams!.has("h")).toBeFalsy();
+    expect(requestUrl).not.toContain("h=");
   });
 
   it("given a truthy hardcore value, successfully attaches the option to the call", async () => {
@@ -118,16 +113,13 @@ describe("Function: getAchievementDistribution", () => {
       "5": 1
     };
 
-    let detectedSearchParams: URLSearchParams;
+    let requestUrl = "";
 
     server.use(
-      rest.get(
-        `${apiBaseUrl}/API_GetAchievementDistribution.php`,
-        (req, res, ctx) => {
-          detectedSearchParams = req.url.searchParams;
-          return res(ctx.json(mockResponse));
-        }
-      )
+      http.get(`${apiBaseUrl}/API_GetAchievementDistribution.php`, (info) => {
+        requestUrl = info.request.url;
+        return HttpResponse.json(mockResponse);
+      })
     );
 
     // ACT
@@ -139,8 +131,8 @@ describe("Function: getAchievementDistribution", () => {
     // ASSERT
     expect(response).toEqual(mockResponse);
 
-    expect(detectedSearchParams!.get("i")).toEqual("14402");
-    expect(detectedSearchParams!.get("h")).toEqual("1");
+    expect(requestUrl).toContain("i=14402");
+    expect(requestUrl).toContain("h=1");
   });
 
   it("given a falsy hardcore value, successfully attaches the option to the call", async () => {
@@ -158,16 +150,13 @@ describe("Function: getAchievementDistribution", () => {
       "5": 1
     };
 
-    let detectedSearchParams: URLSearchParams;
+    let requestUrl = "";
 
     server.use(
-      rest.get(
-        `${apiBaseUrl}/API_GetAchievementDistribution.php`,
-        (req, res, ctx) => {
-          detectedSearchParams = req.url.searchParams;
-          return res(ctx.json(mockResponse));
-        }
-      )
+      http.get(`${apiBaseUrl}/API_GetAchievementDistribution.php`, (info) => {
+        requestUrl = info.request.url;
+        return HttpResponse.json(mockResponse);
+      })
     );
 
     // ACT
@@ -179,7 +168,7 @@ describe("Function: getAchievementDistribution", () => {
     // ASSERT
     expect(response).toEqual(mockResponse);
 
-    expect(detectedSearchParams!.get("i")).toEqual("14402");
-    expect(detectedSearchParams!.get("h")).toEqual("0");
+    expect(requestUrl).toContain("i=14402");
+    expect(requestUrl).toContain("h=0");
   });
 });

package/src/game/getGame.test.ts

@@ -1,6 +1,6 @@
 /* eslint-disable sonarjs/no-duplicate-string */
 
-import { rest } from "msw";
+import { http, HttpResponse } from "msw";
 import { setupServer } from "msw/node";
 
 import { apiBaseUrl } from "../utils/internal";
@@ -49,8 +49,8 @@ describe("Function: getGame", () => {
     };
 
     server.use(
-      rest.get(`${apiBaseUrl}/API_GetGame.php`, (_, res, ctx) =>
-        res(ctx.json(mockResponse))
+      http.get(`${apiBaseUrl}/API_GetGame.php`, () =>
+        HttpResponse.json(mockResponse)
       )
     );
 

package/src/game/getGameExtended.test.ts

@@ -1,6 +1,6 @@
 /* eslint-disable sonarjs/no-duplicate-string */
 
-import { rest } from "msw";
+import { http, HttpResponse } from "msw";
 import { setupServer } from "msw/node";
 
 import { apiBaseUrl } from "../utils/internal";
@@ -69,8 +69,8 @@ describe("Function: getGameExtended", () => {
     };
 
     server.use(
-      rest.get(`${apiBaseUrl}/API_GetGameExtended.php`, (_, res, ctx) =>
-        res(ctx.json(mockResponse))
+      http.get(`${apiBaseUrl}/API_GetGameExtended.php`, () =>
+        HttpResponse.json(mockResponse)
       )
     );
 

package/src/game/getGameRankAndScore.test.ts

@@ -1,6 +1,6 @@
 /* eslint-disable sonarjs/no-duplicate-string */
 
-import { rest } from "msw";
+import { http, HttpResponse } from "msw";
 import { setupServer } from "msw/node";
 
 import { apiBaseUrl } from "../utils/internal";
@@ -38,8 +38,8 @@ describe("Function: getGameRankAndScore", () => {
     ];
 
     server.use(
-      rest.get(`${apiBaseUrl}/API_GetGameRankAndScore.php`, (_, res, ctx) =>
-        res(ctx.json(mockResponse))
+      http.get(`${apiBaseUrl}/API_GetGameRankAndScore.php`, () =>
+        HttpResponse.json(mockResponse)
       )
     );
 

package/src/game/getGameRating.test.ts

@@ -1,4 +1,4 @@
-import { rest } from "msw";
+import { http, HttpResponse } from "msw";
 import { setupServer } from "msw/node";
 
 import { apiBaseUrl } from "../utils/internal";
@@ -37,8 +37,8 @@ describe("Function: getGameRating", () => {
     };
 
     server.use(
-      rest.get(`${apiBaseUrl}/API_GetGameRating.php`, (_, res, ctx) =>
-        res(ctx.json(mockResponse))
+      http.get(`${apiBaseUrl}/API_GetGameRating.php`, () =>
+        HttpResponse.json(mockResponse)
       )
     );
 

package/src/ticket/getTicketData.test.ts

@@ -1,4 +1,4 @@
-import { rest } from "msw";
+import { http, HttpResponse } from "msw";
 import { setupServer } from "msw/node";
 
 import { apiBaseUrl } from "../utils/internal";
@@ -58,8 +58,8 @@ describe("Function: getTicketData", () => {
     };
 
     server.use(
-      rest.get(`${apiBaseUrl}/API_GetTicketData.php`, (_, res, ctx) =>
-        res(ctx.json(mockResponse))
+      http.get(`${apiBaseUrl}/API_GetTicketData.php`, () =>
+        HttpResponse.json(mockResponse)
       )
     );
 
@@ -136,8 +136,8 @@ describe("Function: getTicketData", () => {
     };
 
     server.use(
-      rest.get(`${apiBaseUrl}/API_GetTicketData.php`, (_, res, ctx) =>
-        res(ctx.json(mockResponse))
+      http.get(`${apiBaseUrl}/API_GetTicketData.php`, () =>
+        HttpResponse.json(mockResponse)
       )
     );
 
@@ -209,8 +209,8 @@ describe("Function: getTicketData", () => {
     };
 
     server.use(
-      rest.get(`${apiBaseUrl}/API_GetTicketData.php`, (_, res, ctx) =>
-        res(ctx.json(mockResponse))
+      http.get(`${apiBaseUrl}/API_GetTicketData.php`, () =>
+        HttpResponse.json(mockResponse)
       )
     );
 
@@ -258,8 +258,8 @@ describe("Function: getTicketData", () => {
     };
 
     server.use(
-      rest.get(`${apiBaseUrl}/API_GetTicketData.php`, (_, res, ctx) =>
-        res(ctx.json(mockResponse))
+      http.get(`${apiBaseUrl}/API_GetTicketData.php`, () =>
+        HttpResponse.json(mockResponse)
       )
     );
 
@@ -293,8 +293,8 @@ describe("Function: getTicketData", () => {
     };
 
     server.use(
-      rest.get(`${apiBaseUrl}/API_GetTicketData.php`, (_, res, ctx) =>
-        res(ctx.json(mockResponse))
+      http.get(`${apiBaseUrl}/API_GetTicketData.php`, () =>
+        HttpResponse.json(mockResponse)
       )
     );
 
@@ -327,8 +327,8 @@ describe("Function: getTicketData", () => {
     };
 
     server.use(
-      rest.get(`${apiBaseUrl}/API_GetTicketData.php`, (_, res, ctx) =>
-        res(ctx.json(mockResponse))
+      http.get(`${apiBaseUrl}/API_GetTicketData.php`, () =>
+        HttpResponse.json(mockResponse)
       )
     );
 

package/src/user/getAchievementsEarnedBetween.test.ts

@@ -1,4 +1,4 @@
-import { rest } from "msw";
+import { http, HttpResponse } from "msw";
 import { setupServer } from "msw/node";
 
 import { apiBaseUrl } from "../utils/internal";
@@ -47,9 +47,8 @@ describe("Function: getAchievementsEarnedBetween", () => {
     ];
 
     server.use(
-      rest.get(
-        `${apiBaseUrl}/API_GetAchievementsEarnedBetween.php`,
-        (_, res, ctx) => res(ctx.json(mockResponse))
+      http.get(`${apiBaseUrl}/API_GetAchievementsEarnedBetween.php`, () =>
+        HttpResponse.json(mockResponse)
       )
     );
 

package/src/user/getAchievementsEarnedOnDay.test.ts

@@ -1,4 +1,4 @@
-import { rest } from "msw";
+import { http, HttpResponse } from "msw";
 import { setupServer } from "msw/node";
 
 import { apiBaseUrl } from "../utils/internal";
@@ -47,9 +47,8 @@ describe("Function: getAchievementsEarnedOnDay", () => {
     ];
 
     server.use(
-      rest.get(
-        `${apiBaseUrl}/API_GetAchievementsEarnedOnDay.php`,
-        (_, res, ctx) => res(ctx.json(mockResponse))
+      http.get(`${apiBaseUrl}/API_GetAchievementsEarnedOnDay.php`, () =>
+        HttpResponse.json(mockResponse)
       )
     );
 

package/src/user/getGameInfoAndUserProgress.test.ts

@@ -1,6 +1,6 @@
 /* eslint-disable sonarjs/no-duplicate-string */
 
-import { rest } from "msw";
+import { http, HttpResponse } from "msw";
 import { setupServer } from "msw/node";
 
 import { apiBaseUrl } from "../utils/internal";
@@ -74,9 +74,8 @@ describe("Function: getGameInfoAndUserProgress", () => {
     };
 
     server.use(
-      rest.get(
-        `${apiBaseUrl}/API_GetGameInfoAndUserProgress.php`,
-        (_, res, ctx) => res(ctx.json(mockResponse))
+      http.get(`${apiBaseUrl}/API_GetGameInfoAndUserProgress.php`, () =>
+        HttpResponse.json(mockResponse)
       )
     );
 

package/src/user/getUserAwards.test.ts

@@ -1,4 +1,4 @@
-import { rest } from "msw";
+import { http, HttpResponse } from "msw";
 import { setupServer } from "msw/node";
 
 import { apiBaseUrl } from "../utils/internal";
@@ -31,6 +31,8 @@ describe("Function: getUserAwards", () => {
       HiddenAwardsCount: 5,
       MasteryAwardsCount: 5,
       CompletionAwardsCount: 0,
+      BeatenHardcoreAwardsCount: 24,
+      BeatenSoftcoreAwardsCount: 7,
       EventAwardsCount: 0,
       SiteAwardsCount: 0,
       VisibleUserAwards: [
@@ -49,8 +51,8 @@ describe("Function: getUserAwards", () => {
     };
 
     server.use(
-      rest.get(`${apiBaseUrl}/API_GetUserAwards.php`, (_, res, ctx) =>
-        res(ctx.json(mockResponse))
+      http.get(`${apiBaseUrl}/API_GetUserAwards.php`, () =>
+        HttpResponse.json(mockResponse)
       )
     );
 
@@ -63,6 +65,8 @@ describe("Function: getUserAwards", () => {
       hiddenAwardsCount: 5,
       masteryAwardsCount: 5,
       completionAwardsCount: 0,
+      beatenHardcoreAwardsCount: 24,
+      beatenSoftcoreAwardsCount: 7,
       eventAwardsCount: 0,
       siteAwardsCount: 0,
       visibleUserAwards: [

package/src/user/getUserAwards.ts

@@ -31,6 +31,8 @@ import type { GetUserAwardsResponse, UserAwards } from "./models";
  *   hiddenAwardsCount: 2,
  *   masteryAwardsCount: 6,
  *   completionAwardsCount: 0,
+ *   beatenHardcoreAwardsCount: 24,
+ *   beatenSoftcoreAwardsCount: 7,
  *   eventAwardsCount: 0,
  *   siteAwardsCount: 2,
  *   visibleUserAwards: [

package/src/user/getUserClaims.test.ts

@@ -1,6 +1,6 @@
 /* eslint-disable sonarjs/no-duplicate-string */
 
-import { rest } from "msw";
+import { http, HttpResponse } from "msw";
 import { setupServer } from "msw/node";
 
 import { apiBaseUrl } from "../utils/internal";
@@ -48,8 +48,8 @@ describe("Function: getUserClaims", () => {
     ];
 
     server.use(
-      rest.get(`${apiBaseUrl}/API_GetUserClaims.php`, (_, res, ctx) =>
-        res(ctx.json(mockResponse))
+      http.get(`${apiBaseUrl}/API_GetUserClaims.php`, () =>
+        HttpResponse.json(mockResponse)
       )
     );
 

package/src/user/getUserCompletedGames.test.ts

@@ -1,6 +1,6 @@
 /* eslint-disable sonarjs/no-duplicate-string */
 
-import { rest } from "msw";
+import { http, HttpResponse } from "msw";
 import { setupServer } from "msw/node";
 
 import { apiBaseUrl } from "../utils/internal";
@@ -54,8 +54,8 @@ describe("Function: getUserCompletedGames", () => {
     ];
 
     server.use(
-      rest.get(`${apiBaseUrl}/API_GetUserCompletedGames.php`, (_, res, ctx) =>
-        res(ctx.json(mockResponse))
+      http.get(`${apiBaseUrl}/API_GetUserCompletedGames.php`, () =>
+        HttpResponse.json(mockResponse)
       )
     );
 

package/src/user/getUserGameRankAndScore.test.ts

@@ -1,4 +1,4 @@
-import { rest } from "msw";
+import { http, HttpResponse } from "msw";
 import { setupServer } from "msw/node";
 
 import { apiBaseUrl } from "../utils/internal";
@@ -36,8 +36,8 @@ describe("Function: getUserGameRankAndScore", () => {
     ];
 
     server.use(
-      rest.get(`${apiBaseUrl}/API_GetUserGameRankAndScore.php`, (_, res, ctx) =>
-        res(ctx.json(mockResponse))
+      http.get(`${apiBaseUrl}/API_GetUserGameRankAndScore.php`, () =>
+        HttpResponse.json(mockResponse)
       )
     );
 

package/src/user/getUserPoints.test.ts

@@ -1,4 +1,4 @@
-import { rest } from "msw";
+import { http, HttpResponse } from "msw";
 import { setupServer } from "msw/node";
 
 import { apiBaseUrl } from "../utils/internal";
@@ -32,8 +32,8 @@ describe("Function: getUserPoints", () => {
     };
 
     server.use(
-      rest.get(`${apiBaseUrl}/API_GetUserPoints.php`, (_, res, ctx) =>
-        res(ctx.json(mockResponse))
+      http.get(`${apiBaseUrl}/API_GetUserPoints.php`, () =>
+        HttpResponse.json(mockResponse)
       )
     );