@retroachievements/api 1.2.1 → 1.4.0

package/dist/user/getUserCompletedGames.d.ts

@@ -1,56 +1,56 @@
-import type { AuthObject } from "../utils/public";
-import type { UserCompletedGames } from "./models";
-/**
- * A call to this function will retrieve completion metadata
- * about the games a given user has played. It returns two
- * entries per each game: one for the softcore completion and
- * one for the hardcore completion. These are designated by
- * the `hardcoreMode` property on each completion object.
- *
- * @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
- * completion metadata for.
- *
- * @example
- * ```
- * const userCompletedGames = await getUserCompletedGames(
- *   authorization,
- *   { userName: "xelnia" }
- * );
- * ```
- *
- * @returns An array containing completion metadata objects
- * for a given user. Each game contains two completion records,
- * one for softcore and another for hardcore.
- * ```json
- * [
- *   {
- *     gameId: 14976,
- *     title: 'Mortal Kombat',
- *     imageIcon: '/Images/036812.png',
- *     consoleId: 27,
- *     consoleName: 'Arcade',
- *     maxPossible: 35,
- *     numAwarded: 13,
- *     pctWon: 0.3714,
- *     hardcoreMode: false
- *   },
- *   {
- *     gameId: 14976,
- *     title: 'Mortal Kombat',
- *     imageIcon: '/Images/036812.png',
- *     consoleId: 27,
- *     consoleName: 'Arcade',
- *     maxPossible: 35,
- *     numAwarded: 13,
- *     pctWon: 0.3714,
- *     hardcoreMode: true
- *   },
- * ]
- * ```
- */
-export declare const getUserCompletedGames: (authorization: AuthObject, payload: {
-    userName: string;
-}) => Promise<UserCompletedGames>;
+import type { AuthObject } from "../utils/public";
+import type { UserCompletedGames } from "./models";
+/**
+ * A call to this function will retrieve completion metadata
+ * about the games a given user has played. It returns two
+ * entries per each game: one for the softcore completion and
+ * one for the hardcore completion. These are designated by
+ * the `hardcoreMode` property on each completion object.
+ *
+ * @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
+ * completion metadata for.
+ *
+ * @example
+ * ```
+ * const userCompletedGames = await getUserCompletedGames(
+ *   authorization,
+ *   { userName: "xelnia" }
+ * );
+ * ```
+ *
+ * @returns An array containing completion metadata objects
+ * for a given user. Each game contains two completion records,
+ * one for softcore and another for hardcore.
+ * ```json
+ * [
+ *   {
+ *     gameId: 14976,
+ *     title: 'Mortal Kombat',
+ *     imageIcon: '/Images/036812.png',
+ *     consoleId: 27,
+ *     consoleName: 'Arcade',
+ *     maxPossible: 35,
+ *     numAwarded: 13,
+ *     pctWon: 0.3714,
+ *     hardcoreMode: false
+ *   },
+ *   {
+ *     gameId: 14976,
+ *     title: 'Mortal Kombat',
+ *     imageIcon: '/Images/036812.png',
+ *     consoleId: 27,
+ *     consoleName: 'Arcade',
+ *     maxPossible: 35,
+ *     numAwarded: 13,
+ *     pctWon: 0.3714,
+ *     hardcoreMode: true
+ *   },
+ * ]
+ * ```
+ */
+export declare const getUserCompletedGames: (authorization: AuthObject, payload: {
+    userName: string;
+}) => Promise<UserCompletedGames>;

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

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

package/dist/user/getUserCompletionProgress.d.ts

