@retroachievements/api 1.2.1 → 1.4.0

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

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

package/dist/user/getUserSummary.d.ts

@@ -1,32 +1,32 @@
-import type { AuthObject } from "../utils/public";
-import type { UserSummary } from "./models";
-/**
- * A call to this function will retrieve summary information about
- * a given user, targeted by username.
- *
- * @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 summary for.
- *
- * @param payload.recentGamesCount Optional. The number of recent games to return.
- * This defaults to 5.
- *
- * @param payload.recentAchievementsCount Optional. The number of recent achievements
- * to return. This defaults to 5.
- *
- * @example
- * ```
- * const userSummary = await getUserSummary(
- *   authorization,
- *   { userName: "xelnia" }
- * );
- * ```
- *
- * @returns An object containing summary metadata about a target user.
- */
-export declare const getUserSummary: (authorization: AuthObject, payload: {
-    userName: string;
-    recentGamesCount?: number;
-    recentAchievementsCount?: number;
-}) => Promise<UserSummary>;
+import type { AuthObject } from "../utils/public";
+import type { UserSummary } from "./models";
+/**
+ * A call to this function will retrieve summary information about
+ * a given user, targeted by username.
+ *
+ * @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 summary for.
+ *
+ * @param payload.recentGamesCount Optional. The number of recent games to return.
+ * This defaults to 0.
+ *
+ * @param payload.recentAchievementsCount Optional. The number of recent achievements
+ * to return. This defaults to 5.
+ *
+ * @example
+ * ```
+ * const userSummary = await getUserSummary(
+ *   authorization,
+ *   { userName: "xelnia" }
+ * );
+ * ```
+ *
+ * @returns An object containing summary metadata about a target user.
+ */
+export declare const getUserSummary: (authorization: AuthObject, payload: {
+    userName: string;
+    recentGamesCount?: number;
+    recentAchievementsCount?: number;
+}) => Promise<UserSummary>;

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

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

package/dist/user/index.d.ts

@@ -1,13 +1,15 @@
-export * from "./getAchievementsEarnedBetween";
-export * from "./getAchievementsEarnedOnDay";
-export * from "./getGameInfoAndUserProgress";
-export * from "./getUserAwards";
-export * from "./getUserClaims";
-export * from "./getUserCompletedGames";
-export * from "./getUserGameRankAndScore";
-export * from "./getUserPoints";
-export * from "./getUserProgress";
-export * from "./getUserRecentAchievements";
-export * from "./getUserRecentlyPlayedGames";
-export * from "./getUserSummary";
-export * from "./models";
+export * from "./getAchievementsEarnedBetween";
+export * from "./getAchievementsEarnedOnDay";
+export * from "./getGameInfoAndUserProgress";
+export * from "./getUserAwards";
+export * from "./getUserClaims";
+export * from "./getUserCompletedGames";
+export * from "./getUserCompletionProgress";
+export * from "./getUserGameRankAndScore";
+export * from "./getUserPoints";
+export * from "./getUserProfile";
+export * from "./getUserProgress";
+export * from "./getUserRecentAchievements";
+export * from "./getUserRecentlyPlayedGames";
+export * from "./getUserSummary";
+export * from "./models";

package/dist/user/models/award-type.model.d.ts

@@ -1 +1 @@
-export type AwardType = "Mastery/Completion" | "Achievement Unlocks Yield" | "Achievement Points Yield" | "Patreon Supporter" | "Certified Legend" | "Invalid or deprecated award type";
+export type AwardType = "Achievement Points Yield" | "Achievement Unlocks Yield" | "Certified Legend" | "Game Beaten" | "Invalid or deprecated award type" | "Mastery/Completion" | "Patreon Supporter";

package/dist/user/models/dated-user-achievement.model.d.ts

@@ -1,17 +1,17 @@
-export type DatedUserAchievement = {
-    date: string;
-    hardcoreMode: boolean;
-    achievementId: number;
-    title: string;
-    description: string;
-    badgeName: string;
-    points: number;
-    author: string;
-    gameTitle: string;
-    gameIcon: string;
-    gameId: number;
-    consoleName: string;
-    cumulScore: number;
-    badgeUrl: string;
-    gameUrl: string;
-}[];
+export type DatedUserAchievement = {
+    date: string;
+    hardcoreMode: boolean;
+    achievementId: number;
+    title: string;
+    description: string;
+    badgeName: string;
+    points: number;
+    author: string;
+    gameTitle: string;
+    gameIcon: string;
+    gameId: number;
+    consoleName: string;
+    cumulScore: number;
+    badgeUrl: string;
+    gameUrl: string;
+}[];

