feat(getGameInfoAndUserProgress): add new query param for highest awa…

…rd metadata

src/user/getGameInfoAndUserProgress.ts

@@ -27,6 +27,9 @@ import type {
  * @param payload.userName The user for which to retrieve the
  * game progress for.
  *
+ * @param payload.shouldIncludeHighestAwardMetadata Include a "HighestAwardKind"
+ * and a "HighestAwardDate" for the given user and game ID.
+ *
  * @example
  * ```
  * const gameInfoAndUserProgress = await getGameInfoAndUserProgress(
@@ -87,18 +90,27 @@ import type {
  */
 export const getGameInfoAndUserProgress = async (
  authorization: AuthObject,
- payload: { gameId: ID; userName: string }
+ payload: {
+ gameId: ID;
+ userName: string;
+ shouldIncludeHighestAwardMetadata?: boolean;
+ }
 ): Promise<GameInfoAndUserProgress> => {
- const { gameId, userName } = payload;
+ const { gameId, userName, shouldIncludeHighestAwardMetadata } = payload;
+
+ const params: Record<string, any> = {
+ g: gameId,
+ u: userName,
+ };
+ if (shouldIncludeHighestAwardMetadata) {
+ params.a = 1;
+ }
 
  const url = buildRequestUrl(
  apiBaseUrl,
  "/API_GetGameInfoAndUserProgress.php",
  authorization,
- {
- g: gameId,
- u: userName,
- }
+ params
  );
 
  const rawResponse = await call<GetGameInfoAndUserProgressResponse>({ url });

src/user/models/game-info-and-user-progress.model.ts

@@ -16,4 +16,12 @@ export interface GameInfoAndUserProgress extends GameExtended {
  numAwardedToUserHardcore: number;
  userCompletion: string;
  userCompletionHardcore: string;
+
+ highestAwardKind?:
+ | "mastered"
+ | "completed"
+ | "beaten-hardcore"
+ | "beaten-softcore"
+ | null;
+ highestAwardDate?: string;
 }

src/user/models/get-game-info-and-user-progress-response.model.ts

@@ -25,4 +25,12 @@ export interface GetGameInfoAndUserProgressResponse
  NumAwardedToUserHardcore: number;
  UserCompletion: string;
  UserCompletionHardcore: string;
+
+ HighestAwardKind?:
+ | "mastered"
+ | "completed"
+ | "beaten-hardcore"
+ | "beaten-softcore"
+ | null;
+ HighestAwardDate?: string;
 }