@@ -0,0 +1,51 @@
+import type { AuthObject } from "../utils/public";
+import type { UserCompletionProgress } from "./models";
+/**
+ * A call to this function will retrieve a given user's completion
+ * progress, targeted by their 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 progress for.
+ *
+ * @param payload.offset Defaults to 0. The number of entries to skip.
+ *
+ * @param payload.count Defaults to 100, has a max of 500.
+ *
+ * @example
+ * ```
+ * const userCompletionProgress = await getUserCompletionProgress(
+ *   authorization,
+ *   { userName: "xelnia" }
+ * );
+ * ```
+ *
+ * @returns
+ * ```
+ * {
+ *   "count": 100,
+ *   "total": 752,
+ *   "results": [
+ *     {
+         gameId: 11406,
+         title: 'Mortal Kombat 4',
+         imageIcon: '/Images/042133.png',
+         consoleId: 12,
+         consoleName: 'PlayStation',
+         maxPossible: 131,
+         numAwarded: 131,
+         numAwardedHardcore: 131,
+         mostRecentAwardedDate: '2022-08-07T18:24:44+00:00',
+         highestAwardKind: 'mastered',
+         highestAwardDate: '2022-08-07T18:24:44+00:00'
+ *     }
+ *   ]
+ * }
+ * ```
+ */
+export declare const getUserCompletionProgress: (authorization: AuthObject, payload: {
+    userName: string;
+    offset?: number;
+    count?: number;
+}) => Promise<UserCompletionProgress>;

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

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

package/dist/user/getUserGameRankAndScore.d.ts

@@ -1,45 +1,45 @@
-import type { ID } from "../utils/internal";
-import type { AuthObject } from "../utils/public";
-import type { UserGameRankAndScore } from "./models";
-/**
- * A call to this function will retrieve metadata about
- * how a particular user has performed/ranked on a particular
- * game, targeted by game ID.
- *
- * @param authorization An object containing your userName and webApiKey.
- * This can be constructed with `buildAuthorization()`.
- *
- * @param payload.gameId The unique game ID. If you are unsure, open the
- * game's page on the RetroAchievements.org website. For example, Dragster's
- * URL is https://retroachievements.org/game/14402. We can see from the
- * URL that the game ID is "14402".
- *
- * @param payload.userName The user for which to retrieve the
- * game ranking metadata for.
- *
- * @example
- * ```
- * const userGameRankAndScore = await getUserGameRankAndScore(
- *   authorization,
- *   { gameId: 14402, userName: "xelnia" }
- * );
- * ```
- *
- * @returns An array containing metadata about the user's
- * rank and score for the target game ID. If metadata
- * cannot be found, the array is empty.
- * ```json
- * [
- *   {
- *     user: "xelnia",
- *     totalScore: 378,
- *     lastAward: "2022-09-01 21:51:23",
- *     userRank: 3
- *   }
- * ]
- * ```
- */
-export declare const getUserGameRankAndScore: (authorization: AuthObject, payload: {
-    gameId: ID;
-    userName: string;
-}) => Promise<UserGameRankAndScore>;
+import type { ID } from "../utils/internal";
+import type { AuthObject } from "../utils/public";
+import type { UserGameRankAndScore } from "./models";
+/**
+ * A call to this function will retrieve metadata about
+ * how a particular user has performed/ranked on a particular
+ * game, targeted by game ID.
+ *
+ * @param authorization An object containing your userName and webApiKey.
+ * This can be constructed with `buildAuthorization()`.
+ *
+ * @param payload.gameId The unique game ID. If you are unsure, open the
+ * game's page on the RetroAchievements.org website. For example, Dragster's
+ * URL is https://retroachievements.org/game/14402. We can see from the
+ * URL that the game ID is "14402".
+ *
+ * @param payload.userName The user for which to retrieve the
+ * game ranking metadata for.
+ *
+ * @example
+ * ```
+ * const userGameRankAndScore = await getUserGameRankAndScore(
+ *   authorization,
+ *   { gameId: 14402, userName: "xelnia" }
+ * );
+ * ```
+ *
+ * @returns An array containing metadata about the user's
+ * rank and score for the target game ID. If metadata
+ * cannot be found, the array is empty.
+ * ```json
+ * [
+ *   {
+ *     user: "xelnia",
+ *     totalScore: 378,
+ *     lastAward: "2022-09-01 21:51:23",
+ *     userRank: 3
+ *   }
+ * ]
+ * ```
+ */
+export declare const getUserGameRankAndScore: (authorization: AuthObject, payload: {
+    gameId: ID;
+    userName: string;
+}) => Promise<UserGameRankAndScore>;

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

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

