npm - @retroachievements/api - Versions diffs - 1.2.0 → 1.3.0 - Mend

@retroachievements/api 1.2.0 → 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (190) hide show

package/README.md +37 -37
package/dist/__playground.d.ts +8 -8
package/dist/achievement/getAchievementUnlocks.d.ts +46 -46
package/dist/achievement/getAchievementUnlocks.test.d.ts +1 -1
package/dist/achievement/index.d.ts +2 -2
package/dist/achievement/models/achievement-unlock-entity.model.d.ts +29 -29
package/dist/achievement/models/get-achievement-unlocks-response.model.d.ts +30 -30
package/dist/achievement/models/index.d.ts +2 -2
package/dist/api.cjs +1 -1
package/dist/api.cjs.map +1 -1
package/dist/api.modern.js +1 -1
package/dist/api.modern.js.map +1 -1
package/dist/api.module.js +1 -1
package/dist/api.module.js.map +1 -1
package/dist/api.umd.js +1 -1
package/dist/api.umd.js.map +1 -1
package/dist/console/getConsoleIds.d.ts +22 -22
package/dist/console/getConsoleIds.test.d.ts +1 -1
package/dist/console/getGameList.d.ts +53 -53
package/dist/console/getGameList.test.d.ts +1 -1
package/dist/console/index.d.ts +3 -3
package/dist/console/models/console-id.model.d.ts +4 -4
package/dist/console/models/game-list.model.d.ts +15 -15
package/dist/console/models/get-console-ids-response.model.d.ts +4 -4
package/dist/console/models/get-game-list-response.model.d.ts +15 -15
package/dist/console/models/index.d.ts +4 -4
package/dist/feed/getAchievementOfTheWeek.d.ts +48 -48
package/dist/feed/getAchievementOfTheWeek.test.d.ts +1 -1
package/dist/feed/getActiveClaims.d.ts +40 -40
package/dist/feed/getActiveClaims.test.d.ts +1 -1
package/dist/feed/getClaims.d.ts +7 -7
package/dist/feed/getClaims.test.d.ts +1 -1
package/dist/feed/getTopTenUsers.d.ts +24 -24
package/dist/feed/getTopTenUsers.test.d.ts +1 -1
package/dist/feed/index.d.ts +5 -5
package/dist/feed/models/achievement-of-the-week.model.d.ts +32 -32
package/dist/feed/models/claim-set-type.enum.d.ts +4 -4
package/dist/feed/models/claim-status.enum.d.ts +5 -5
package/dist/feed/models/claim-type.enum.d.ts +4 -4
package/dist/feed/models/get-achievement-of-the-week-response.model.d.ts +32 -32
package/dist/feed/models/get-set-claims-response.model.d.ts +21 -21
package/dist/feed/models/get-top-ten-users-response.model.d.ts +10 -10
package/dist/feed/models/index.d.ts +10 -10
package/dist/feed/models/set-claim.model.d.ts +43 -43
package/dist/feed/models/top-ten-users-entity.model.d.ts +5 -5
package/dist/feed/models/top-ten-users.model.d.ts +2 -2
package/dist/game/getAchievementCount.d.ts +32 -32
package/dist/game/getAchievementCount.test.d.ts +1 -1
package/dist/game/getAchievementDistribution.d.ts +58 -58
package/dist/game/getAchievementDistribution.test.d.ts +1 -1
package/dist/game/getGame.d.ts +49 -49
package/dist/game/getGame.test.d.ts +1 -1
package/dist/game/getGameExtended.d.ts +69 -69
package/dist/game/getGameExtended.test.d.ts +1 -1
package/dist/game/getGameRankAndScore.d.ts +39 -39
package/dist/game/getGameRankAndScore.test.d.ts +1 -1
package/dist/game/getGameRating.d.ts +39 -39
package/dist/game/getGameRating.test.d.ts +1 -1
package/dist/game/index.d.ts +7 -7
package/dist/game/models/achievement-count.model.d.ts +4 -4
package/dist/game/models/achievement-distribution-flags.enum.d.ts +4 -4
package/dist/game/models/game-extended-achievement-entity.model.d.ts +15 -15
package/dist/game/models/game-extended-claim-entity.model.d.ts +7 -7
package/dist/game/models/game-extended.model.d.ts +25 -25
package/dist/game/models/game-rank-and-score-entity.model.d.ts +6 -6
package/dist/game/models/game-rating.model.d.ts +9 -9
package/dist/game/models/game.model.d.ts +19 -19
package/dist/game/models/get-achievement-count-response.model.d.ts +4 -4
package/dist/game/models/get-achievement-distribution-response.model.d.ts +1 -1
package/dist/game/models/get-game-extended-response.model.d.ts +50 -50
package/dist/game/models/get-game-rank-and-score-response.model.d.ts +8 -8
package/dist/game/models/get-game-rating-response.model.d.ts +9 -9
package/dist/game/models/get-game-response.model.d.ts +19 -19
package/dist/game/models/index.d.ts +14 -14
package/dist/index.d.ts +7 -7
package/dist/ticket/getTicketData.d.ts +159 -159
package/dist/ticket/getTicketData.test.d.ts +1 -1
package/dist/ticket/index.d.ts +2 -2
package/dist/ticket/models/achievement-ticket-stats-response.model.d.ts +7 -7
package/dist/ticket/models/achievement-ticket-stats.model.d.ts +7 -7
package/dist/ticket/models/game-ticket-stats.model.d.ts +9 -9
package/dist/ticket/models/game-tickets-response.model.d.ts +7 -7
package/dist/ticket/models/index.d.ts +12 -12
package/dist/ticket/models/most-ticketed-games-response.model.d.ts +12 -12
package/dist/ticket/models/most-ticketed-games.model.d.ts +11 -11
package/dist/ticket/models/recent-tickets-response.model.d.ts +6 -6
package/dist/ticket/models/recent-tickets.model.d.ts +6 -6
package/dist/ticket/models/response-ticket-entity.model.d.ts +24 -24
package/dist/ticket/models/ticket-entity.model.d.ts +24 -24
package/dist/ticket/models/tickets-by-user-response.model.d.ts +8 -8
package/dist/ticket/models/user-ticket-stats.model.d.ts +8 -8
package/dist/user/getAchievementsEarnedBetween.d.ts +59 -59
package/dist/user/getAchievementsEarnedBetween.test.d.ts +1 -1
package/dist/user/getAchievementsEarnedOnDay.d.ts +57 -57
package/dist/user/getAchievementsEarnedOnDay.test.d.ts +1 -1
package/dist/user/getGameInfoAndUserProgress.d.ts +81 -81
package/dist/user/getGameInfoAndUserProgress.test.d.ts +1 -1
package/dist/user/getUserAwards.d.ts +49 -47
package/dist/user/getUserAwards.test.d.ts +1 -1
package/dist/user/getUserClaims.d.ts +27 -27
package/dist/user/getUserClaims.test.d.ts +1 -1
package/dist/user/getUserCompletedGames.d.ts +56 -56
package/dist/user/getUserCompletedGames.test.d.ts +1 -1
package/dist/user/getUserGameRankAndScore.d.ts +45 -45
package/dist/user/getUserGameRankAndScore.test.d.ts +1 -1
package/dist/user/getUserPoints.d.ts +30 -30
package/dist/user/getUserPoints.test.d.ts +1 -1
package/dist/user/getUserProgress.d.ts +50 -50
package/dist/user/getUserProgress.test.d.ts +1 -1
package/dist/user/getUserRecentAchievements.d.ts +49 -49
package/dist/user/getUserRecentAchievements.test.d.ts +1 -1
package/dist/user/getUserRecentlyPlayedGames.d.ts +50 -50
package/dist/user/getUserRecentlyPlayedGames.test.d.ts +1 -1
package/dist/user/getUserSummary.d.ts +32 -32
package/dist/user/getUserSummary.test.d.ts +1 -1
package/dist/user/index.d.ts +13 -13
package/dist/user/models/award-type.model.d.ts +1 -1
package/dist/user/models/dated-user-achievement.model.d.ts +17 -17
package/dist/user/models/dated-user-achievements-response.model.d.ts +19 -19
package/dist/user/models/game-info-and-user-progress.model.d.ts +12 -12
package/dist/user/models/get-game-info-and-user-progress-response.model.d.ts +14 -14
package/dist/user/models/get-user-awards-response.model.d.ts +24 -22
package/dist/user/models/get-user-completed-games-response.model.d.ts +13 -13
package/dist/user/models/get-user-game-rank-and-score-response.model.d.ts +8 -8
package/dist/user/models/get-user-points-response.model.d.ts +4 -4
package/dist/user/models/get-user-progress-response.model.d.ts +10 -10
package/dist/user/models/get-user-recent-achievements-response.model.d.ts +18 -18
package/dist/user/models/get-user-recently-played-games-response.model.d.ts +17 -17
package/dist/user/models/get-user-summary-response.model.d.ts +82 -82
package/dist/user/models/index.d.ts +23 -23
package/dist/user/models/user-awards.model.d.ts +24 -22
package/dist/user/models/user-claims-response.model.d.ts +19 -19
package/dist/user/models/user-claims.model.d.ts +19 -19
package/dist/user/models/user-completed-games.model.d.ts +12 -12
package/dist/user/models/user-game-rank-and-score.model.d.ts +7 -7
package/dist/user/models/user-points.model.d.ts +4 -4
package/dist/user/models/user-progress.model.d.ts +9 -9
package/dist/user/models/user-recent-achievement.model.d.ts +16 -16
package/dist/user/models/user-recently-played-games.model.d.ts +16 -16
package/dist/user/models/user-summary.model.d.ts +82 -82
package/dist/utils/internal/apiBaseUrl.d.ts +1 -1
package/dist/utils/internal/buildRequestUrl.d.ts +2 -2
package/dist/utils/internal/buildRequestUrl.test.d.ts +1 -1
package/dist/utils/internal/call.d.ts +11 -20
package/dist/utils/internal/call.test.d.ts +1 -1
package/dist/utils/internal/id.model.d.ts +1 -1
package/dist/utils/internal/index.d.ts +5 -5
package/dist/utils/internal/serializeProperties.d.ts +4 -4
package/dist/utils/internal/serializeProperties.test.d.ts +1 -1
package/dist/utils/public/buildAuthorization.d.ts +22 -22
package/dist/utils/public/buildAuthorization.test.d.ts +1 -1
package/dist/utils/public/index.d.ts +3 -3
package/dist/utils/public/models/auth-object.model.d.ts +19 -19
package/dist/utils/public/models/index.d.ts +1 -1
package/package.json +24 -31
package/src/achievement/getAchievementUnlocks.test.ts +9 -12
package/src/console/getConsoleIds.test.ts +3 -3
package/src/console/getGameList.test.ts +3 -3
package/src/feed/getAchievementOfTheWeek.test.ts +5 -5
package/src/feed/getActiveClaims.test.ts +3 -3
package/src/feed/getClaims.test.ts +3 -3
package/src/feed/getTopTenUsers.test.ts +3 -3
package/src/game/getAchievementCount.test.ts +3 -3
package/src/game/getAchievementDistribution.test.ts +33 -44
package/src/game/getGame.test.ts +3 -3
package/src/game/getGameExtended.test.ts +3 -3
package/src/game/getGameRankAndScore.test.ts +3 -3
package/src/game/getGameRating.test.ts +3 -3
package/src/ticket/getTicketData.test.ts +13 -13
package/src/user/getAchievementsEarnedBetween.test.ts +3 -4
package/src/user/getAchievementsEarnedOnDay.test.ts +3 -4
package/src/user/getGameInfoAndUserProgress.test.ts +3 -4
package/src/user/getUserAwards.test.ts +7 -3
package/src/user/getUserAwards.ts +2 -0
package/src/user/getUserClaims.test.ts +3 -3
package/src/user/getUserCompletedGames.test.ts +3 -3
package/src/user/getUserGameRankAndScore.test.ts +3 -3
package/src/user/getUserPoints.test.ts +3 -3
package/src/user/getUserProgress.test.ts +3 -3
package/src/user/getUserRecentAchievements.test.ts +3 -4
package/src/user/getUserRecentlyPlayedGames.test.ts +3 -4
package/src/user/getUserSummary.test.ts +24 -3
package/src/user/getUserSummary.ts +1 -3
package/src/user/models/award-type.model.ts +5 -4
package/src/user/models/get-user-awards-response.model.ts +2 -0
package/src/user/models/user-awards.model.ts +2 -0
package/src/utils/internal/buildRequestUrl.ts +1 -1
package/src/utils/internal/call.test.ts +20 -4
package/src/utils/internal/call.ts +8 -12
package/src/utils/internal/serializeProperties.ts +4 -4

