@retroachievements/api 2.1.0 → 2.3.0

package/dist/user/getUserWantToPlayList.d.ts

@@ -0,0 +1,47 @@
+import type { AuthObject } from "../utils/public";
+import type { UserWantToPlayList } from "./models";
+/**
+ * A call to this function will retrieve a user's "Want to Play Games" list.
+ *
+ * @param authorization An object containing your username and webApiKey.
+ * This can be constructed with `buildAuthorization()`.
+ *
+ * @param payload.username The user for which to retrieve the
+ * want to play games list for.
+ *
+ * @param payload.offset Defaults to 0. The number of entries to skip.
+ *
+ * @param payload.count Defaults to 100, has a max of 500.
+ *
+ * @example
+ * ```
+ * const wantToPlayList = await getUserWantToPlayList(
+ *   authorization,
+ *   { username: "wv_pinball" }
+ * );
+ * ```
+ *
+ * @returns An object containing a user's list of "Want to Play Games".
+ * ```json
+ * {
+ *   "count": 100,
+ *   "total": 1287,
+ *   "results": [
+ *     {
+ *       "id": 20246,
+ *       "title": "~Hack~ Knuckles the Echidna in Sonic the Hedgehog",
+ *       "imageIcon": "/Images/074560.png",
+ *       "consoleID": 1,
+ *       "consoleName": "Genesis/Mega Drive",
+ *       "pointsTotal": 1500,
+ *       "achievementsPublished": 50
+ *     }
+ *   ]
+ * }
+ * ```
+ */
+export declare const getUserWantToPlayList: (authorization: AuthObject, payload: {
+    username: string;
+    offset?: number;
+    count?: number;
+}) => Promise<UserWantToPlayList>;

package/dist/user/getUserWantToPlayList.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/user/index.d.ts

@@ -12,4 +12,5 @@ export * from "./getUserProgress";
 export * from "./getUserRecentAchievements";
 export * from "./getUserRecentlyPlayedGames";
 export * from "./getUserSummary";
+export * from "./getUserWantToPlayList";
 export * from "./models";

package/dist/user/models/get-user-want-to-play-list-response.model.d.ts

@@ -0,0 +1,13 @@
+export interface GetUserWantToPlayListResponse {
+    Count: number;
+    Total: number;
+    Results: Array<{
+        ID: number;
+        Title: string;
+        ImageIcon: string;
+        ConsoleID: number;
+        ConsoleName: string;
+        PointsTotal: number;
+        AchievementsPublished: number;
+    }>;
+}

package/dist/user/models/index.d.ts

@@ -13,6 +13,7 @@ export * from "./get-user-progress-response.model";
 export * from "./get-user-recent-achievements-response.model";
 export * from "./get-user-recently-played-games-response.model";
 export * from "./get-user-summary-response.model";
+export * from "./get-user-want-to-play-list-response.model";
 export * from "./user-awards.model";
 export * from "./user-claims.model";
 export * from "./user-claims-response.model";
@@ -26,3 +27,4 @@ export * from "./user-progress.model";
 export * from "./user-recent-achievement.model";
 export * from "./user-recently-played-games.model";
 export * from "./user-summary.model";
+export * from "./user-want-to-play-list.model";

package/dist/user/models/user-want-to-play-list.model.d.ts

@@ -0,0 +1,13 @@
+export interface UserWantToPlayList {
+    count: number;
+    total: number;
+    results: Array<{
+        id: number;
+        title: string;
+        imageIcon: string;
+        consoleId: number;
+        consoleName: string;
+        pointsTotal: number;
+        achievementsPublished: number;
+    }>;
+}

package/package.json

@@ -10,7 +10,7 @@
     "raweb",
     "retro gaming"
   ],