package/dist/user/getUserPoints.d.ts

@@ -1,30 +1,30 @@
-import type { AuthObject } from "../utils/public";
-import type { UserPoints } from "./models";
-/**
- * A call to this function will retrieve a given user's hardcore
- * and softcore points.
- *
- * @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 point totals for.
- *
- * @example
- * ```
- * const userPoints = await getUserPoints(
- *   authorization,
- *   { userName: "xelnia" }
- * );
- * ```
- *
- * @returns An object containing metadata about a target user's points.
- * ```json
- * {
- *   points: 7640,
- *   softcorePoints: 25
- * }
- * ```
- */
-export declare const getUserPoints: (authorization: AuthObject, payload: {
-    userName: string;
-}) => Promise<UserPoints>;
+import type { AuthObject } from "../utils/public";
+import type { UserPoints } from "./models";
+/**
+ * A call to this function will retrieve a given user's hardcore
+ * and softcore points.
+ *
+ * @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 point totals for.
+ *
+ * @example
+ * ```
+ * const userPoints = await getUserPoints(
+ *   authorization,
+ *   { userName: "xelnia" }
+ * );
+ * ```
+ *
+ * @returns An object containing metadata about a target user's points.
+ * ```json
+ * {
+ *   points: 7640,
+ *   softcorePoints: 25
+ * }
+ * ```
+ */
+export declare const getUserPoints: (authorization: AuthObject, payload: {
+    userName: string;
+}) => Promise<UserPoints>;

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

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

package/dist/user/getUserProfile.d.ts

@@ -0,0 +1,24 @@
+import type { AuthObject } from "../utils/public";
+import type { UserProfile } 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.
+ *
+ * @example
+ * ```
+ * const userSummary = await getUserProfile(
+ *   authorization,
+ *   { userName: "xelnia" }
+ * );
+ * ```
+ *
+ * @returns An object containing profile summary metadata about a target user.
+ */
+export declare const getUserProfile: (authorization: AuthObject, payload: {
+    userName: string;
+}) => Promise<UserProfile>;

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

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

package/dist/user/getUserProgress.d.ts

@@ -1,50 +1,50 @@
-import type { ID } from "../utils/internal";
-import type { AuthObject } from "../utils/public";
-import type { UserProgress } from "./models";
-/**
- * A call to this function will retrieve a given user's
- * progress on a given list of games, targeted by game ID.
- *
- * @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 progress for.
- *
- * @param payload.gameIds An array of RetroAchievements game IDs. If you aren't
- * sure of the game ID, visit the game's page on the website and copy the number
- * at the end of the URL.
- *
- * @example
- * ```
- * const userProgress = await getUserProgress(
- *   authorization,
- *   { userName: "xelnia", gameIds: [1, 14402] }
- * );
- * ```
- *
- * @returns An object which is a map of summarized progress for games.
- * ```json
- * {
- *   "1": {
- *     numPossibleAchievements: 24,
- *     possibleScore: 255,
- *     numAchieved: 0,
- *     scoreAchieved: 0,
- *     numAchievedHardcore: 0,
- *     scoreAchievedHardcore: 0
- *   },
- *   "14402": {
- *     numPossibleAchievements: 24,
- *     possibleScore: 255,
- *     numAchieved: 0,
- *     scoreAchieved: 0,
- *     numAchievedHardcore: 0,
- *     scoreAchievedHardcore: 0
- *   }
- * }
- * ```
- */
-export declare const getUserProgress: (authorization: AuthObject, payload: {
-    userName: string;
-    gameIds: ID[];
-}) => Promise<UserProgress>;
+import type { ID } from "../utils/internal";
+import type { AuthObject } from "../utils/public";
+import type { UserProgress } from "./models";
+/**
+ * A call to this function will retrieve a given user's
+ * progress on a given list of games, targeted by game ID.
+ *
+ * @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 progress for.
+ *
+ * @param payload.gameIds An array of RetroAchievements game IDs. If you aren't
+ * sure of the game ID, visit the game's page on the website and copy the number
+ * at the end of the URL.
+ *
+ * @example
+ * ```
+ * const userProgress = await getUserProgress(
+ *   authorization,
+ *   { userName: "xelnia", gameIds: [1, 14402] }
+ * );
+ * ```
+ *
+ * @returns An object which is a map of summarized progress for games.
+ * ```json
+ * {
+ *   "1": {
+ *     numPossibleAchievements: 24,
+ *     possibleScore: 255,
+ *     numAchieved: 0,
+ *     scoreAchieved: 0,
+ *     numAchievedHardcore: 0,
+ *     scoreAchievedHardcore: 0
+ *   },
+ *   "14402": {
+ *     numPossibleAchievements: 24,
+ *     possibleScore: 255,
+ *     numAchieved: 0,
+ *     scoreAchieved: 0,
+ *     numAchievedHardcore: 0,
+ *     scoreAchievedHardcore: 0
+ *   }
+ * }
+ * ```
+ */
+export declare const getUserProgress: (authorization: AuthObject, payload: {
+    userName: string;
+    gameIds: ID[];
+}) => Promise<UserProgress>;

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

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