package/dist/user/models/dated-user-achievements-response.model.d.ts

@@ -1,19 +1,19 @@
-interface DatedUserAchievementResponseEntity {
-    Date: string;
-    HardcoreMode: string;
-    AchievementID: string;
-    Title: string;
-    Description: string;
-    BadgeName: string;
-    Points: string;
-    Author: string;
-    GameTitle: string;
-    GameIcon: string;
-    GameID: string;
-    ConsoleName: string;
-    CumulScore: number;
-    BadgeURL: string;
-    GameURL: string;
-}
-export type DatedUserAchievementsResponse = DatedUserAchievementResponseEntity[];
-export {};
+interface DatedUserAchievementResponseEntity {
+    Date: string;
+    HardcoreMode: string;
+    AchievementID: string;
+    Title: string;
+    Description: string;
+    BadgeName: string;
+    Points: string;
+    Author: string;
+    GameTitle: string;
+    GameIcon: string;
+    GameID: string;
+    ConsoleName: string;
+    CumulScore: number;
+    BadgeURL: string;
+    GameURL: string;
+}
+export type DatedUserAchievementsResponse = DatedUserAchievementResponseEntity[];
+export {};

package/dist/user/models/game-info-and-user-progress.model.d.ts

@@ -1,12 +1,12 @@
-import type { GameExtended, GameExtendedAchievementEntity } from "../../game/models";
-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;
-}
+import type { GameExtended, GameExtendedAchievementEntity } from "../../game/models";
+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;
+}

package/dist/user/models/get-game-info-and-user-progress-response.model.d.ts

@@ -1,14 +1,14 @@
-import type { GameExtendedRawAchievementEntity, GetGameExtendedResponse } from "../../game/models";
-type GetGameExtendedResponseWithoutClaims = Omit<GetGameExtendedResponse, "Claims">;
-type GameExtendedRawAchievementEntityWithUserProgress = GameExtendedRawAchievementEntity & {
-    DateEarned: string;
-    DateEarnedHardcore: string;
-};
-export interface GetGameInfoAndUserProgressResponse extends GetGameExtendedResponseWithoutClaims {
-    Achievements: Record<number, GameExtendedRawAchievementEntityWithUserProgress>;
-    NumAwardedToUser: number;
-    NumAwardedToUserHardcore: number;
-    UserCompletion: string;
-    UserCompletionHardcore: string;
-}
-export {};
+import type { GameExtendedRawAchievementEntity, GetGameExtendedResponse } from "../../game/models";
+type GetGameExtendedResponseWithoutClaims = Omit<GetGameExtendedResponse, "Claims">;
+type GameExtendedRawAchievementEntityWithUserProgress = GameExtendedRawAchievementEntity & {
+    DateEarned: string;
+    DateEarnedHardcore: string;
+};
+export interface GetGameInfoAndUserProgressResponse extends GetGameExtendedResponseWithoutClaims {
+    Achievements: Record<number, GameExtendedRawAchievementEntityWithUserProgress>;
+    NumAwardedToUser: number;
+    NumAwardedToUserHardcore: number;
+    UserCompletion: string;
+    UserCompletionHardcore: string;
+}
+export {};

package/dist/user/models/get-user-awards-response.model.d.ts