-  "version": "2.1.0",
+  "version": "2.3.0",
   "typings": "dist/index.d.ts",
   "exports": {
     ".": {

package/src/achievement/getAchievementUnlocks.test.ts

@@ -45,6 +45,7 @@ describe("Function: getAchievementUnlocks", () => {
         {
           User: "Tiotroll2022",
           RAPoints: "348",
+          RASoftcorePoints: "363",
           DateAwarded: "2023-01-29 21:45:41",
           HardcoreMode: "0",
         },
@@ -91,6 +92,7 @@ describe("Function: getAchievementUnlocks", () => {
         {
           user: "Tiotroll2022",
           raPoints: 348,
+          raSoftcorePoints: 363,
           dateAwarded: "2023-01-29 21:45:41",
           hardcoreMode: false,
         },

package/src/achievement/getAchievementUnlocks.ts

@@ -75,7 +75,13 @@ export const getAchievementUnlocks = async (
   const rawResponse = await call<GetAchievementUnlocksResponse>({ url });
 
   return serializeProperties(rawResponse, {
-    shouldCastToNumbers: ["ID", "Points", "TrueRatio", "RAPoints"],
+    shouldCastToNumbers: [
+      "ID",
+      "Points",
+      "TrueRatio",
+      "RAPoints",
+      "RASoftcorePoints",
+    ],
     shouldMapToBooleans: ["HardcoreMode"],
   });
 };

package/src/achievement/models/achievement-unlock-entity.model.ts

@@ -1,6 +1,7 @@
 export interface AchievementUnlockEntity {
   user: string;
   raPoints: number;
+  raSoftcorePoints: number;
   dateAwarded: string;
   hardcoreMode: boolean;
 }

package/src/achievement/models/get-achievement-unlocks-response.model.ts

@@ -1,6 +1,7 @@
 interface AchievementUnlocksResponseEntity {
   User: string;
   RAPoints: string;
+  RASoftcorePoints: string;
   DateAwarded: string;
   HardcoreMode: string;
 }

package/src/console/getConsoleIds.test.ts

@@ -62,7 +62,10 @@ describe("Function: getConsoleIds", () => {
     );
 
     // ACT
-    const response = await getConsoleIds(authorization);
+    const response = await getConsoleIds(authorization, {
+      shouldOnlyRetrieveActiveSystems: true,
+      shouldOnlyRetrieveGameSystems: true,
+    });
 
     // ASSERT
     const expectedResponse: FetchedSystem[] = [

package/src/feed/getAchievementOfTheWeek.test.ts

@@ -53,6 +53,7 @@ describe("Function: getAchievementOfTheWeek", () => {
         {
           User: "Tirbaba2",
           RAPoints: "72",
+          RASoftcorePoints: "72",
           DateAwarded: "2022-10-10 01:42:19",
           HardcoreMode: "1",
         },
@@ -91,6 +92,7 @@ describe("Function: getAchievementOfTheWeek", () => {
         {
           user: "Tirbaba2",
           raPoints: 72,
+          raSoftcorePoints: 72,
           dateAwarded: "2022-10-10 01:42:19",
           hardcoreMode: true,
         },
@@ -131,6 +133,7 @@ describe("Function: getAchievementOfTheWeek", () => {
         {
           User: "Tirbaba2",
           RAPoints: "72",
+          RASoftcorePoints: "72",
           DateAwarded: "2022-10-10 01:42:19",
           HardcoreMode: "0",
         },
@@ -169,6 +172,7 @@ describe("Function: getAchievementOfTheWeek", () => {
         {
           user: "Tirbaba2",
           raPoints: 72,
+          raSoftcorePoints: 72,
           dateAwarded: "2022-10-10 01:42:19",
           hardcoreMode: false,
         },

package/src/feed/getAchievementOfTheWeek.ts

@@ -48,7 +48,8 @@ import type {
  *   unlocks: [
  *     {
  *       user: "Tirbaba2",
- *       rAPoints: "72",
+ *       raPoints: "72",
+ *       raSoftcorePoints: "72",
  *       dateAwarded: "2022-10-10 01:42:19",
  *       hardcoreMode: "1"
  *     }
@@ -75,6 +76,7 @@ export const getAchievementOfTheWeek = async (
       "TrueRatio",
       "TotalPlayers",
       "RAPoints",
+      "RASoftcorePoints",
       "UnlocksCount",
     ],
     shouldMapToBooleans: ["HardcoreMode"],

package/src/feed/getRecentGameAwards.test.ts

@@ -49,7 +49,12 @@ describe("Function: getRecentGameAwards", () => {
     );
 
     // ACT
-    const response = await getRecentGameAwards(authorization);
+    const response = await getRecentGameAwards(authorization, {
+      startDate: "2025-01-05",
+      offset: 10,
+      count: 10,
+      desiredAwardKinds: ["completed"],
+    });
 
     const expectedResponse: RecentGameAwards = {
       count: 1,

package/src/feed/models/achievement-of-the-week.model.ts

@@ -21,6 +21,7 @@ export interface AchievementOfTheWeek {
   unlocks: Array<{
     user: string;
     raPoints: number;
+    raSoftcorePoints: number;
     dateAwarded: string;
     hardcoreMode: boolean;
   }>;

package/src/feed/models/get-achievement-of-the-week-response.model.ts

@@ -21,6 +21,7 @@ export interface GetAchievementOfTheWeekResponse {
   Unlocks: Array<{
     User: string;
     RAPoints: string;
+    RASoftcorePoints: string;
     DateAwarded: string;
     HardcoreMode: string;
   }>;

package/src/game/getGameExtended.test.ts

@@ -75,7 +75,10 @@ describe("Function: getGameExtended", () => {
     );
 
     // ACT
-    const response = await getGameExtended(authorization, { gameId: 14_402 });
+    const response = await getGameExtended(authorization, {
+      gameId: 14_402,
+      isRequestingUnofficialAchievements: true,
+    });
 
     // ASSERT
     expect(response).toEqual({

package/src/game/getGameHashes.test.ts

@@ -0,0 +1,77 @@
+/* eslint-disable sonarjs/no-duplicate-string */
+
+import { http, HttpResponse } from "msw";
+import { setupServer } from "msw/node";
+
+import { apiBaseUrl } from "../utils/internal";
+import { buildAuthorization } from "../utils/public";
+import { getGameHashes } from "./getGameHashes";
+import type { GetGameHashesResponse } from "./models";
+
+const server = setupServer();
+
+describe("Function: getGameHashes", () => {
+  // MSW Setup
+  beforeAll(() => server.listen());
+  afterEach(() => server.resetHandlers());
+  afterAll(() => server.close());
+
+  it("is defined #sanity", () => {
+    // ASSERT
+    expect(getGameHashes).toBeDefined();
+  });
+
+  it("given a game ID, retrieves a list of linked hashes", async () => {
+    // ARRANGE
+    const authorization = buildAuthorization({
+      username: "mockUserName",
+      webApiKey: "mockWebApiKey",
+    });
+
+    const mockResponse: GetGameHashesResponse = {
+      Results: [
+        {
+          Name: "Sonic The Hedgehog (USA, Europe) (Ru) (NewGame).md",
+          MD5: "1b1d9ac862c387367e904036114c4825",
+          Labels: ["nointro", "rapatches"],
+          PatchUrl:
+            "https://github.com/RetroAchievements/RAPatches/raw/main/MD/Translation/Russian/1-Sonic1-Russian.zip",
+        },
+        {
+          Name: "Sonic The Hedgehog (USA, Europe).md",
+          MD5: "1bc674be034e43c96b86487ac69d9293",
+          Labels: ["nointro"],
+          PatchUrl: null,
+        },
+      ],
+    };
+
+    server.use(
+      http.get(`${apiBaseUrl}/API_GetGameHashes.php`, () =>
+        HttpResponse.json(mockResponse)
+      )
+    );
+
+    // ACT
+    const response = await getGameHashes(authorization, { gameId: 1 });
+
+    // ASSERT
+    expect(response).toEqual({
+      results: [
+        {
+          name: "Sonic The Hedgehog (USA, Europe) (Ru) (NewGame).md",
+          md5: "1b1d9ac862c387367e904036114c4825",
+          labels: ["nointro", "rapatches"],
+          patchUrl:
+            "https://github.com/RetroAchievements/RAPatches/raw/main/MD/Translation/Russian/1-Sonic1-Russian.zip",
+        },
+        {
+          name: "Sonic The Hedgehog (USA, Europe).md",
+          md5: "1bc674be034e43c96b86487ac69d9293",
+          labels: ["nointro"],
+          patchUrl: null,
+        },
+      ],
+    });
+  });
+});

package/src/game/getGameHashes.ts

@@ -0,0 +1,66 @@
+import type { ID } from "../utils/internal";
+import {
+  apiBaseUrl,
+  buildRequestUrl,
+  call,
+  serializeProperties,
+} from "../utils/internal";
+import type { AuthObject } from "../utils/public";
+import type { GameHashes, GetGameHashesResponse } from "./models";
+
+/**
+ * A call to this function will retrieve a list of hashes linked to a game.
+ *
+ * @param authorization An object containing your username and webApiKey.
+ * This can be constructed with `buildAuthorization()`.
+ *
+ * @param payload.gameId The unique game ID. If you are unsure, open the
+ * game's page on the RetroAchievements.org website. For example, Dragster's
+ * URL is https://retroachievements.org/game/14402. We can see from the
+ * URL that the game ID is "14402".
+ *
+ * @example
+ * ```
+ * const game = await getGameHashes(
+ *   authorization,
+ *   { gameId: 14402 }
+ * );
+ * ```
+ *
+ * @returns An object containing a list of game hashes.
+ * ```json
+ * {
+ *   "results": [
+ *     {
+ *       "md5": "1b1d9ac862c387367e904036114c4825",
+ *       "name": "Sonic The Hedgehog (USA, Europe) (Ru) (NewGame).md",
+ *       "labels": ["nointro", "rapatches"],
+ *       "patchUrl": "https://github.com/RetroAchievements/RAPatches/raw/main/MD/Translation/Russian/1-Sonic1-Russian.zip"
+ *     },
+ *     {
+ *       "md5": "1bc674be034e43c96b86487ac69d9293",
+ *       "name": "Sonic The Hedgehog (USA, Europe).md",
+ *       "labels": ["nointro"],
+ *       "patchUrl": null
+ *     }
+ *   ]
+ * }
+ * ```
+ */
+export const getGameHashes = async (
+  authorization: AuthObject,
+  payload: { gameId: ID }
+): Promise<GameHashes> => {
+  const { gameId } = payload;
+
+  const url = buildRequestUrl(
+    apiBaseUrl,
+    "/API_GetGameHashes.php",
+    authorization,
+    { i: gameId }
+  );
+
+  const rawResponse = await call<GetGameHashesResponse>({ url });
+
+  return serializeProperties(rawResponse);
+};

package/src/game/index.ts

@@ -2,6 +2,7 @@ export * from "./getAchievementCount";
 export * from "./getAchievementDistribution";
 export * from "./getGame";
 export * from "./getGameExtended";
+export * from "./getGameHashes";
 export * from "./getGameRankAndScore";
 export * from "./getGameRating";
 export * from "./models";

package/src/game/models/game-hashes.model.ts

@@ -0,0 +1,10 @@
+interface GameHash {
+  md5: string;
+  name: string;
+  labels: string[];
+  patchUrl: string;
+}
+
+export interface GameHashes {
+  results: GameHash[];
+}

package/src/game/models/get-game-hashes-response.model.ts

@@ -0,0 +1,10 @@
+interface GameHashResult {
+  MD5: string;
+  Name: string;
+  Labels: string[];
+  PatchUrl: string;
+}
+
+export interface GetGameHashesResponse {
+  Results: GameHashResult[];
+}

package/src/game/models/index.ts

@@ -4,11 +4,13 @@ export * from "./game.model";
 export * from "./game-extended.model";
 export * from "./game-extended-achievement-entity.model";
 export * from "./game-extended-claim-entity.model";
+export * from "./game-hashes.model";
 export * from "./game-rank-and-score-entity.model";
 export * from "./game-rating.model";
 export * from "./get-achievement-count-response.model";
 export * from "./get-achievement-distribution-response.model";
 export * from "./get-game-extended-response.model";
+export * from "./get-game-hashes-response.model";
 export * from "./get-game-rank-and-score-response.model";
 export * from "./get-game-rating-response.model";
 export * from "./get-game-response.model";

package/src/user/getUserWantToPlayList.test.ts

@@ -0,0 +1,75 @@
+/* eslint-disable sonarjs/no-duplicate-string */
+
+import { http, HttpResponse } from "msw";
+import { setupServer } from "msw/node";
+
+import { apiBaseUrl } from "../utils/internal";
+import { buildAuthorization } from "../utils/public";
+import { getUserWantToPlayList } from "./getUserWantToPlayList";
+import type { GetUserWantToPlayListResponse } from "./models";
+
+const server = setupServer();
+
+describe("Function: getUserWantToPlayList", () => {
+  // MSW Setup
+  beforeAll(() => server.listen());
+  afterEach(() => server.resetHandlers());
+  afterAll(() => server.close());
+
+  it("is defined #sanity", () => {
+    // ASSERT
+    expect(getUserWantToPlayList).toBeDefined();
+  });
+
+  it('given a username, retrieves that users "Want To Play Games"', async () => {
+    // ARRANGE
+    const authorization = buildAuthorization({
+      username: "mockUserName",
+      webApiKey: "mockWebApiKey",
+    });
+
+    const mockResponse: GetUserWantToPlayListResponse = {
+      Count: 100,
+      Total: 1287,
+      Results: [
+        {
+          ID: 20_246,
+          Title: "~Hack~ Knuckles the Echidna in Sonic the Hedgehog",
+          ImageIcon: "/Images/074560.png",
+          ConsoleID: 1,
+          ConsoleName: "Genesis/Mega Drive",
+          PointsTotal: 1500,
+          AchievementsPublished: 50,
+        },
+      ],
+    };
+
+    server.use(
+      http.get(`${apiBaseUrl}/API_GetUserWantToPlayList.php`, () =>
+        HttpResponse.json(mockResponse)
+      )
+    );
+
+    // ACT
+    const response = await getUserWantToPlayList(authorization, {
+      username: "xelnia",
+    });
+
+    // ASSERT
+    expect(response).toEqual({
+      count: 100,
+      total: 1287,
+      results: [
+        {
+          id: 20_246,
+          title: "~Hack~ Knuckles the Echidna in Sonic the Hedgehog",
+          imageIcon: "/Images/074560.png",
+          consoleId: 1,
+          consoleName: "Genesis/Mega Drive",
+          pointsTotal: 1500,
+          achievementsPublished: 50,
+        },
+      ],
+    });
+  });
+});

package/src/user/getUserWantToPlayList.ts

@@ -0,0 +1,76 @@
+import {
+  apiBaseUrl,
+  buildRequestUrl,
+  call,
+  serializeProperties,
+} from "../utils/internal";
+import type { AuthObject } from "../utils/public";
+import type {
+  GetUserWantToPlayListResponse,
+  UserWantToPlayList,
+} from "./models";
+
+/**
+ * A call to this function will retrieve a user's "Want to Play Games" list.
+ *
+ * @param authorization An object containing your username and webApiKey.
+ * This can be constructed with `buildAuthorization()`.
+ *
+ * @param payload.username The user for which to retrieve the
+ * want to play games list for.
+ *
+ * @param payload.offset Defaults to 0. The number of entries to skip.
+ *
+ * @param payload.count Defaults to 100, has a max of 500.
+ *
+ * @example
+ * ```
+ * const wantToPlayList = await getUserWantToPlayList(
+ *   authorization,
+ *   { username: "wv_pinball" }
+ * );
+ * ```
+ *
+ * @returns An object containing a user's list of "Want to Play Games".
+ * ```json
+ * {
+ *   "count": 100,
+ *   "total": 1287,
+ *   "results": [
+ *     {
+ *       "id": 20246,
+ *       "title": "~Hack~ Knuckles the Echidna in Sonic the Hedgehog",
+ *       "imageIcon": "/Images/074560.png",
+ *       "consoleID": 1,
+ *       "consoleName": "Genesis/Mega Drive",
+ *       "pointsTotal": 1500,
+ *       "achievementsPublished": 50
+ *     }
+ *   ]
+ * }
+ * ```
+ */
+export const getUserWantToPlayList = async (
+  authorization: AuthObject,
+  payload: { username: string; offset?: number; count?: number }
+): Promise<UserWantToPlayList> => {
+  const queryParams: Record<string, any> = {};
+  queryParams.u = payload.username;
+  if (payload?.offset) {
+    queryParams.o = payload.offset;
+  }
+  if (payload?.count) {
+    queryParams.c = payload.count;
+  }
+
+  const url = buildRequestUrl(
+    apiBaseUrl,
+    "/API_GetUserWantToPlayList.php",
+    authorization,
+    queryParams
+  );
+
+  const rawResponse = await call<GetUserWantToPlayListResponse>({ url });
+
+  return serializeProperties(rawResponse);
+};

package/src/user/index.ts

@@ -12,4 +12,5 @@ export * from "./getUserProgress";
 export * from "./getUserRecentAchievements";
 export * from "./getUserRecentlyPlayedGames";
 export * from "./getUserSummary";
+export * from "./getUserWantToPlayList";
 export * from "./models";

package/src/user/models/get-user-want-to-play-list-response.model.ts

@@ -0,0 +1,13 @@
+export interface GetUserWantToPlayListResponse {
+  Count: number;
+  Total: number;
+  Results: Array<{
+    ID: number;
+    Title: string;
+    ImageIcon: string;
+    ConsoleID: number;
+    ConsoleName: string;
+    PointsTotal: number;
+    AchievementsPublished: number;
+  }>;
+}

package/src/user/models/index.ts

@@ -13,6 +13,7 @@ export * from "./get-user-progress-response.model";
 export * from "./get-user-recent-achievements-response.model";
 export * from "./get-user-recently-played-games-response.model";
 export * from "./get-user-summary-response.model";
+export * from "./get-user-want-to-play-list-response.model";
 export * from "./user-awards.model";
 export * from "./user-claims.model";
 export * from "./user-claims-response.model";
@@ -26,3 +27,4 @@ export * from "./user-progress.model";
 export * from "./user-recent-achievement.model";
 export * from "./user-recently-played-games.model";
 export * from "./user-summary.model";
+export * from "./user-want-to-play-list.model";

package/src/user/models/user-want-to-play-list.model.ts

@@ -0,0 +1,13 @@
+export interface UserWantToPlayList {
+  count: number;
+  total: number;
+  results: Array<{
+    id: number;
+    title: string;
+    imageIcon: string;
+    consoleId: number;
+    consoleName: string;
+    pointsTotal: number;
+    achievementsPublished: number;
+  }>;
+}