@retroachievements/api 1.2.1 → 1.4.0

package/dist/user/getAchievementsEarnedBetween.d.ts

@@ -1,59 +1,59 @@
-import type { AuthObject } from "../utils/public";
-import type { DatedUserAchievement } from "./models";
-/**
- * A call to this function will retrieve a list of achievements
- * earned by a given user between two provided dates.
- *
- * @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
- * list of achievements for.
- *
- * @param payload.fromDate A Date object specifying when
- * the list itself should begin.
- *
- * @param payload.toDate A Date object specifying when
- * the list itself should end.
- *
- * @example
- * ```
- * const achievementsEarnedBetween = await getAchievementsEarnedBetween(
- *   authorization,
- *   {
- *     userName: "xelnia",
- *     fromDate: new Date("2022-10-12"),
- *     toDate: new Date("2022-10-13")
- *   }
- * );
- * ```
- *
- * @returns An array containing metadata about the user
- * achievements earned during the specified date range.
- * ```
- * [
- *   {
- *     date: '2022-10-12 07:58:05',
- *     hardcoreMode: true,
- *     achievementId: 173315,
- *     title: 'Your Puny Human Weapons',
- *     description: 'Collect all objects in the Weapons Category.',
- *     badgeName: '193756',
- *     points: 10,
- *     author: 'blendedsea',
- *     gameTitle: 'Me & My Katamari',
- *     gameIcon: '/Images/047357.png',
- *     gameId: 3571,
- *     consoleName: 'PlayStation Portable',
- *     cumulScore: 120,
- *     badgeUrl: '/Badge/193756.png',
- *     gameUrl: '/game/3571'
- *   }
- * ]
- * ```
- */
-export declare const getAchievementsEarnedBetween: (authorization: AuthObject, payload: {
-    userName: string;
-    fromDate: Date;
-    toDate: Date;
-}) => Promise<DatedUserAchievement[]>;
+import type { AuthObject } from "../utils/public";
+import type { DatedUserAchievement } from "./models";
+/**
+ * A call to this function will retrieve a list of achievements
+ * earned by a given user between two provided dates.
+ *
+ * @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
+ * list of achievements for.
+ *
+ * @param payload.fromDate A Date object specifying when
+ * the list itself should begin.
+ *
+ * @param payload.toDate A Date object specifying when
+ * the list itself should end.
+ *
+ * @example
+ * ```
+ * const achievementsEarnedBetween = await getAchievementsEarnedBetween(
+ *   authorization,
+ *   {
+ *     userName: "xelnia",
+ *     fromDate: new Date("2022-10-12"),
+ *     toDate: new Date("2022-10-13")
+ *   }
+ * );
+ * ```
+ *
+ * @returns An array containing metadata about the user
+ * achievements earned during the specified date range.
+ * ```
+ * [
+ *   {
+ *     date: '2022-10-12 07:58:05',
+ *     hardcoreMode: true,
+ *     achievementId: 173315,
+ *     title: 'Your Puny Human Weapons',
+ *     description: 'Collect all objects in the Weapons Category.',
+ *     badgeName: '193756',
+ *     points: 10,
+ *     author: 'blendedsea',
+ *     gameTitle: 'Me & My Katamari',
+ *     gameIcon: '/Images/047357.png',
+ *     gameId: 3571,
+ *     consoleName: 'PlayStation Portable',
+ *     cumulScore: 120,
+ *     badgeUrl: '/Badge/193756.png',
+ *     gameUrl: '/game/3571'
+ *   }
+ * ]
+ * ```
+ */
+export declare const getAchievementsEarnedBetween: (authorization: AuthObject, payload: {
+    userName: string;
+    fromDate: Date;
+    toDate: Date;
+}) => Promise<DatedUserAchievement[]>;

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

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

package/dist/user/getAchievementsEarnedOnDay.d.ts