package/src/user/getUserProgress.test.ts CHANGED Viewed

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

package/src/user/getUserRecentAchievements.test.ts CHANGED Viewed

@@ -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: getUserRecentAchievements", () => {
     ];
     server.use(
-      rest.get(
-        `${apiBaseUrl}/API_GetUserRecentAchievements.php`,
-        (_, res, ctx) => res(ctx.json(mockResponse))
+      http.get(`${apiBaseUrl}/API_GetUserRecentAchievements.php`, () =>
+        HttpResponse.json(mockResponse)
       )
     );

package/src/user/getUserRecentlyPlayedGames.test.ts CHANGED Viewed

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

package/src/user/getUserSummary.test.ts CHANGED Viewed

@@ -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";
@@ -31,8 +31,8 @@ describe("Function: getUserSummary", () => {
     const mockResponse = mockGetUserSummaryResponse;
     server.use(
-      rest.get(`${apiBaseUrl}/API_GetUserSummary.php`, (_, res, ctx) =>
-        res(ctx.json(mockResponse))
+      http.get(`${apiBaseUrl}/API_GetUserSummary.php`, () =>
+        HttpResponse.json(mockResponse)
       )
     );
@@ -44,6 +44,27 @@ describe("Function: getUserSummary", () => {
     // ASSERT
     expect(response).toEqual(mockExpectedSummaryValue);
   });
+  it("given the API returns a 503, throws an error", async () => {
+    // ARRANGE
+    const authorization = buildAuthorization({
+      userName: "mockUserName",
+      webApiKey: "mockWebApiKey"
+    });
+    const mockResponse = "<html><body>the api is down</body></html>";
+    server.use(
+      http.get(`${apiBaseUrl}/API_GetUserSummary.php`, () =>
+        HttpResponse.json(mockResponse, { status: 503 })
+      )
+    );
+    // ASSERT
+    await expect(
+      getUserSummary(authorization, { userName: "WCopeland" })
+    ).rejects.toThrow();
+  });
 });
 const mockGetUserSummaryResponse: GetUserSummaryResponse = {

package/src/user/getUserSummary.ts CHANGED Viewed

@@ -17,7 +17,7 @@ import type { GetUserSummaryResponse, UserSummary } from "./models";
  * @param payload.userName The user for which to retrieve the summary for.
  *
  * @param payload.recentGamesCount Optional. The number of recent games to return.
- * This defaults to 5.
+ * This defaults to 0.
  *
  * @param payload.recentAchievementsCount Optional. The number of recent achievements
  * to return. This defaults to 5.
@@ -92,5 +92,3 @@ export const getUserSummary = async (
     ]
   });
 };
