@retroachievements/api 1.2.1 → 1.4.0

package/dist/user/models/index.d.ts

@@ -1,23 +1,28 @@
-export * from "./award-type.model";
-export * from "./dated-user-achievement.model";
-export * from "./dated-user-achievements-response.model";
-export * from "./game-info-and-user-progress.model";
-export * from "./get-game-info-and-user-progress-response.model";
-export * from "./get-user-awards-response.model";
-export * from "./get-user-completed-games-response.model";
-export * from "./get-user-game-rank-and-score-response.model";
-export * from "./get-user-points-response.model";
-export * from "./get-user-progress-response.model";
-export * from "./get-user-recent-achievements-response.model";
-export * from "./get-user-recently-played-games-response.model";
-export * from "./get-user-summary-response.model";
-export * from "./user-awards.model";
-export * from "./user-claims.model";
-export * from "./user-claims-response.model";
-export * from "./user-completed-games.model";
-export * from "./user-game-rank-and-score.model";
-export * from "./user-points.model";
-export * from "./user-progress.model";
-export * from "./user-recent-achievement.model";
-export * from "./user-recently-played-games.model";
-export * from "./user-summary.model";
+export * from "./award-type.model";
+export * from "./dated-user-achievement.model";
+export * from "./dated-user-achievements-response.model";
+export * from "./game-info-and-user-progress.model";
+export * from "./get-game-info-and-user-progress-response.model";
+export * from "./get-user-awards-response.model";
+export * from "./get-user-completed-games-response.model";
+export * from "./get-user-completion-progress-response.model";
+export * from "./get-user-game-rank-and-score-response.model";
+export * from "./get-user-points-response.model";
+export * from "./get-user-profile-response.model";
+export * from "./get-user-progress-response.model";
+export * from "./get-user-recent-achievements-response.model";
+export * from "./get-user-recently-played-games-response.model";
+export * from "./get-user-summary-response.model";
+export * from "./user-awards.model";
+export * from "./user-claims.model";
+export * from "./user-claims-response.model";
+export * from "./user-completed-games.model";
+export * from "./user-completion-progress.model";
+export * from "./user-completion-progress-entity.model";
+export * from "./user-game-rank-and-score.model";
+export * from "./user-points.model";
+export * from "./user-profile.model";
+export * from "./user-progress.model";
+export * from "./user-recent-achievement.model";
+export * from "./user-recently-played-games.model";
+export * from "./user-summary.model";

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

@@ -1,22 +1,24 @@
-import type { AwardType } from "./award-type.model";
-interface UserAward {
-    awardedAt: string;
-    awardType: AwardType;
-    awardData: number;
-    awardDataExtra: number;
-    displayOrder: number;
-    title: string;
-    consoleName: string;
-    flags: number | null;
-    imageIcon: string;
-}
-export interface UserAwards {
-    totalAwardsCount: number;
-    hiddenAwardsCount: number;
-    masteryAwardsCount: number;
-    completionAwardsCount: number;
-    eventAwardsCount: number;
-    siteAwardsCount: number;
-    visibleUserAwards: UserAward[];
-}
-export {};
+import type { AwardType } from "./award-type.model";
+interface UserAward {
+    awardedAt: string;
+    awardType: AwardType;
+    awardData: number;
+    awardDataExtra: number;
+    displayOrder: number;
+    title: string;
+    consoleName: string;
+    flags: number | null;
+    imageIcon: string;
+}
+export interface UserAwards {
+    totalAwardsCount: number;
+    hiddenAwardsCount: number;
+    masteryAwardsCount: number;
+    completionAwardsCount: number;
+    beatenHardcoreAwardsCount: number;
+    beatenSoftcoreAwardsCount: number;
+    eventAwardsCount: number;
+    siteAwardsCount: number;
+    visibleUserAwards: UserAward[];
+}
+export {};

package/dist/user/models/user-claims-response.model.d.ts