package/dist/user/getUserRecentAchievements.d.ts

@@ -1,49 +1,49 @@
-import type { AuthObject } from "../utils/public";
-import type { UserRecentAchievement } from "./models";
-/**
- * A call to this function will retrieve a list of a target user's
- * recently earned achievements, via their username. By default, it
- * fetches achievements earned in the last hour.
- *
- * @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 recent achievements for.
- *
- * @param payload.recentMinutes Optional. Defaults to 60. How many minutes
- * back to fetch for the given user.
- *
- * @example
- * ```
- * const userRecentAchievements = await getUserRecentAchievements(
- *   authorization,
- *   { userName: "xelnia" }
- * );
- * ```
- *
- * @returns An array containing metadata about a user's recently earned achievements.
- * ```json
- * [
- *   {
- *     date: '2023-05-23 22:32:24',
- *     hardcoreMode: true,
- *     achievementId: 51214,
- *     title: "You're a special Champ!",
- *     description: 'Win the Tournament as [You] on Hard with 1 attribute on max. and 1 attribute on min.',
- *     badgeName: '121991',
- *     points: 25,
- *     author: 'Som1',
- *     gameTitle: 'WWF King of the Ring',
- *     gameIcon: '/Images/062599.png',
- *     gameId: 6316,
- *     consoleName: 'Game Boy',
- *     badgeUrl: '/Badge/121991.png',
- *     gameUrl: '/game/6316'
- *   }
- * ]
- * ```
- */
-export declare const getUserRecentAchievements: (authorization: AuthObject, payload: {
-    userName: string;
-    recentMinutes?: number;
-}) => Promise<UserRecentAchievement[]>;
+import type { AuthObject } from "../utils/public";
+import type { UserRecentAchievement } from "./models";
+/**
+ * A call to this function will retrieve a list of a target user's
+ * recently earned achievements, via their username. By default, it
+ * fetches achievements earned in the last hour.
+ *
+ * @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 recent achievements for.
+ *
+ * @param payload.recentMinutes Optional. Defaults to 60. How many minutes
+ * back to fetch for the given user.
+ *
+ * @example
+ * ```
+ * const userRecentAchievements = await getUserRecentAchievements(
+ *   authorization,
+ *   { userName: "xelnia" }
+ * );
+ * ```
+ *
+ * @returns An array containing metadata about a user's recently earned achievements.
+ * ```json
+ * [
+ *   {
+ *     date: '2023-05-23 22:32:24',
+ *     hardcoreMode: true,
+ *     achievementId: 51214,
+ *     title: "You're a special Champ!",
+ *     description: 'Win the Tournament as [You] on Hard with 1 attribute on max. and 1 attribute on min.',
+ *     badgeName: '121991',
+ *     points: 25,
+ *     author: 'Som1',
+ *     gameTitle: 'WWF King of the Ring',
+ *     gameIcon: '/Images/062599.png',
+ *     gameId: 6316,
+ *     consoleName: 'Game Boy',
+ *     badgeUrl: '/Badge/121991.png',
+ *     gameUrl: '/game/6316'
+ *   }
+ * ]
+ * ```
+ */
+export declare const getUserRecentAchievements: (authorization: AuthObject, payload: {
+    userName: string;
+    recentMinutes?: number;
+}) => Promise<UserRecentAchievement[]>;

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

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