@@ -1,22 +1,24 @@
-import type { AwardType } from "./award-type.model";
-interface GetUserAwardsEntity {
-    AwardedAt: string;
-    AwardType: AwardType;
-    AwardData: number;
-    AwardDataExtra: number;
-    DisplayOrder: number;
-    Title: string;
-    ConsoleName: string;
-    Flags: number | null;
-    ImageIcon: string;
-}
-export interface GetUserAwardsResponse {
-    TotalAwardsCount: number;
-    HiddenAwardsCount: number;
-    MasteryAwardsCount: number;
-    CompletionAwardsCount: number;
-    EventAwardsCount: number;
-    SiteAwardsCount: number;
-    VisibleUserAwards: GetUserAwardsEntity[];
-}
-export {};
+import type { AwardType } from "./award-type.model";
+interface GetUserAwardsEntity {
+    AwardedAt: string;
+    AwardType: AwardType;
+    AwardData: number;
+    AwardDataExtra: number;
+    DisplayOrder: number;
+    Title: string;
+    ConsoleName: string;
+    Flags: number | null;
+    ImageIcon: string;
+}
+export interface GetUserAwardsResponse {
+    TotalAwardsCount: number;
+    HiddenAwardsCount: number;
+    MasteryAwardsCount: number;
+    CompletionAwardsCount: number;
+    BeatenHardcoreAwardsCount: number;
+    BeatenSoftcoreAwardsCount: number;
+    EventAwardsCount: number;
+    SiteAwardsCount: number;
+    VisibleUserAwards: GetUserAwardsEntity[];
+}
+export {};

package/dist/user/models/get-user-completed-games-response.model.d.ts

@@ -1,13 +1,13 @@
-interface UserCompletedGamesResponseEntity {
-    GameID: string;
-    Title: string;
-    ImageIcon: string;
-    ConsoleID: string;
-    ConsoleName: string;
-    MaxPossible: string;
-    NumAwarded: string;
-    PctWon: string;
-    HardcoreMode: "0" | "1";
-}
-export type GetUserCompletedGamesResponse = UserCompletedGamesResponseEntity[];
-export {};
+interface UserCompletedGamesResponseEntity {
+    GameID: string;
+    Title: string;
+    ImageIcon: string;
+    ConsoleID: string;
+    ConsoleName: string;
+    MaxPossible: string;
+    NumAwarded: string;
+    PctWon: string;
+    HardcoreMode: "0" | "1";
+}
+export type GetUserCompletedGamesResponse = UserCompletedGamesResponseEntity[];
+export {};

package/dist/user/models/get-user-completion-progress-response.model.d.ts

@@ -0,0 +1,19 @@
+interface RawUserCompletionProgressEntity {
+    GameID: number;
+    Title: string;
+    ImageIcon: string;
+    ConsoleID: number;
+    ConsoleName: string;
+    MaxPossible: number;
+    NumAwarded: number;
+    NumAwardedHardcore: number;
+    MostRecentAwardedDate?: string;
+    HighestAwardKind?: "mastered" | "completed" | "beaten-hardcore" | "beaten-softcore" | null;
+    HighestAwardDate?: string | null;
+}
+export interface GetUserCompletionProgressResponse {
+    Count: number;
+    Total: number;
+    Results: RawUserCompletionProgressEntity[];
+}
+export {};

package/dist/user/models/get-user-game-rank-and-score-response.model.d.ts

@@ -1,8 +1,8 @@
-interface UserGameRankAndScoreResponseEntity {
-    User: string;
-    TotalScore: string;
-    LastAward: string;
-    UserRank: string;
-}
-export type GetUserGameRankAndScoreResponse = UserGameRankAndScoreResponseEntity[];
-export {};
+interface UserGameRankAndScoreResponseEntity {
+    User: string;
+    TotalScore: string;
+    LastAward: string;
+    UserRank: string;
+}
+export type GetUserGameRankAndScoreResponse = UserGameRankAndScoreResponseEntity[];
+export {};

package/dist/user/models/get-user-points-response.model.d.ts

@@ -1,4 +1,4 @@
-export interface GetUserPointsResponse {
-    Points: number;
-    SoftcorePoints: number;
-}
+export interface GetUserPointsResponse {
+    Points: number;
+    SoftcorePoints: number;
+}

package/dist/user/models/get-user-profile-response.model.d.ts

@@ -0,0 +1,17 @@
+export interface GetUserProfileResponse {
+    User: string;
+    UserPic: string;
+    MemberSince: string;
+    RichPresenceMsg: string;
+    LastGameID: number;
+    ContribCount: number;
+    ContribYield: number;
+    TotalPoints: number;
+    TotalSoftcorePoints: number;
+    TotalTruePoints: number;
+    Permissions: number;
+    Untracked: number;
+    ID: number;
+    UserWallActive: number;
+    Motto: string;
+}

package/dist/user/models/get-user-progress-response.model.d.ts