@@ -1,19 +1,19 @@
-interface UserClaimsResponseEntity {
-    ID: string;
-    User: string;
-    GameID: string;
-    GameTitle: string;
-    GameIcon: string;
-    ConsoleName: string;
-    ClaimType: string;
-    SetType: string;
-    Status: string;
-    Extension: string;
-    Special: string;
-    Created: string;
-    DoneTime: string;
-    Updated: string;
-    MinutesLeft: string;
-}
-export type GetUserClaimsResponse = UserClaimsResponseEntity[];
-export {};
+interface UserClaimsResponseEntity {
+    ID: string;
+    User: string;
+    GameID: string;
+    GameTitle: string;
+    GameIcon: string;
+    ConsoleName: string;
+    ClaimType: string;
+    SetType: string;
+    Status: string;
+    Extension: string;
+    Special: string;
+    Created: string;
+    DoneTime: string;
+    Updated: string;
+    MinutesLeft: string;
+}
+export type GetUserClaimsResponse = UserClaimsResponseEntity[];
+export {};

package/dist/user/models/user-claims.model.d.ts

@@ -1,19 +1,19 @@
-interface UserClaim {
-    id: number;
-    user: string;
-    gameId: number;
-    gameTitle: string;
-    gameIcon: string;
-    consoleName: string;
-    claimType: number;
-    setType: number;
-    status: number;
-    extension: number;
-    special: number;
-    created: string;
-    doneTime: string;
-    updated: string;
-    minutesLeft: number;
-}
-export type UserClaims = UserClaim[];
-export {};
+interface UserClaim {
+    id: number;
+    user: string;
+    gameId: number;
+    gameTitle: string;
+    gameIcon: string;
+    consoleName: string;
+    claimType: number;
+    setType: number;
+    status: number;
+    extension: number;
+    special: number;
+    created: string;
+    doneTime: string;
+    updated: string;
+    minutesLeft: number;
+}
+export type UserClaims = UserClaim[];
+export {};

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

@@ -1,12 +1,12 @@
-export interface UserCompletedGame {
-    gameId: number;
-    title: string;
-    imageIcon: string;
-    consoleId: number;
-    consoleName: string;
-    maxPossible: number;
-    numAwarded: number;
-    pctWon: number;
-    hardcoreMode: boolean;
-}
-export type UserCompletedGames = UserCompletedGame[];
+export interface UserCompletedGame {
+    gameId: number;
+    title: string;
+    imageIcon: string;
+    consoleId: number;
+    consoleName: string;
+    maxPossible: number;
+    numAwarded: number;
+    pctWon: number;
+    hardcoreMode: boolean;
+}
+export type UserCompletedGames = UserCompletedGame[];

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

@@ -0,0 +1,13 @@
+export interface UserCompletionProgressEntity {
+    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;
+}

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

@@ -0,0 +1,6 @@
+import type { UserCompletionProgressEntity } from "./user-completion-progress-entity.model";
+export interface UserCompletionProgress {
+    count: number;
+    total: number;
+    results: UserCompletionProgressEntity[];
+}

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

@@ -1,7 +1,7 @@
-export interface UserGameRankAndScoreEntity {
-    user: string;
-    totalScore: number;
-    lastAward: string;
-    userRank: number;
-}
-export type UserGameRankAndScore = UserGameRankAndScoreEntity[];
+export interface UserGameRankAndScoreEntity {
+    user: string;
+    totalScore: number;
+    lastAward: string;
+    userRank: number;
+}
+export type UserGameRankAndScore = UserGameRankAndScoreEntity[];

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

@@ -1,4 +1,4 @@
-export interface UserPoints {
-    points: number;
-    softcorePoints: number;
-}
+export interface UserPoints {
+    points: number;
+    softcorePoints: number;
+}

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