@@ -1,57 +1,57 @@
-import type { AuthObject } from "../utils/public";
-import type { DatedUserAchievement } from "./models";
-/**
- * A call to this function will retrieve a list of achievements
- * earned by a given user on a specified date.
- *
- * @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
- * list of achievements for.
- *
- * @param payload.fromDate A Date object specifying when
- * the list itself should begin.
- *
- * @param payload.onDate A Date object specifying the day
- * to query for a user's earned achievements.
- *
- * @example
- * ```
- * const achievementsEarnedOnDay = await getAchievementsEarnedOnDay(
- *   authorization,
- *   {
- *     userName: "xelnia",
- *     onDate: new Date("2022-10-13")
- *   }
- * );
- * ```
- *
- * @returns An array containing metadata about the user
- * achievements earned on the specified day.
- * ```
- *  [
- *    {
- *      date: '2022-10-12 07:58:05',
- *      hardcoreMode: true,
- *      achievementId: 173315,
- *      title: 'Your Puny Human Weapons',
- *      description: 'Collect all objects in the Weapons Category.',
- *      badgeName: '193756',
- *      points: 10,
- *      author: 'blendedsea',
- *      gameTitle: 'Me & My Katamari',
- *      gameIcon: '/Images/047357.png',
- *      gameId: 3571,
- *      consoleName: 'PlayStation Portable',
- *      cumulScore: 120,
- *      badgeUrl: '/Badge/193756.png',
- *      gameUrl: '/game/3571'
- *    }
- *  ]
- * ```
- */
-export declare const getAchievementsEarnedOnDay: (authorization: AuthObject, payload: {
-    userName: string;
-    onDate: Date;
-}) => Promise<DatedUserAchievement[]>;
+import type { AuthObject } from "../utils/public";
+import type { DatedUserAchievement } from "./models";
+/**
+ * A call to this function will retrieve a list of achievements
+ * earned by a given user on a specified date.
+ *
+ * @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
+ * list of achievements for.
+ *
+ * @param payload.fromDate A Date object specifying when
+ * the list itself should begin.
+ *
+ * @param payload.onDate A Date object specifying the day
+ * to query for a user's earned achievements.
+ *
+ * @example
+ * ```
+ * const achievementsEarnedOnDay = await getAchievementsEarnedOnDay(
+ *   authorization,
+ *   {
+ *     userName: "xelnia",
+ *     onDate: new Date("2022-10-13")
+ *   }
+ * );
+ * ```
+ *
+ * @returns An array containing metadata about the user
+ * achievements earned on the specified day.
+ * ```
+ *  [
+ *    {
+ *      date: '2022-10-12 07:58:05',
+ *      hardcoreMode: true,
+ *      achievementId: 173315,
+ *      title: 'Your Puny Human Weapons',
+ *      description: 'Collect all objects in the Weapons Category.',
+ *      badgeName: '193756',
+ *      points: 10,
+ *      author: 'blendedsea',
+ *      gameTitle: 'Me & My Katamari',
+ *      gameIcon: '/Images/047357.png',
+ *      gameId: 3571,
+ *      consoleName: 'PlayStation Portable',
+ *      cumulScore: 120,
+ *      badgeUrl: '/Badge/193756.png',
+ *      gameUrl: '/game/3571'
+ *    }
+ *  ]
+ * ```
+ */
+export declare const getAchievementsEarnedOnDay: (authorization: AuthObject, payload: {
+    userName: string;
+    onDate: Date;
+}) => Promise<DatedUserAchievement[]>;

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

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

package/dist/user/getGameInfoAndUserProgress.d.ts