-// TODO: add test for this

package/src/user/models/award-type.model.ts CHANGED Viewed

@@ -1,7 +1,8 @@
 export type AwardType =
-  | "Mastery/Completion"
-  | "Achievement Unlocks Yield"
   | "Achievement Points Yield"
-  | "Patreon Supporter"
+  | "Achievement Unlocks Yield"
   | "Certified Legend"
-  | "Invalid or deprecated award type";
+  | "Game Beaten"
+  | "Invalid or deprecated award type"
+  | "Mastery/Completion"
+  | "Patreon Supporter";

package/src/user/models/get-user-awards-response.model.ts CHANGED Viewed

@@ -17,6 +17,8 @@ export interface GetUserAwardsResponse {
   HiddenAwardsCount: number;
   MasteryAwardsCount: number;
   CompletionAwardsCount: number;
+  BeatenHardcoreAwardsCount: number;
+  BeatenSoftcoreAwardsCount: number;
   EventAwardsCount: number;
   SiteAwardsCount: number;
   VisibleUserAwards: GetUserAwardsEntity[];

package/src/user/models/user-awards.model.ts CHANGED Viewed

@@ -17,6 +17,8 @@ export interface UserAwards {
   hiddenAwardsCount: number;
   masteryAwardsCount: number;
   completionAwardsCount: number;
+  beatenHardcoreAwardsCount: number;
+  beatenSoftcoreAwardsCount: number;
   eventAwardsCount: number;
   siteAwardsCount: number;
   visibleUserAwards: UserAward[];

package/src/utils/internal/buildRequestUrl.ts CHANGED Viewed

@@ -7,7 +7,7 @@ export const buildRequestUrl = (
   args: Record<string, string | number> = {}
 ) => {
   const concatenated = `${baseUrl}/${endpointUrl}`;
-  const withoutDoubleSlashes = concatenated.replace(/([^:]\/)\/+/g, "$1");
+  const withoutDoubleSlashes = concatenated.replaceAll(/([^:]\/)\/+/g, "$1");
   let withArgs = withoutDoubleSlashes;

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

@@ -1,4 +1,4 @@
-import { rest } from "msw";
+import { http, HttpResponse } from "msw";
 import { setupServer } from "msw/node";
 import { call } from "./call";
@@ -23,9 +23,9 @@ describe("Util: call", () => {
     const mockRequestUrl = "https://abc.xyz/v1/endpoint";
     server.use(
-      rest.get(mockRequestUrl, (req, res, ctx) => {
-        receivedMethod = req.method;
-        return res(ctx.json({ foo: "bar" }));
+      http.get(mockRequestUrl, (info) => {
+        receivedMethod = info.request.method;
+        return HttpResponse.json({ foo: "bar" });
       })
     );
@@ -36,4 +36,20 @@ describe("Util: call", () => {
     expect(response).toEqual({ foo: "bar" });
     expect(receivedMethod).toEqual("GET");
   });
+  it("given the call returns an error, throws an error", async () => {
+    // ARRANGE
+    const mockRequestUrl = "https://abc.xyz/v1/endpoint2";
+    server.use(
+      http.get(mockRequestUrl, () =>
+        HttpResponse.text("<HTML><BODY>something bad happened</BODY></HTML>", {
+          status: 503
+        })
+      )
+    );
+    // ASSERT
+    await expect(call({ url: mockRequestUrl })).rejects.toThrow();
+  });
 });

package/src/utils/internal/call.ts CHANGED Viewed

@@ -1,5 +1,3 @@
-import unfetch from "isomorphic-unfetch";
 /**
  * Fetch an HTTP resource. This is publicly exposed in the
  * event you would like to access an endpoint that this
@@ -7,15 +5,6 @@ import unfetch from "isomorphic-unfetch";
  *
  * UNLESS YOU'RE SURE OF WHAT YOU'RE DOING, YOU PROBABLY
  * SHOULDN'T USE THIS FUNCTION.
- *
- * 2022-10-09: At the time of writing, Node.js LTS (16.x)
- * does not yet support fetch. As a result, we pull in
- * isomorphic-unfetch for Node.js compatibility. Our support
- * matrix includes 14.x and 16.x.
- *
- * @FIXME - When Node.js 20.x is released, remove the
- * isomorphic-unfetch dependency. At that point we will have
- * two major LTS versions that include a native fetch API.
  */
 export const call = async <
   T extends readonly any[] | Record<string, any>
@@ -24,6 +13,13 @@ export const call = async <
 }) => {
   const { url } = config;
-  const rawResponse = await unfetch(url);
+  const rawResponse = await fetch(url);
+  if (!rawResponse.ok) {
+    throw new Error(
+      `HTTP Error: Status ${rawResponse.status} ${rawResponse.statusText}`
+    );
+  }
   return (await rawResponse.json()) as T;
 };

package/src/utils/internal/serializeProperties.ts CHANGED Viewed

@@ -63,16 +63,16 @@ const naiveCamelCase = (originalValue: string) => {
     originalValue.charAt(0).toLowerCase() + originalValue.slice(1);
   // "gameID" -> "gameId"
-  camelCased = camelCased.replace(/ID/g, "Id");
+  camelCased = camelCased.replaceAll("ID", "Id");
   // "badgeURL" --> "badgeUrl"
-  camelCased = camelCased.replace(/URL/g, "Url");
+  camelCased = camelCased.replaceAll("URL", "Url");
   // "rAPoints" -> "raPoints"
-  camelCased = camelCased.replace(/rA/g, "ra");
+  camelCased = camelCased.replaceAll("rA", "ra");
   // "visibleUserawards" -> "visibleUserAwards"
-  camelCased = camelCased.replace(/visibleUserawards/g, "visibleUserAwards");
+  camelCased = camelCased.replaceAll("visibleUserawards", "visibleUserAwards");
   return camelCased;
 };