@@ -1,10 +1,10 @@
-interface UserProgressResponseEntity {
-    NumPossibleAchievements: string;
-    PossibleScore: string;
-    NumAchieved: number | string;
-    ScoreAchieved: number | string;
-    NumAchievedHardcore: number | string;
-    ScoreAchievedHardcore: number | string;
-}
-export type GetUserProgressResponse = Record<`${number}`, UserProgressResponseEntity>;
-export {};
+interface UserProgressResponseEntity {
+    NumPossibleAchievements: string;
+    PossibleScore: string;
+    NumAchieved: number | string;
+    ScoreAchieved: number | string;
+    NumAchievedHardcore: number | string;
+    ScoreAchievedHardcore: number | string;
+}
+export type GetUserProgressResponse = Record<`${number}`, UserProgressResponseEntity>;
+export {};

package/dist/user/models/get-user-recent-achievements-response.model.d.ts

@@ -1,18 +1,18 @@
-interface GetUserRecentAchievementsEntity {
-    Date: string;
-    HardcoreMode: 0 | 1;
-    AchievementID: number;
-    Title: string;
-    Description: string;
-    BadgeName: string;
-    Points: number;
-    Author: string;
-    GameTitle: string;
-    GameIcon: string;
-    GameID: number;
-    ConsoleName: string;
-    BadgeURL: string;
-    GameURL: string;
-}
-export type GetUserRecentAchievementsResponse = GetUserRecentAchievementsEntity[];
-export {};
+interface GetUserRecentAchievementsEntity {
+    Date: string;
+    HardcoreMode: 0 | 1;
+    AchievementID: number;
+    Title: string;
+    Description: string;
+    BadgeName: string;
+    Points: number;
+    Author: string;
+    GameTitle: string;
+    GameIcon: string;
+    GameID: number;
+    ConsoleName: string;
+    BadgeURL: string;
+    GameURL: string;
+}
+export type GetUserRecentAchievementsResponse = GetUserRecentAchievementsEntity[];
+export {};

package/dist/user/models/get-user-recently-played-games-response.model.d.ts

@@ -1,17 +1,17 @@
-interface UserRecentlyPlayedGameResponseEntity {
-    GameID: string;
-    ConsoleID: string;
-    ConsoleName: string;
-    Title: string;
-    ImageIcon: string;
-    LastPlayed: string;
-    MyVote: "1" | "2" | "3" | "4" | "5" | null;
-    NumPossibleAchievements: string;
-    PossibleScore: string;
-    NumAchieved: string | number;
-    ScoreAchieved: string | number;
-    NumAchievedHardcore: string | number;
-    ScoreAchievedHardcore: string | number;
-}
-export type GetUserRecentlyPlayedGamesResponse = UserRecentlyPlayedGameResponseEntity[];
-export {};
+interface UserRecentlyPlayedGameResponseEntity {
+    GameID: string;
+    ConsoleID: string;
+    ConsoleName: string;
+    Title: string;
+    ImageIcon: string;
+    LastPlayed: string;
+    MyVote: "1" | "2" | "3" | "4" | "5" | null;
+    NumPossibleAchievements: string;
+    PossibleScore: string;
+    NumAchieved: string | number;
+    ScoreAchieved: string | number;
+    NumAchievedHardcore: string | number;
+    ScoreAchievedHardcore: string | number;
+}
+export type GetUserRecentlyPlayedGamesResponse = UserRecentlyPlayedGameResponseEntity[];
+export {};

package/dist/user/models/get-user-summary-response.model.d.ts

