@retroachievements/api 1.5.1 → 1.5.3

package/src/game/getAchievementCount.test.ts

@@ -23,12 +23,12 @@ describe("Function: getAchievementCount", () => {
     // ARRANGE
     const authorization = buildAuthorization({
       userName: "mockUserName",
-      webApiKey: "mockWebApiKey"
+      webApiKey: "mockWebApiKey",
     });
 
     const mockResponse: GetAchievementCountResponse = {
       GameID: 8,
-      AchievementIDs: [1, 2, 3, 4, 5]
+      AchievementIDs: [1, 2, 3, 4, 5],
     };
 
     server.use(
@@ -43,7 +43,7 @@ describe("Function: getAchievementCount", () => {
     // ASSERT
     expect(response).toEqual({
       gameId: 8,
-      achievementIds: [1, 2, 3, 4, 5]
+      achievementIds: [1, 2, 3, 4, 5],
     });
   });
 });

package/src/game/getAchievementCount.ts

@@ -3,7 +3,7 @@ import {
   apiBaseUrl,
   buildRequestUrl,
   call,
-  serializeProperties
+  serializeProperties,
 } from "../utils/internal";
 import type { AuthObject } from "../utils/public";
 import type { AchievementCount, GetAchievementCountResponse } from "./models";

package/src/game/getAchievementDistribution.test.ts

@@ -24,7 +24,7 @@ describe("Function: getAchievementDistribution", () => {
     // ARRANGE
     const authorization = buildAuthorization({
       userName: "mockUserName",
-      webApiKey: "mockWebApiKey"
+      webApiKey: "mockWebApiKey",
     });
 
     const mockResponse: GetAchievementDistributionResponse = {
@@ -32,7 +32,7 @@ describe("Function: getAchievementDistribution", () => {
       "2": 10,
       "3": 8,
       "4": 4,
-      "5": 1
+      "5": 1,
     };
 
     let requestUrl = "";
@@ -47,7 +47,7 @@ describe("Function: getAchievementDistribution", () => {
 
     // ACT
     const response = await getAchievementDistribution(authorization, {
-      gameId: 14_402
+      gameId: 14_402,
     });
 
     // ASSERT
@@ -62,7 +62,7 @@ describe("Function: getAchievementDistribution", () => {
     // ARRANGE
     const authorization = buildAuthorization({
       userName: "mockUserName",
-      webApiKey: "mockWebApiKey"
+      webApiKey: "mockWebApiKey",
     });
 
     const mockResponse: GetAchievementDistributionResponse = {
@@ -70,7 +70,7 @@ describe("Function: getAchievementDistribution", () => {
       "2": 10,
       "3": 8,
       "4": 4,
-      "5": 1
+      "5": 1,
     };
 
     let requestUrl = "";
@@ -85,7 +85,7 @@ describe("Function: getAchievementDistribution", () => {
     // ACT
     const response = await getAchievementDistribution(authorization, {
       gameId: 14_402,
-      flags: AchievementDistributionFlags.UnofficialAchievements
+      flags: AchievementDistributionFlags.UnofficialAchievements,
     });
 
     // ASSERT
@@ -102,7 +102,7 @@ describe("Function: getAchievementDistribution", () => {
     // ARRANGE
     const authorization = buildAuthorization({
       userName: "mockUserName",
-      webApiKey: "mockWebApiKey"
+      webApiKey: "mockWebApiKey",
     });
 
     const mockResponse: GetAchievementDistributionResponse = {
@@ -110,7 +110,7 @@ describe("Function: getAchievementDistribution", () => {
       "2": 10,
       "3": 8,
       "4": 4,
-      "5": 1
+      "5": 1,
     };
 
     let requestUrl = "";
@@ -125,7 +125,7 @@ describe("Function: getAchievementDistribution", () => {
     // ACT
     const response = await getAchievementDistribution(authorization, {
       gameId: 14_402,
-      hardcore: true
+      hardcore: true,
     });
 
     // ASSERT
@@ -139,7 +139,7 @@ describe("Function: getAchievementDistribution", () => {
     // ARRANGE
     const authorization = buildAuthorization({
       userName: "mockUserName",
-      webApiKey: "mockWebApiKey"
+      webApiKey: "mockWebApiKey",
     });
 
     const mockResponse: GetAchievementDistributionResponse = {
@@ -147,7 +147,7 @@ describe("Function: getAchievementDistribution", () => {
       "2": 10,
       "3": 8,
       "4": 4,
-      "5": 1
+      "5": 1,
     };
 
     let requestUrl = "";
@@ -162,7 +162,7 @@ describe("Function: getAchievementDistribution", () => {
     // ACT
     const response = await getAchievementDistribution(authorization, {
       gameId: 14_402,
-      hardcore: false
+      hardcore: false,
     });
 
     // ASSERT

package/src/game/getAchievementDistribution.ts

@@ -3,7 +3,7 @@ import { apiBaseUrl, buildRequestUrl, call } from "../utils/internal";
 import type { AuthObject } from "../utils/public";
 import type {
   AchievementDistributionFlags,
-  GetAchievementDistributionResponse
+  GetAchievementDistributionResponse,
 } from "./models";
 
 /**
@@ -84,6 +84,6 @@ export const getAchievementDistribution = async (
   );
 
   return await call<GetAchievementDistributionResponse>({
-    url
+    url,
   });
 };

package/src/game/getGame.test.ts

@@ -25,7 +25,7 @@ describe("Function: getGame", () => {
     // ARRANGE
     const authorization = buildAuthorization({
       userName: "mockUserName",
-      webApiKey: "mockWebApiKey"
+      webApiKey: "mockWebApiKey",
     });
 
     const mockResponse: GetGameResponse = {
@@ -45,7 +45,7 @@ describe("Function: getGame", () => {
       Genre: "Racing",
       Released: "1980",
       GameTitle: "Dragster",
-      Console: "Atari 2600"
+      Console: "Atari 2600",
     };
 
     server.use(
@@ -75,7 +75,7 @@ describe("Function: getGame", () => {
       genre: "Racing",
       released: "1980",
       gameTitle: "Dragster",
-      console: "Atari 2600"
+      console: "Atari 2600",
     });
   });
 });

package/src/game/getGame.ts

@@ -3,7 +3,7 @@ import {
   apiBaseUrl,
   buildRequestUrl,
   call,
-  serializeProperties
+  serializeProperties,
 } from "../utils/internal";
 import type { AuthObject } from "../utils/public";
 import type { Game, GetGameResponse } from "./models";
@@ -58,12 +58,12 @@ export const getGame = async (
   const { gameId } = payload;
 
   const url = buildRequestUrl(apiBaseUrl, "/API_GetGame.php", authorization, {
-    i: gameId
+    i: gameId,
   });
 
   const rawResponse = await call<GetGameResponse>({ url });
 
   return serializeProperties(rawResponse, {
-    shouldCastToNumbers: ["ID", "ForumTopicID", "ConsoleID", "Flags"]
+    shouldCastToNumbers: ["ID", "ForumTopicID", "ConsoleID", "Flags"],
   });
 };

package/src/game/getGameExtended.test.ts

@@ -25,7 +25,7 @@ describe("Function: getGameExtended", () => {
     // ARRANGE
     const authorization = buildAuthorization({
       userName: "mockUserName",
-      webApiKey: "mockWebApiKey"
+      webApiKey: "mockWebApiKey",
     });
 
     const mockResponse: GetGameExtendedResponse = {
@@ -63,9 +63,9 @@ describe("Function: getGameExtended", () => {
           DateCreated: "2019-07-31 18:49:57",
           BadgeName: "85541",
           DisplayOrder: "0",
-          MemAddr: "f5c41fa0b5fa0d5fbb8a74c598f18582"
-        }
-      }
+          MemAddr: "f5c41fa0b5fa0d5fbb8a74c598f18582",
+        },
+      },
     };
 
     server.use(
@@ -113,9 +113,9 @@ describe("Function: getGameExtended", () => {
           dateCreated: "2019-07-31 18:49:57",
           badgeName: "85541",
           displayOrder: 0,
-          memAddr: "f5c41fa0b5fa0d5fbb8a74c598f18582"
-        }
-      }
+          memAddr: "f5c41fa0b5fa0d5fbb8a74c598f18582",
+        },
+      },
     });
   });
 });

package/src/game/getGameExtended.ts

@@ -3,7 +3,7 @@ import {
   apiBaseUrl,
   buildRequestUrl,
   call,
-  serializeProperties
+  serializeProperties,
 } from "../utils/internal";
 import type { AuthObject } from "../utils/public";
 import type { GameExtended, GetGameExtendedResponse } from "./models";
@@ -73,12 +73,12 @@ import type { GameExtended, GetGameExtendedResponse } from "./models";
  */
 export const getGameExtended = async (
   authorization: AuthObject,
-  payload: { gameId: ID; isRequestingUnofficialAchievements: boolean }
+  payload: { gameId: ID; isRequestingUnofficialAchievements?: boolean }
 ): Promise<GameExtended> => {
   const { gameId, isRequestingUnofficialAchievements } = payload;
 
   const params: Record<string, string | number> = {
-    i: gameId
+    i: gameId,
   };
 
   if (isRequestingUnofficialAchievements) {
@@ -103,7 +103,7 @@ export const getGameExtended = async (
       "TrueRatio",
       "DisplayOrder",
       "NumDistinctPlayersCasual",
-      "NumDistinctPlayersHardcore"
-    ]
+      "NumDistinctPlayersHardcore",
+    ],
   });
 };

package/src/game/getGameRankAndScore.test.ts

@@ -25,7 +25,7 @@ describe("Function: getGameRankAndScore", () => {
     // ARRANGE
     const authorization = buildAuthorization({
       userName: "mockUserName",
-      webApiKey: "mockWebApiKey"
+      webApiKey: "mockWebApiKey",
     });
 
     const mockResponse: GetGameRankAndScoreResponse = [
@@ -33,8 +33,8 @@ describe("Function: getGameRankAndScore", () => {
         User: "Arekdias",
         TotalScore: "189",
         LastAward: "2020-10-10 22:43:32",
-        Rank: 1
-      }
+        Rank: 1,
+      },
     ];
 
     server.use(
@@ -46,7 +46,7 @@ describe("Function: getGameRankAndScore", () => {
     // ACT
     const response = await getGameRankAndScore(authorization, {
       gameId: 14_402,
-      type: "high-scores"
+      type: "high-scores",
     });
 
     // ASSERT
@@ -55,8 +55,8 @@ describe("Function: getGameRankAndScore", () => {
         user: "Arekdias",
         totalScore: 189,
         lastAward: "2020-10-10 22:43:32",
-        rank: 1
-      }
+        rank: 1,
+      },
     ]);
   });
 });

package/src/game/getGameRankAndScore.ts

@@ -3,12 +3,12 @@ import {
   apiBaseUrl,
   buildRequestUrl,
   call,
-  serializeProperties
+  serializeProperties,
 } from "../utils/internal";
 import type { AuthObject } from "../utils/public";
 import type {
   GameRankAndScoreEntity,
-  GetGameRankAndScoreResponse
+  GetGameRankAndScoreResponse,
 } from "./models";
 
 /**
@@ -55,13 +55,13 @@ export const getGameRankAndScore = async (
     authorization,
     {
       g: gameId,
-      t: type === "latest-masters" ? 1 : 0
+      t: type === "latest-masters" ? 1 : 0,
     }
   );
 
   const rawResponse = await call<GetGameRankAndScoreResponse>({ url });
 
   return serializeProperties(rawResponse, {
-    shouldCastToNumbers: ["TotalScore"]
+    shouldCastToNumbers: ["TotalScore"],
   });
 };

package/src/game/getGameRating.test.ts

@@ -23,7 +23,7 @@ describe("Function: getGameRating", () => {
     // ARRANGE
     const authorization = buildAuthorization({
       userName: "mockUserName",
-      webApiKey: "mockWebApiKey"
+      webApiKey: "mockWebApiKey",
     });
 
     const mockResponse: GetGameRatingResponse = {
@@ -32,8 +32,8 @@ describe("Function: getGameRating", () => {
         Game: 3.1875,
         Achievements: 0,
         GameNumVotes: 16,
-        AchievementsNumVotes: 0
-      }
+        AchievementsNumVotes: 0,
+      },
     };
 
     server.use(
@@ -52,8 +52,8 @@ describe("Function: getGameRating", () => {
         game: 3.1875,
         achievements: 0,
         gameNumVotes: 16,
-        achievementsNumVotes: 0
-      }
+        achievementsNumVotes: 0,
+      },
     });
   });
 });

package/src/game/getGameRating.ts

@@ -3,7 +3,7 @@ import {
   apiBaseUrl,
   buildRequestUrl,
   call,
-  serializeProperties
+  serializeProperties,
 } from "../utils/internal";
 import type { AuthObject } from "../utils/public";
 import type { GameRating, GetGameRatingResponse } from "./models";

package/src/game/models/achievement-distribution-flags.enum.ts

@@ -1,4 +1,4 @@
 export enum AchievementDistributionFlags {
   CoreAchievements = 3,
-  UnofficialAchievements = 5
+  UnofficialAchievements = 5,
 }

package/src/game/models/game-extended-achievement-entity.model.ts

@@ -1,3 +1,5 @@
+import type { AchievementType } from "../../achievement";
+
 export interface GameExtendedAchievementEntity {
   id: number;
   numAwarded: number;
@@ -12,4 +14,5 @@ export interface GameExtendedAchievementEntity {
   badgeName: string;
   displayOrder: number;
   memAddr: string;
+  type: AchievementType;
 }

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

@@ -4,7 +4,7 @@
 
 enum GameExtendedClaimType {
   Primary = "0",
-  Collaboration = "1"
+  Collaboration = "1",
 }
 
 export interface GameExtendedRawAchievementEntity {

package/src/ticket/getTicketData.test.ts

@@ -10,7 +10,7 @@ import type {
   MostTicketedGamesResponse,
   RecentTicketsResponse,
   ResponseTicketEntity,
-  TicketsByUserResponse
+  TicketsByUserResponse,
 } from "./models";
 
 const server = setupServer();
@@ -29,7 +29,7 @@ describe("Function: getTicketData", () => {
     // ARRANGE
     const authorization = buildAuthorization({
       userName: "mockUserName",
-      webApiKey: "mockWebApiKey"
+      webApiKey: "mockWebApiKey",
     });
 
     const mockResponse: ResponseTicketEntity = {
@@ -54,7 +54,7 @@ describe("Function: getTicketData", () => {
       ResolvedBy: "televandalist",
       ReportStateDescription: "Resolved",
       ReportTypeDescription: "Triggered at the wrong time",
-      URL: "https://retroachievements.org/ticketmanager.php?i=10000"
+      URL: "https://retroachievements.org/ticketmanager.php?i=10000",
     };
 
     server.use(
@@ -89,7 +89,7 @@ describe("Function: getTicketData", () => {
       resolvedBy: "televandalist",
       reportStateDescription: "Resolved",
       reportTypeDescription: "Triggered at the wrong time",
-      url: "https://retroachievements.org/ticketmanager.php?i=10000"
+      url: "https://retroachievements.org/ticketmanager.php?i=10000",
     });
   });
 
@@ -97,7 +97,7 @@ describe("Function: getTicketData", () => {
     // ARRANGE
     const authorization = buildAuthorization({
       userName: "mockUserName",
-      webApiKey: "mockWebApiKey"
+      webApiKey: "mockWebApiKey",
     });
 
     const mockResponse: RecentTicketsResponse = {
@@ -128,11 +128,11 @@ describe("Function: getTicketData", () => {
           ResolvedBy: null,
           ReportState: "1",
           ReportStateDescription: "Open",
-          ReportTypeDescription: "Did not trigger"
-        }
+          ReportTypeDescription: "Did not trigger",
+        },
       ],
       OpenTickets: 715,
-      URL: "https://retroachievements.org/ticketmanager.php"
+      URL: "https://retroachievements.org/ticketmanager.php",
     };
 
     server.use(
@@ -173,11 +173,11 @@ describe("Function: getTicketData", () => {
           resolvedBy: null,
           reportState: 1,
           reportStateDescription: "Open",
-          reportTypeDescription: "Did not trigger"
-        }
+          reportTypeDescription: "Did not trigger",
+        },
       ],
       openTickets: 715,
-      url: "https://retroachievements.org/ticketmanager.php"
+      url: "https://retroachievements.org/ticketmanager.php",
     });
   });
 
@@ -185,7 +185,7 @@ describe("Function: getTicketData", () => {
     // ARRANGE
     const authorization = buildAuthorization({
       userName: "mockUserName",
-      webApiKey: "mockWebApiKey"
+      webApiKey: "mockWebApiKey",
     });
 
     const mockResponse: MostTicketedGamesResponse = {
@@ -195,17 +195,17 @@ describe("Function: getTicketData", () => {
           GameTitle: "Driver 2: The Wheelman Is Back",
           GameIcon: "/Images/046592.png",
           Console: "PlayStation",
-          OpenTickets: "16"
+          OpenTickets: "16",
         },
         {
           GameID: "5515",
           GameTitle: "Ninja Ryuuken Den | Ninja Gaiden",
           GameIcon: "/Images/020735.png",
           Console: "PC Engine",
-          OpenTickets: "15"
-        }
+          OpenTickets: "15",
+        },
       ],
-      URL: "https://retroachievements.org/ticketmanager.php?f=1"
+      URL: "https://retroachievements.org/ticketmanager.php?f=1",
     };
 
     server.use(
@@ -216,7 +216,7 @@ describe("Function: getTicketData", () => {
 
     // ACT
     const response = await getTicketData(authorization, {
-      isGettingMostTicketedGames: true
+      isGettingMostTicketedGames: true,
     });
 
     // ASSERT
@@ -227,17 +227,17 @@ describe("Function: getTicketData", () => {
           gameTitle: "Driver 2: The Wheelman Is Back",
           gameIcon: "/Images/046592.png",
           console: "PlayStation",
-          openTickets: 16
+          openTickets: 16,
         },
         {
           gameId: 5515,
           gameTitle: "Ninja Ryuuken Den | Ninja Gaiden",
           gameIcon: "/Images/020735.png",
           console: "PC Engine",
-          openTickets: 15
-        }
+          openTickets: 15,
+        },
       ],
-      url: "https://retroachievements.org/ticketmanager.php?f=1"
+      url: "https://retroachievements.org/ticketmanager.php?f=1",
     });
   });
 
@@ -245,7 +245,7 @@ describe("Function: getTicketData", () => {
     // ARRANGE
     const authorization = buildAuthorization({
       userName: "mockUserName",
-      webApiKey: "mockWebApiKey"
+      webApiKey: "mockWebApiKey",
     });
 
     const mockResponse: TicketsByUserResponse = {
@@ -254,7 +254,7 @@ describe("Function: getTicketData", () => {
       Closed: 18,
       Resolved: 51,
       Total: 69,
-      URL: "https://retroachievements.org/ticketmanager.php?u=Jamiras"
+      URL: "https://retroachievements.org/ticketmanager.php?u=Jamiras",
     };
 
     server.use(
@@ -273,7 +273,7 @@ describe("Function: getTicketData", () => {
       closed: 18,
       resolved: 51,
       total: 69,
-      url: "https://retroachievements.org/ticketmanager.php?u=Jamiras"
+      url: "https://retroachievements.org/ticketmanager.php?u=Jamiras",
     });
   });
 
@@ -281,7 +281,7 @@ describe("Function: getTicketData", () => {
     // ARRANGE
     const authorization = buildAuthorization({
       userName: "mockUserName",
-      webApiKey: "mockWebApiKey"
+      webApiKey: "mockWebApiKey",
     });
 
     const mockResponse: GameTicketsResponse = {
@@ -289,7 +289,7 @@ describe("Function: getTicketData", () => {
       GameTitle: "Rampage 2: Universal Tour",
       ConsoleName: "Nintendo 64",
       OpenTickets: 8,
-      URL: "https://retroachievements.org/ticketmanager.php?g=10329"
+      URL: "https://retroachievements.org/ticketmanager.php?g=10329",
     };
 
     server.use(
@@ -307,7 +307,7 @@ describe("Function: getTicketData", () => {
       gameTitle: "Rampage 2: Universal Tour",
       consoleName: "Nintendo 64",
       openTickets: 8,
-      url: "https://retroachievements.org/ticketmanager.php?g=10329"
+      url: "https://retroachievements.org/ticketmanager.php?g=10329",
     });
   });
 
@@ -315,7 +315,7 @@ describe("Function: getTicketData", () => {
     // ARRANGE
     const authorization = buildAuthorization({
       userName: "mockUserName",
-      webApiKey: "mockWebApiKey"
+      webApiKey: "mockWebApiKey",
     });
 
     const mockResponse: AchievementTicketStatsResponse = {
@@ -323,7 +323,7 @@ describe("Function: getTicketData", () => {
       AchievementTitle: "Blue Potaras Collector",
       AchievementDescription: "Unlock all Ability Type Z-Items",
       URL: "https://retroachievements.org/ticketmanager.php?a=283331",
-      OpenTickets: 1
+      OpenTickets: 1,
     };
 
     server.use(
@@ -334,7 +334,7 @@ describe("Function: getTicketData", () => {
 
     // ACT
     const response = await getTicketData(authorization, {
-      achievementId: 283_331
+      achievementId: 283_331,
     });
 
     // ASSERT
@@ -343,7 +343,7 @@ describe("Function: getTicketData", () => {
       achievementTitle: "Blue Potaras Collector",
       achievementDescription: "Unlock all Ability Type Z-Items",
       url: "https://retroachievements.org/ticketmanager.php?a=283331",
-      openTickets: 1
+      openTickets: 1,
     });
   });
 });

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> = {};