@@ -1,81 +1,81 @@
-import type { ID } from "../utils/internal";
-import type { AuthObject } from "../utils/public";
-import type { GameInfoAndUserProgress } from "./models";
-/**
- * A call to this function will retrieve extended metadata
- * about a game, in addition to a user's progress about a game.
- * This is targeted via a game's unique ID and a given username.
- *
- * @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 progress for.
- *
- * @example
- * ```
- * const gameInfoAndUserProgress = await getGameInfoAndUserProgress(
- *   authorization,
- *   { gameId: 14402, userName: "wv_pinball" }
- * );
- * ```
- *
- * @returns An object containing extended metadata about a target game,
- * with attached progress for a target username.
- * ```json
- * {
- *   id: 14402,
- *   title: "Dragster",
- *   consoleId: 25,
- *   forumTopicId: 9145,
- *   flags: 0,
- *   imageIcon: "/Images/026368.png",
- *   imageTitle: "/Images/026366.png",
- *   imageIngame: "/Images/026367.png",
- *   imageBoxArt: "/Images/026365.png",
- *   publisher: "Activision",
- *   developer: "David Crane",
- *   genre: "Racing",
- *   released: 1980,
- *   isFinal: false,
- *   consoleName: "Atari 2600",
- *   richPresencePatch: "2b92fa1bf9635c303b3b7f8feea3ed3c",
- *   numAchievements: 12,
- *   numDistinctPlayersCasual: 454,
- *   numDistinctPlayersHardcore, 323
- *   claims: [],
- *   achievements: {
- *     '79434': {
- *       id: 79434,
- *       numAwarded: 338,
- *       numAwardedHardcore: 253,
- *       title: "Novice Dragster Driver 1",
- *       description: "Complete your very first race in game 1.",
- *       points: 1,
- *       trueRatio: 1,
- *       author: "Boldewin",
- *       dateModified: "2019-08-01 19:03:46",
- *       dateCreated: "2019-07-31 18:49:57",
- *       badgeName: "85541",
- *       displayOrder: 0,
- *       memAddr: "f5c41fa0b5fa0d5fbb8a74c598f18582",
- *       dateEarned: '2022-08-23 22:56:38',
- *       dateEarnedHardcore: '2022-08-23 22:56:38'
- *     }
- *   },
- *   numAwardedToUser: 12,
- *   numAwardedToUserHardcore: 12,
- *   userCompletion: "100.00%",
- *   userCompletionHardcore: "100.00%"
- * }
- * ```
- */
-export declare const getGameInfoAndUserProgress: (authorization: AuthObject, payload: {
-    gameId: ID;
-    userName: string;
-}) => Promise<GameInfoAndUserProgress>;
+import type { ID } from "../utils/internal";
+import type { AuthObject } from "../utils/public";
+import type { GameInfoAndUserProgress } from "./models";
+/**
+ * A call to this function will retrieve extended metadata
+ * about a game, in addition to a user's progress about a game.
+ * This is targeted via a game's unique ID and a given username.
+ *
+ * @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 progress for.
+ *
+ * @example
+ * ```
+ * const gameInfoAndUserProgress = await getGameInfoAndUserProgress(
+ *   authorization,
+ *   { gameId: 14402, userName: "wv_pinball" }
+ * );
+ * ```
+ *
+ * @returns An object containing extended metadata about a target game,
+ * with attached progress for a target username.
+ * ```json
+ * {
+ *   id: 14402,
+ *   title: "Dragster",
+ *   consoleId: 25,
+ *   forumTopicId: 9145,
+ *   flags: 0,
+ *   imageIcon: "/Images/026368.png",
+ *   imageTitle: "/Images/026366.png",
+ *   imageIngame: "/Images/026367.png",
+ *   imageBoxArt: "/Images/026365.png",
+ *   publisher: "Activision",
+ *   developer: "David Crane",
+ *   genre: "Racing",
+ *   released: 1980,
+ *   isFinal: false,
+ *   consoleName: "Atari 2600",
+ *   richPresencePatch: "2b92fa1bf9635c303b3b7f8feea3ed3c",
+ *   numAchievements: 12,
+ *   numDistinctPlayersCasual: 454,
+ *   numDistinctPlayersHardcore, 323
+ *   claims: [],
+ *   achievements: {
+ *     '79434': {
+ *       id: 79434,
+ *       numAwarded: 338,
+ *       numAwardedHardcore: 253,
+ *       title: "Novice Dragster Driver 1",
+ *       description: "Complete your very first race in game 1.",
+ *       points: 1,
+ *       trueRatio: 1,
+ *       author: "Boldewin",
+ *       dateModified: "2019-08-01 19:03:46",
+ *       dateCreated: "2019-07-31 18:49:57",
+ *       badgeName: "85541",
+ *       displayOrder: 0,
+ *       memAddr: "f5c41fa0b5fa0d5fbb8a74c598f18582",
+ *       dateEarned: '2022-08-23 22:56:38',
+ *       dateEarnedHardcore: '2022-08-23 22:56:38'
+ *     }
+ *   },
+ *   numAwardedToUser: 12,
+ *   numAwardedToUserHardcore: 12,
+ *   userCompletion: "100.00%",
+ *   userCompletionHardcore: "100.00%"
+ * }
+ * ```
+ */
+export declare const getGameInfoAndUserProgress: (authorization: AuthObject, payload: {
+    gameId: ID;
+    userName: string;
+}) => Promise<GameInfoAndUserProgress>;

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

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

