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

A well-tested library that lets you get achievement, user, and game data from RetroAchievements.

import type {
  GameExtended,
  GameExtendedAchievementEntity,
} from "../../game/models";
import type { AwardKind } from "../../utils/public";

export type GameExtendedAchievementEntityWithUserProgress =
  GameExtendedAchievementEntity & {
    dateEarned: string;
    dateEarnedHardcore: string;
  };

export interface GameInfoAndUserProgress extends GameExtended {
  achievements: Record<number, GameExtendedAchievementEntityWithUserProgress>;

  numAwardedToUser: number;
  numAwardedToUserHardcore: number;
  userCompletion: string;
  userCompletionHardcore: string;

  highestAwardKind?: AwardKind | null;
  highestAwardDate?: string;
}