@retroachievements/api 1.2.1 → 1.4.0

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

@@ -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/get-user-completion-progress-response.model.ts

@@ -0,0 +1,25 @@
+interface RawUserCompletionProgressEntity {
+  GameID: number;
+  Title: string;
+  ImageIcon: string;
+  ConsoleID: number;
+  ConsoleName: string;
+  MaxPossible: number;
+  NumAwarded: number;
+  NumAwardedHardcore: number;
+
+  MostRecentAwardedDate?: string;
+  HighestAwardKind?:
+    | "mastered"
+    | "completed"
+    | "beaten-hardcore"
+    | "beaten-softcore"
+    | null;
+  HighestAwardDate?: string | null;
+}
+
+export interface GetUserCompletionProgressResponse {
+  Count: number;
+  Total: number;
+  Results: RawUserCompletionProgressEntity[];
+}

package/src/user/models/get-user-profile-response.model.ts

@@ -0,0 +1,17 @@
+export interface GetUserProfileResponse {
+  User: string;
+  UserPic: string;
+  MemberSince: string;
+  RichPresenceMsg: string;
+  LastGameID: number;
+  ContribCount: number;
+  ContribYield: number;
+  TotalPoints: number;
+  TotalSoftcorePoints: number;
+  TotalTruePoints: number;
+  Permissions: number;
+  Untracked: number;
+  ID: number;
+  UserWallActive: number;
+  Motto: string;
+}

package/src/user/models/index.ts

@@ -5,8 +5,10 @@ export * from "./game-info-and-user-progress.model";
 export * from "./get-game-info-and-user-progress-response.model";
 export * from "./get-user-awards-response.model";
 export * from "./get-user-completed-games-response.model";
+export * from "./get-user-completion-progress-response.model";
 export * from "./get-user-game-rank-and-score-response.model";
 export * from "./get-user-points-response.model";
+export * from "./get-user-profile-response.model";
 export * from "./get-user-progress-response.model";
 export * from "./get-user-recent-achievements-response.model";
 export * from "./get-user-recently-played-games-response.model";
@@ -15,8 +17,11 @@ export * from "./user-awards.model";
 export * from "./user-claims.model";
 export * from "./user-claims-response.model";
 export * from "./user-completed-games.model";
+export * from "./user-completion-progress.model";
+export * from "./user-completion-progress-entity.model";
 export * from "./user-game-rank-and-score.model";
 export * from "./user-points.model";
+export * from "./user-profile.model";
 export * from "./user-progress.model";
 export * from "./user-recent-achievement.model";
 export * from "./user-recently-played-games.model";

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

@@ -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/user/models/user-completion-progress-entity.model.ts

@@ -0,0 +1,19 @@
+export interface UserCompletionProgressEntity {
+  gameId: number;
+  title: string;
+  imageIcon: string;
+  consoleId: number;
+  consoleName: string;
+  maxPossible: number;
+  numAwarded: number;
+  numAwardedHardcore: number;
+
+  mostRecentAwardedDate?: string;
+  highestAwardKind?:
+    | "mastered"
+    | "completed"
+    | "beaten-hardcore"
+    | "beaten-softcore"
+    | null;
+  highestAwardDate?: string;
+}

package/src/user/models/user-completion-progress.model.ts

@@ -0,0 +1,7 @@
+import type { UserCompletionProgressEntity } from "./user-completion-progress-entity.model";
+
+export interface UserCompletionProgress {
+  count: number;
+  total: number;
+  results: UserCompletionProgressEntity[];
+}

package/src/user/models/user-profile.model.ts

@@ -0,0 +1,17 @@
+export interface UserProfile {
+  user: string;
+  userPic: string;
+  memberSince: string;
+  richPresenceMsg: string;
+  lastGameId: number;
+  contribCount: number;
+  contribYield: number;
+  totalPoints: number;
+  totalSoftcorePoints: number;
+  totalTruePoints: number;
+  permissions: number;
+  untracked: boolean;
+  id: number;
+  userWallActive: boolean;
+  motto: string;
+}

package/src/utils/internal/buildRequestUrl.ts

@@ -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

@@ -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" });
       })
     );
 
@@ -42,12 +42,11 @@ describe("Util: call", () => {
     const mockRequestUrl = "https://abc.xyz/v1/endpoint2";
 
     server.use(
-      rest.get(mockRequestUrl, (req, res, ctx) => {
-        return res(
-          ctx.status(503),
-          ctx.text("<HTML><BODY>something bad happened</BODY></HTML>")
-        );
-      })
+      http.get(mockRequestUrl, () =>
+        HttpResponse.text("<HTML><BODY>something bad happened</BODY></HTML>", {
+          status: 503
+        })
+      )
     );
 
     // ASSERT

package/src/utils/internal/call.ts

@@ -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,7 +13,7 @@ export const call = async <
 }) => {
   const { url } = config;
 
-  const rawResponse = await unfetch(url);
+  const rawResponse = await fetch(url);
 
   if (!rawResponse.ok) {
     throw new Error(

package/src/utils/internal/serializeProperties.ts

@@ -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;
 };