package/dist/user/getUserRecentlyPlayedGames.d.ts

@@ -1,50 +1,50 @@
-import type { AuthObject } from "../utils/public";
-import type { UserRecentlyPlayedGames } from "./models";
-/**
- * A call to this function will retrieve a list of a target user's
- * recently played games, via their 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.count Optional. Defaults to 10. Max is 50. How many
- * recently played games for the user to retrieve.
- *
- * @param payload.offset Optional. Defaults to 0. Number of recently played
- * game entries to skip. This can be used for pagination.
- *
- * @example
- * ```
- * const userRecentlyPlayedGames = await getUserRecentlyPlayedGames(
- *   authorization,
- *   { userName: "xelnia" }
- * );
- * ```
- *
- * @returns An array containing metadata about a user's recently played games.
- * ```json
- * [
- *   {
- *     gameId: 19010,
- *     consoleId: 21,
- *     consoleName: "PlayStation 2",
- *     title: "Simpsons, The: Hit & Run",
- *     imageIcon: "/Images/066024.png",
- *     lastPlayed: "2022-10-24 22:05:12",
- *     numPossibleAchievements: 131,
- *     possibleScore: 865,
- *     numAchieved: 23,
- *     scoreAchieved: 84,
- *     numAchievedHardcore: 23,
- *     scoreAchievedHardcore: 84
- *   }
- * ]
- * ```
- */
-export declare const getUserRecentlyPlayedGames: (authorization: AuthObject, payload: {
-    userName: string;
-    offset?: number;
-    count?: number;
-}) => Promise<UserRecentlyPlayedGames>;
+import type { AuthObject } from "../utils/public";
+import type { UserRecentlyPlayedGames } from "./models";
+/**
+ * A call to this function will retrieve a list of a target user's
+ * recently played games, via their 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.count Optional. Defaults to 10. Max is 50. How many
+ * recently played games for the user to retrieve.
+ *
+ * @param payload.offset Optional. Defaults to 0. Number of recently played
+ * game entries to skip. This can be used for pagination.
+ *
+ * @example
+ * ```
+ * const userRecentlyPlayedGames = await getUserRecentlyPlayedGames(
+ *   authorization,
+ *   { userName: "xelnia" }
+ * );
+ * ```
+ *
+ * @returns An array containing metadata about a user's recently played games.
+ * ```json
+ * [
+ *   {
+ *     gameId: 19010,
+ *     consoleId: 21,
+ *     consoleName: "PlayStation 2",
+ *     title: "Simpsons, The: Hit & Run",
+ *     imageIcon: "/Images/066024.png",
+ *     lastPlayed: "2022-10-24 22:05:12",
+ *     numPossibleAchievements: 131,
+ *     possibleScore: 865,
+ *     numAchieved: 23,
+ *     scoreAchieved: 84,
+ *     numAchievedHardcore: 23,
+ *     scoreAchievedHardcore: 84
+ *   }
+ * ]
+ * ```
+ */
+export declare const getUserRecentlyPlayedGames: (authorization: AuthObject, payload: {
+    userName: string;
+    offset?: number;
+    count?: number;
+}) => Promise<UserRecentlyPlayedGames>;