package/dist/user/getUserAwards.d.ts

@@ -1,47 +1,49 @@
-import type { AuthObject } from "../utils/public";
-import type { UserAwards } from "./models";
-/**
- * A call to this function will retrieve metadata about the target user's
- * site awards, 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 site awards for.
- *
- * @example
- * ```
- * const userAwards = await getUserAwards(
- *   authorization,
- *   { userName: "xelnia" }
- * )
- * ```
- *
- * @returns
- * ```json
- * {
- *   totalAwardsCount: 10,
- *   hiddenAwardsCount: 2,
- *   masteryAwardsCount: 6,
- *   completionAwardsCount: 0,
- *   eventAwardsCount: 0,
- *   siteAwardsCount: 2,
- *   visibleUserAwards: [
- *     {
- *       awardedAt: "2022-08-26T19:34:43+00:00",
- *       awardType: "Mastery/Completion",
- *       awardData: 802,
- *       awardDataExtra: 1,
- *       displayOrder: 114,
- *       title: "WarioWare, Inc.: Mega Microgames!",
- *       consoleName: "Game Boy Advance",
- *       flags: null,
- *       imageIcon: "/Images/034678.png"
- *     }
- *   ]
- * }
- * ```
- */
-export declare const getUserAwards: (authorization: AuthObject, payload: {
-    userName: string;
-}) => Promise<UserAwards>;
+import type { AuthObject } from "../utils/public";
+import type { UserAwards } from "./models";
+/**
+ * A call to this function will retrieve metadata about the target user's
+ * site awards, 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 site awards for.
+ *
+ * @example
+ * ```
+ * const userAwards = await getUserAwards(
+ *   authorization,
+ *   { userName: "xelnia" }
+ * )
+ * ```
+ *
+ * @returns
+ * ```json
+ * {
+ *   totalAwardsCount: 10,
+ *   hiddenAwardsCount: 2,
+ *   masteryAwardsCount: 6,
+ *   completionAwardsCount: 0,
+ *   beatenHardcoreAwardsCount: 24,
+ *   beatenSoftcoreAwardsCount: 7,
+ *   eventAwardsCount: 0,
+ *   siteAwardsCount: 2,
+ *   visibleUserAwards: [
+ *     {
+ *       awardedAt: "2022-08-26T19:34:43+00:00",
+ *       awardType: "Mastery/Completion",
+ *       awardData: 802,
+ *       awardDataExtra: 1,
+ *       displayOrder: 114,
+ *       title: "WarioWare, Inc.: Mega Microgames!",
+ *       consoleName: "Game Boy Advance",
+ *       flags: null,
+ *       imageIcon: "/Images/034678.png"
+ *     }
+ *   ]
+ * }
+ * ```
+ */
+export declare const getUserAwards: (authorization: AuthObject, payload: {
+    userName: string;
+}) => Promise<UserAwards>;

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

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

package/dist/user/getUserClaims.d.ts

@@ -1,27 +1,27 @@
-import type { AuthObject } from "../utils/public";
-import type { UserClaims } from "./models";
-/**
- * A call to this function will retrieve a list of
- * achievement set claims made over the lifetime of a given
- * user, 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 historical
- * achievement set claims list for.
- *
- * @example
- * ```
- * const userClaims = await getUserClaims(
- *   authorization,
- *   { userName: "Jamiras" }
- * );
- * ```
- *
- * @returns An array containing all the achievement set claims
- * made over the lifetime of the given user.
- */
-export declare const getUserClaims: (authorization: AuthObject, payload: {
-    userName: string;
-}) => Promise<UserClaims>;
+import type { AuthObject } from "../utils/public";
+import type { UserClaims } from "./models";
+/**
+ * A call to this function will retrieve a list of
+ * achievement set claims made over the lifetime of a given
+ * user, 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 historical
+ * achievement set claims list for.
+ *
+ * @example
+ * ```
+ * const userClaims = await getUserClaims(
+ *   authorization,
+ *   { userName: "Jamiras" }
+ * );
+ * ```
+ *
+ * @returns An array containing all the achievement set claims
+ * made over the lifetime of the given user.
+ */
+export declare const getUserClaims: (authorization: AuthObject, payload: {
+    userName: string;
+}) => Promise<UserClaims>;

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

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