@@ -0,0 +1,17 @@
+export interface UserProfile {
+    user: string;
+    userPic: string;
+    memberSince: string;
+    richPresenceMsg: string;
+    lastGameId: number;
+    contribCount: number;
+    contribYield: number;
+    totalPoints: number;
+    totalSoftcorePoints: number;
+    totalTruePoints: number;
+    permissions: number;
+    untracked: boolean;
+    id: number;
+    userWallActive: boolean;
+    motto: string;
+}

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

@@ -1,9 +1,9 @@
-export interface UserProgressEntity {
-    numPossibleAchievements: number;
-    possibleScore: number;
-    numAchieved: number;
-    scoreAchieved: number;
-    numAchievedHardcore: number;
-    scoreAchievedHardcore: number;
-}
-export type UserProgress = Record<`${number}`, UserProgressEntity>;
+export interface UserProgressEntity {
+    numPossibleAchievements: number;
+    possibleScore: number;
+    numAchieved: number;
+    scoreAchieved: number;
+    numAchievedHardcore: number;
+    scoreAchievedHardcore: number;
+}
+export type UserProgress = Record<`${number}`, UserProgressEntity>;

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

@@ -1,16 +1,16 @@
-export interface UserRecentAchievement {
-    date: string;
-    hardcoreMode: boolean;
-    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 interface UserRecentAchievement {
+    date: string;
+    hardcoreMode: boolean;
+    achievementId: number;
+    title: string;
+    description: string;
+    badgeName: string;
+    points: number;
+    author: string;
+    gameTitle: string;
+    gameIcon: string;
+    gameId: number;
+    consoleName: string;
+    badgeUrl: string;
+    gameUrl: string;
+}

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

@@ -1,16 +1,16 @@
-export interface UserRecentlyPlayedGameEntity {
-    gameId: number;
-    consoleId: number;
-    consoleName: string;
-    title: string;
-    imageIcon: string;
-    lastPlayed: string;
-    myVote: 1 | 2 | 3 | 4 | 5 | null;
-    numPossibleAchievements: number;
-    possibleScore: number;
-    numAchieved: number;
-    scoreAchieved: number;
-    numAchievedHardcore: number;
-    scoreAchievedHardcore: number;
-}
-export type UserRecentlyPlayedGames = UserRecentlyPlayedGameEntity[];
+export interface UserRecentlyPlayedGameEntity {
+    gameId: number;
+    consoleId: number;
+    consoleName: string;
+    title: string;
+    imageIcon: string;
+    lastPlayed: string;
+    myVote: 1 | 2 | 3 | 4 | 5 | null;
+    numPossibleAchievements: number;
+    possibleScore: number;
+    numAchieved: number;
+    scoreAchieved: number;
+    numAchievedHardcore: number;
+    scoreAchievedHardcore: number;
+}
+export type UserRecentlyPlayedGames = UserRecentlyPlayedGameEntity[];

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

@@ -1,82 +1,82 @@
-export interface RecentlyPlayedGameEntity {
-    gameId: number;
-    consoleId: number;
-    consoleName: string;
-    title: string;
-    imageIcon: string;
-    lastPlayed: string;
-}
-export interface LastActivityEntity {
-    id: number;
-    timestamp: string;
-    lastupdate: string;
-    activitytype: number;
-    user: string;
-    data: string;
-    data2: string;
-}
-export 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 AwardedGameEntity {
-    numPossibleAchievements: number;
-    possibleScore: number;
-    numAchieved: number;
-    scoreAchieved: number;
-    numAchievedHardcore: number;
-    scoreAchievedHardcore: number;
-}
-export interface ExtendedRecentAchievementEntity {
-    id: number;
-    gameId: number;
-    gameTitle: string;
-    title: string;
-    description: string;
-    points: number;
-    badgeName: string;
-    isAwarded: true;
-    dateAwarded: string;
-    hardcoreAchieved: false;
-}
-export interface UserSummary {
-    recentlyPlayedCount: number;
-    recentlyPlayed: RecentlyPlayedGameEntity[];
-    memberSince: string;
-    lastActivity: LastActivityEntity;
-    richPresenceMsg: string;
-    lastGameId: number;
-    lastGame: LastGameEntity;
-    contribCount: number;
-    contribYield: number;
-    totalPoints: number;
-    totalSoftcorePoints: number;
-    totalTruePoints: number;
-    permissions: number;
-    untracked: boolean;
-    id: number;
-    userWallActive: boolean;
-    motto: string;
-    rank: number;
-    awarded: Record<`${number}`, AwardedGameEntity>;
-    recentAchievements: Record<`${number}`, Record<`${number}`, ExtendedRecentAchievementEntity>>;
-    points: number;
-    softcorePoints: number;
-    userPic: string;
-    totalRanked: number;
-    status: string;
-}
+export interface RecentlyPlayedGameEntity {
+    gameId: number;
+    consoleId: number;
+    consoleName: string;
+    title: string;
+    imageIcon: string;
+    lastPlayed: string;
+}
+export interface LastActivityEntity {
+    id: number;
+    timestamp: string;
+    lastupdate: string;
+    activitytype: number;
+    user: string;
+    data: string;
+    data2: string;
+}
+export 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 AwardedGameEntity {
+    numPossibleAchievements: number;
+    possibleScore: number;
+    numAchieved: number;
+    scoreAchieved: number;
+    numAchievedHardcore: number;
+    scoreAchievedHardcore: number;
+}
+export interface ExtendedRecentAchievementEntity {
+    id: number;
+    gameId: number;
+    gameTitle: string;
+    title: string;
+    description: string;
+    points: number;
+    badgeName: string;
+    isAwarded: true;
+    dateAwarded: string;
+    hardcoreAchieved: false;
+}
+export interface UserSummary {
+    recentlyPlayedCount: number;
+    recentlyPlayed: RecentlyPlayedGameEntity[];
+    memberSince: string;
+    lastActivity: LastActivityEntity;
+    richPresenceMsg: string;
+    lastGameId: number;
+    lastGame: LastGameEntity;
+    contribCount: number;
+    contribYield: number;
+    totalPoints: number;
+    totalSoftcorePoints: number;
+    totalTruePoints: number;
+    permissions: number;
+    untracked: boolean;
+    id: number;
+    userWallActive: boolean;
+    motto: string;
+    rank: number;
+    awarded: Record<`${number}`, AwardedGameEntity>;
+    recentAchievements: Record<`${number}`, Record<`${number}`, ExtendedRecentAchievementEntity>>;
+    points: number;
+    softcorePoints: number;
+    userPic: string;
+    totalRanked: number;
+    status: string;
+}

package/dist/utils/internal/apiBaseUrl.d.ts

@@ -1 +1 @@
-export declare const apiBaseUrl = "https://retroachievements.org/API";
+export declare const apiBaseUrl = "https://retroachievements.org/API";

package/dist/utils/internal/buildRequestUrl.d.ts

@@ -1,2 +1,2 @@
-import type { AuthObject } from "../public/models";
-export declare const buildRequestUrl: (baseUrl: string, endpointUrl: string, authObject: AuthObject, args?: Record<string, string | number>) => string;
+import type { AuthObject } from "../public/models";
+export declare const buildRequestUrl: (baseUrl: string, endpointUrl: string, authObject: AuthObject, args?: Record<string, string | number>) => string;

package/dist/utils/internal/buildRequestUrl.test.d.ts

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

package/dist/utils/internal/call.d.ts

@@ -1,20 +1,11 @@
-/**
- * Fetch an HTTP resource. This is publicly exposed in the
- * event you would like to access an endpoint that this
- * library does not currently support.
- *
- * UNLESS YOU'RE SURE OF WHAT YOU'RE DOING, YOU PROBABLY
- * SHOULDN'T USE THIS FUNCTION.
- *
- * 2022-10-09: At the time of writing, Node.js LTS (16.x)
- * does not yet support fetch. As a result, we pull in
- * isomorphic-unfetch for Node.js compatibility. Our support
- * matrix includes 14.x and 16.x.
- *
- * @FIXME - When Node.js 20.x is released, remove the
- * isomorphic-unfetch dependency. At that point we will have
- * two major LTS versions that include a native fetch API.
- */
-export declare const call: <T extends readonly any[] | Record<string, any>>(config: {
-    url: string;
-}) => Promise<T>;
+/**
+ * Fetch an HTTP resource. This is publicly exposed in the
+ * event you would like to access an endpoint that this
+ * library does not currently support.
+ *
+ * UNLESS YOU'RE SURE OF WHAT YOU'RE DOING, YOU PROBABLY
+ * SHOULDN'T USE THIS FUNCTION.
+ */
+export declare const call: <T extends readonly any[] | Record<string, any>>(config: {
+    url: string;
+}) => Promise<T>;

package/dist/utils/internal/call.test.d.ts

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

package/dist/utils/internal/id.model.d.ts

@@ -1 +1 @@
-export type ID = string | number;
+export type ID = string | number;

package/dist/utils/internal/index.d.ts

@@ -1,5 +1,5 @@
-export * from "./apiBaseUrl";
-export * from "./buildRequestUrl";
-export * from "./call";
-export * from "./id.model";
-export * from "./serializeProperties";
+export * from "./apiBaseUrl";
+export * from "./buildRequestUrl";
+export * from "./call";
+export * from "./id.model";
+export * from "./serializeProperties";

package/dist/utils/internal/serializeProperties.d.ts

@@ -1,4 +1,4 @@
-export declare const serializeProperties: (originalData: any, options?: Partial<{
-    shouldCastToNumbers: string[];
-    shouldMapToBooleans: string[];
-}>) => any;
+export declare const serializeProperties: (originalData: any, options?: Partial<{
+    shouldCastToNumbers: string[];
+    shouldMapToBooleans: string[];
+}>) => any;

package/dist/utils/internal/serializeProperties.test.d.ts

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

package/dist/utils/public/buildAuthorization.d.ts

@@ -1,22 +1,22 @@
-import type { AuthObject } from "./models";
-/**
- * Accepts your RetroAchievements.org username and web API key. After
- * receiving these inputs, the function returns you a value that can be
- * used for the authentication parameter by any of the async calls in this
- * library.
- *
- * Your account's personal Web API Key can be found on the Settings page
- * of RetroAchievements.org. Do not use a Web API Key that is not associated
- * with your account.
- *
- * @returns An `AuthObject` that you can pass to any of the API call functions.
- *
- * @example
- * ```
- * const authorization = buildAuthorization({
- *   userName: "Scott",
- *   webApiKey: "LtjCwW16nJI7cqOyPIQtXk8v1cfF0tmO"
- * });
- * ```
- */
-export declare const buildAuthorization: (options: AuthObject) => AuthObject;
+import type { AuthObject } from "./models";
+/**
+ * Accepts your RetroAchievements.org username and web API key. After
+ * receiving these inputs, the function returns you a value that can be
+ * used for the authentication parameter by any of the async calls in this
+ * library.
+ *
+ * Your account's personal Web API Key can be found on the Settings page
+ * of RetroAchievements.org. Do not use a Web API Key that is not associated
+ * with your account.
+ *
+ * @returns An `AuthObject` that you can pass to any of the API call functions.
+ *
+ * @example
+ * ```
+ * const authorization = buildAuthorization({
+ *   userName: "Scott",
+ *   webApiKey: "LtjCwW16nJI7cqOyPIQtXk8v1cfF0tmO"
+ * });
+ * ```
+ */
+export declare const buildAuthorization: (options: AuthObject) => AuthObject;

package/dist/utils/public/buildAuthorization.test.d.ts

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