@@ -1,82 +1,82 @@
-interface RecentlyPlayedGameEntity {
-    GameID: string;
-    ConsoleID: string;
-    ConsoleName: string;
-    Title: string;
-    ImageIcon: string;
-    LastPlayed: string;
-}
-interface RecentlyAwardedAchievementEntity {
-    NumPossibleAchievements: string;
-    PossibleScore: string;
-    NumAchieved: number | string;
-    ScoreAchieved: number | string;
-    NumAchievedHardcore: number | string;
-    ScoreAchievedHardcore: number | string;
-}
-interface ExtendedRecentAchievementEntity {
-    ID: string;
-    GameID: string;
-    GameTitle: string;
-    Title: string;
-    Description: string;
-    Points: string;
-    BadgeName: string;
-    IsAwarded: "1";
-    DateAwarded: string;
-    HardcoreAchieved: "0";
-}
-interface LastGameEntity {
-    ID: number;
-    Title: string;
-    ConsoleID: number;
-    ForumTopicID: number;
-    Flags: number;
-    ImageIcon: string;
-    ImageTitle: string;
-    ImageIngame: string;
-    ImageBoxArt: string;
-    Publisher: string;
-    Developer: string;
-    Genre: string;
-    Released: string;
-    IsFinal: boolean;
-    ConsoleName: string;
-    RichPresencePatch: string;
-}
-export interface GetUserSummaryResponse {
-    RecentlyPlayedCount: number;
-    RecentlyPlayed: RecentlyPlayedGameEntity[];
-    MemberSince: string;
-    LastActivity: {
-        ID: string;
-        timestamp: string;
-        lastupdate: string;
-        activitytype: string;
-        User: string;
-        data: string;
-        data2: string;
-    };
-    RichPresenceMsg: string;
-    LastGameID: string;
-    LastGame: LastGameEntity;
-    ContribCount: string;
-    ContribYield: string;
-    TotalPoints: string;
-    TotalSoftcorePoints: string;
-    TotalTruePoints: string;
-    Permissions: string;
-    Untracked: "0" | "1";
-    ID: string;
-    UserWallActive: "0" | "1";
-    Motto: string;
-    Rank: number;
-    Awarded: Record<`${number}`, RecentlyAwardedAchievementEntity>;
-    RecentAchievements: Record<`${number}`, Record<`${number}`, ExtendedRecentAchievementEntity>>;
-    Points: string;
-    SoftcorePoints: string;
-    UserPic: string;
-    TotalRanked: number;
-    Status: string;
-}
-export {};
+interface RecentlyPlayedGameEntity {
+    GameID: string;
+    ConsoleID: string;
+    ConsoleName: string;
+    Title: string;
+    ImageIcon: string;
+    LastPlayed: string;
+}
+interface RecentlyAwardedAchievementEntity {
+    NumPossibleAchievements: string;
+    PossibleScore: string;
+    NumAchieved: number | string;
+    ScoreAchieved: number | string;
+    NumAchievedHardcore: number | string;
+    ScoreAchievedHardcore: number | string;
+}
+interface ExtendedRecentAchievementEntity {
+    ID: string;
+    GameID: string;
+    GameTitle: string;
+    Title: string;
+    Description: string;
+    Points: string;
+    BadgeName: string;
+    IsAwarded: "1";
+    DateAwarded: string;
+    HardcoreAchieved: "0";
+}
+interface LastGameEntity {
+    ID: number;
+    Title: string;
+    ConsoleID: number;
+    ForumTopicID: number;
+    Flags: number;
+    ImageIcon: string;
+    ImageTitle: string;
+    ImageIngame: string;
+    ImageBoxArt: string;
+    Publisher: string;
+    Developer: string;
+    Genre: string;
+    Released: string;
+    IsFinal: boolean;
+    ConsoleName: string;
+    RichPresencePatch: string;
+}
+export interface GetUserSummaryResponse {
+    RecentlyPlayedCount: number;
+    RecentlyPlayed: RecentlyPlayedGameEntity[];
+    MemberSince: string;
+    LastActivity: {
+        ID: string;
+        timestamp: string;
+        lastupdate: string;
+        activitytype: string;
+        User: string;
+        data: string;
+        data2: string;
+    };
+    RichPresenceMsg: string;
+    LastGameID: string;
+    LastGame: LastGameEntity;
+    ContribCount: string;
+    ContribYield: string;
+    TotalPoints: string;
+    TotalSoftcorePoints: string;
+    TotalTruePoints: string;
+    Permissions: string;
+    Untracked: "0" | "1";
+    ID: string;
+    UserWallActive: "0" | "1";
+    Motto: string;
+    Rank: number;
+    Awarded: Record<`${number}`, RecentlyAwardedAchievementEntity>;
+    RecentAchievements: Record<`${number}`, Record<`${number}`, ExtendedRecentAchievementEntity>>;
+    Points: string;
+    SoftcorePoints: string;
+    UserPic: string;
+    TotalRanked: number;
+    Status: string;
+}
+export {};