achievements-app#126 - change naming for purchased games functionality

alekpentchev · Mar 28, 2023 · 5b7ca8a · 5b7ca8a
1 parent 1bf9c5d
commit 5b7ca8a
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 25 deletions.
diff --git a/src/models/games-library-for-user.model.ts → ...ls/user-purchased-games-response.model.ts b/src/models/games-library-for-user.model.ts → ...ls/user-purchased-games-response.model.ts
@@ -1,4 +1,6 @@
-export interface GamesLibraryForUserResponse {
+import { TitlePlatform } from "./title-platform.model";
+
+export interface GetUserPurchasedGamesResponse {
   data: {
     purchasedTitlesRetrieve: {
       /**
@@ -13,12 +15,12 @@ export interface GamesLibraryForUserResponse {
       /**
        * The list of games in the library.
        */
-      games: Array<GameLibraryTitle>;
+      games: Array<PurchasedGame>;
     };
   };
 }
 
-export interface GameLibraryTitle {
+export interface PurchasedGame {
   /**
    * The type of resource retrieved.
    *
@@ -43,7 +45,7 @@ export interface GameLibraryTitle {
    * "entitlementId": "UP4433-CUSA18779_00-DUNGEONSPS400000"
    * ```
    */
-  entitlementId: string;
+  entitlementId: string | null;
 
   /**
    * The image of the game.
@@ -56,12 +58,12 @@ export interface GameLibraryTitle {
    * }
    * ```
    */
-  image: GameLibraryImage;
+  image: GameImage;
 
   /**
    * Whether the game is active or not.
    */
-  isActive: boolean;
+  isActive: boolean | null;
 
   /**
    * Whether the game is downloadable or not.
@@ -91,7 +93,7 @@ export interface GameLibraryTitle {
    * platform: "PS4"
    * ```
    */
-  platform: string;
+  platform: TitlePlatform | "UNKNOWN";
 
   /**
    * The ID of the product.
@@ -101,7 +103,7 @@ export interface GameLibraryTitle {
    * productId: "UP4433-CUSA18779_00"
    * ```
    */
-  productId: string;
+  productId: string | null;
 
   /**
    * The subscription service associated with the game.
@@ -111,7 +113,7 @@ export interface GameLibraryTitle {
    * subscriptionService: "PS_PLUS"
    * ```
    */
-  subscriptionService: string;
+  subscriptionService: "NONE" | string;
 
   /**
    * The ID of the title.
@@ -124,7 +126,7 @@ export interface GameLibraryTitle {
   titleId: string;
 }
 
-export interface GameLibraryImage {
+export interface GameImage {
   __typename: string;
   url: string;
 }
diff --git a/src/user/getUserGamesLibrary.test.ts → src/user/getUserPurchasedGames.test.ts b/src/user/getUserGamesLibrary.test.ts → src/user/getUserPurchasedGames.test.ts
@@ -2,21 +2,21 @@ import { rest } from "msw";
 import { setupServer } from "msw/node";
 
 import { AuthorizationPayload } from "../models";
-import { GamesLibraryForUserResponse } from "../models/games-library-for-user.model";
-import { getUserGamesLibrary } from "./getUserGamesLibrary";
+import { GetUserPurchasedGamesResponse } from "../models/user-purchased-games-response.model";
+import { getUserPurchasedGames } from "./getUserPurchasedGames";
 import { USER_GAMES_BASE_URL } from "./USER_GAMES_BASE_URL";
 
 const server = setupServer();
 
-describe("Function: getUserGamesLibrary", () => {
+describe("Function: getUserPurchasedGames", () => {
   // MSW Setup
   beforeAll(() => server.listen());
   afterEach(() => server.resetHandlers());
   afterAll(() => server.close());
 
   it("is defined #sanity", () => {
     // ASSERT
-    expect(getUserGamesLibrary).toBeDefined();
+    expect(getUserPurchasedGames).toBeDefined();
   });
 
   it("retrieve the games library for a given user", async () => {
@@ -25,13 +25,13 @@ describe("Function: getUserGamesLibrary", () => {
       accessToken: "mockAccessToken"
     };
 
-    const mockResponse: GamesLibraryForUserResponse = {
+    const mockResponse: GetUserPurchasedGamesResponse = {
       data: {
         purchasedTitlesRetrieve: {
           __typename: "GameList",
           games: [
             {
-              __typename: "GameLibraryTitle",
+              __typename: "PurchasedGame",
               conceptId: null,
               entitlementId: "UP4433-CUSA18779_00-DUNGEONSPS400000",
               image: {
@@ -48,7 +48,7 @@ describe("Function: getUserGamesLibrary", () => {
               titleId: "CUSA18779_00"
             },
             {
-              __typename: "GameLibraryTitle",
+              __typename: "PurchasedGame",
               conceptId: null,
               entitlementId: "UP0006-CUSA23249_00-KINGSTONGAME0000",
               image: {
@@ -76,7 +76,7 @@ describe("Function: getUserGamesLibrary", () => {
     );
 
     // ACT
-    const response = await getUserGamesLibrary(mockAuthorization);
+    const response = await getUserPurchasedGames(mockAuthorization);
     // ASSERT
     expect(response).toEqual(mockResponse);
   });
@@ -102,6 +102,6 @@ describe("Function: getUserGamesLibrary", () => {
     );
 
     // ASSERT
-    await expect(getUserGamesLibrary(mockAuthorization)).rejects.toThrow();
+    await expect(getUserPurchasedGames(mockAuthorization)).rejects.toThrow();
   });
 });
diff --git a/src/user/getUserGamesLibrary.ts → src/user/getUserPurchasedGames.ts b/src/user/getUserGamesLibrary.ts → src/user/getUserPurchasedGames.ts
@@ -1,11 +1,11 @@
 // import { AuthorizationPayload, ProfileFromUserNameResponse } from "../models";
 
 import { AuthorizationPayload } from "../models";
-import { GamesLibraryForUserResponse } from "../models/games-library-for-user.model";
+import { GetUserPurchasedGamesResponse } from "../models/user-purchased-games-response.model";
 import { call } from "../utils/call";
 import { USER_GAMES_BASE_URL } from "./USER_GAMES_BASE_URL";
 
-export type GetUserGamesLibraryOptions = {
+export type GetUserPurchasedGamesOptions = {
   platform?: Array<"ps4" | "ps5">;
   size?: number;
   start?: number;
@@ -15,7 +15,7 @@ export type GetUserGamesLibraryOptions = {
   subscriptionService?: string;
 };
 
-const defaultOptions: GetUserGamesLibraryOptions = {
+const defaultOptions: GetUserPurchasedGamesOptions = {
   platform: ["ps4", "ps5"],
   size: 500,
   start: 0,
@@ -39,9 +39,9 @@ const defaultOptions: GetUserGamesLibraryOptions = {
  * @param options.isActive Whether to return active games only. Defaults to `true`.
  * @param options.subscriptionService The subscription service to filter by. Defaults to `"NONE"`.
  */
-export const getUserGamesLibrary = async (
+export const getUserPurchasedGames = async (
   authorization: AuthorizationPayload,
-  options: Partial<GetUserGamesLibraryOptions> = defaultOptions
+  options: Partial<GetUserPurchasedGamesOptions> = defaultOptions
 ): Promise<any> => {
   const operationName = "getPurchasedGameList";
   const variables = encodeURIComponent(JSON.stringify(options));
@@ -50,7 +50,7 @@ export const getUserGamesLibrary = async (
   );
   const url = `${USER_GAMES_BASE_URL}?operationName=${operationName}&variables=${variables}&extensions=${extensions}`;
 
-  const response = await call<GamesLibraryForUserResponse>(
+  const response = await call<GetUserPurchasedGamesResponse>(
     { url },
     authorization
   );