@retroachievements/api 1.2.0 → 1.3.0

package/dist/feed/models/set-claim.model.d.ts

@@ -1,43 +1,43 @@
-import type { ClaimSetType } from "./claim-set-type.enum";
-import type { ClaimStatus } from "./claim-status.enum";
-import type { ClaimType } from "./claim-type.enum";
-export interface SetClaim {
-    /** Unique ID of the claim. */
-    id: number;
-    /** User who made the claim. */
-    user: string;
-    /** ID of the claimed game. */
-    gameId: number;
-    /** Title of the claimed game. */
-    gameTitle: string;
-    /** Site-relative path of the game's icon image. */
-    gameIcon: string;
-    /** Console name of the claimed game. */
-    consoleName: string;
-    /** Console ID of the claimed game. */
-    consoleId: number;
-    /** Whether the claim is primary or a collaboration. */
-    claimType: ClaimType;
-    /** Whether the claim is for a new set or a revision. */
-    setType: ClaimSetType;
-    /** Whether the claim is active, complete, or dropped. */
-    status: ClaimStatus;
-    /** Number of times the claim has been extended. */
-    extension: number;
-    /** Flag indicating a special type of claim. */
-    special: number;
-    /** Date the claim was made. */
-    created: string;
-    /**
-     * Date the claim is done. This is an expiration
-     * date for active claims, completion date for complete
-     * claims, and dropped date for dropped claims.
-     */
-    doneTime: string;
-    /** Date the claim was updated. */
-    updated: string;
-    /** Time in minutes left until the claim expires. */
-    minutesLeft: number;
-    /** True if the user is a junior dev. */
-    userIsJrDev: boolean;
-}
+import type { ClaimSetType } from "./claim-set-type.enum";
+import type { ClaimStatus } from "./claim-status.enum";
+import type { ClaimType } from "./claim-type.enum";
+export interface SetClaim {
+    /** Unique ID of the claim. */
+    id: number;
+    /** User who made the claim. */
+    user: string;
+    /** ID of the claimed game. */
+    gameId: number;
+    /** Title of the claimed game. */
+    gameTitle: string;
+    /** Site-relative path of the game's icon image. */
+    gameIcon: string;
+    /** Console name of the claimed game. */
+    consoleName: string;
+    /** Console ID of the claimed game. */
+    consoleId: number;
+    /** Whether the claim is primary or a collaboration. */
+    claimType: ClaimType;
+    /** Whether the claim is for a new set or a revision. */
+    setType: ClaimSetType;
+    /** Whether the claim is active, complete, or dropped. */
+    status: ClaimStatus;
+    /** Number of times the claim has been extended. */
+    extension: number;
+    /** Flag indicating a special type of claim. */
+    special: number;
+    /** Date the claim was made. */
+    created: string;
+    /**
+     * Date the claim is done. This is an expiration
+     * date for active claims, completion date for complete
+     * claims, and dropped date for dropped claims.
+     */
+    doneTime: string;
+    /** Date the claim was updated. */
+    updated: string;
+    /** Time in minutes left until the claim expires. */
+    minutesLeft: number;
+    /** True if the user is a junior dev. */
+    userIsJrDev: boolean;
+}

package/dist/feed/models/top-ten-users-entity.model.d.ts

@@ -1,5 +1,5 @@
-export interface TopTenUsersEntity {
-    userName: string;
-    totalPoints: number;
-    totalRatioPoints: number;
-}
+export interface TopTenUsersEntity {
+    userName: string;
+    totalPoints: number;
+    totalRatioPoints: number;
+}

package/dist/feed/models/top-ten-users.model.d.ts

@@ -1,2 +1,2 @@
-import type { TopTenUsersEntity } from "./top-ten-users-entity.model";
-export type TopTenUsers = TopTenUsersEntity[];
+import type { TopTenUsersEntity } from "./top-ten-users-entity.model";
+export type TopTenUsers = TopTenUsersEntity[];

package/dist/game/getAchievementCount.d.ts

@@ -1,32 +1,32 @@
-import type { ID } from "../utils/internal";
-import type { AuthObject } from "../utils/public";
-import type { AchievementCount } from "./models";
-/**
- * A call to this function will retrieve the list of
- * achievement IDs for a 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".
- *
- * @example
- * ```
- * const achievementCount = await getAchievementCount(
- *   authorization,
- *   { gameId: 14402 }
- * );
- * ```
- *
- * @returns An object containing a gameId and a list of
- * achievementIds.
- * ```
- * { gameId: 14402, achievementIds: [1,2,3,4,5] }
- * ```
- */
-export declare const getAchievementCount: (authorization: AuthObject, payload: {
-    gameId: ID;
-}) => Promise<AchievementCount>;
+import type { ID } from "../utils/internal";
+import type { AuthObject } from "../utils/public";
+import type { AchievementCount } from "./models";
+/**
+ * A call to this function will retrieve the list of
+ * achievement IDs for a 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".
+ *
+ * @example
+ * ```
+ * const achievementCount = await getAchievementCount(
+ *   authorization,
+ *   { gameId: 14402 }
+ * );
+ * ```
+ *
+ * @returns An object containing a gameId and a list of
+ * achievementIds.
+ * ```
+ * { gameId: 14402, achievementIds: [1,2,3,4,5] }
+ * ```
+ */
+export declare const getAchievementCount: (authorization: AuthObject, payload: {
+    gameId: ID;
+}) => Promise<AchievementCount>;

package/dist/game/getAchievementCount.test.d.ts

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

package/dist/game/getAchievementDistribution.d.ts

@@ -1,58 +1,58 @@
-import type { ID } from "../utils/internal";
-import type { AuthObject } from "../utils/public";
-import type { AchievementDistributionFlags, GetAchievementDistributionResponse } from "./models";
-/**
- * A call to this function will retrieve a dictionary
- * of the number of players who have earned a specific
- * number of achievements for a given 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.flags Optional. By default, only official achievement
- * tallies are returned in the response. Import the `AchievementDistributionFlags`
- * enum for possible values. This lets you see the count of players who have
- * unlocked unofficial achievements.
- *
- * @param payload.hardcore Optional. By default, set to false, with both
- * softcore and hardcore tallies returned in the response. If this option
- * is set to true, only hardcore unlocks will be included in the totals.
- *
- * @example
- * ```
- * const achievementDistribution = await getAchievementDistribution(
- *   authorization,
- *   { gameId: 14402, hardcore: true }
- * );
- * ```
- *
- * @returns A dictionary where the keys represent the earned achievement
- * count and the values represent the number of players who have unlocked
- * that many achievements.
- * ```
- * {
- *   '1': 64,
- *   '2': 19,
- *   '3': 11,
- *   '4': 18,
- *   '5': 25,
- *   '6': 20,
- *   '7': 26,
- *   '8': 29,
- *   '9': 54,
- *   '10': 17,
- *   '11': 29,
- *   '12': 4
- * }
- * ```
- */
-export declare const getAchievementDistribution: (authorization: AuthObject, payload: {
-    gameId: ID;
-    flags?: AchievementDistributionFlags;
-    hardcore?: boolean;
-}) => Promise<GetAchievementDistributionResponse>;
+import type { ID } from "../utils/internal";
+import type { AuthObject } from "../utils/public";
+import type { AchievementDistributionFlags, GetAchievementDistributionResponse } from "./models";
+/**
+ * A call to this function will retrieve a dictionary
+ * of the number of players who have earned a specific
+ * number of achievements for a given 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.flags Optional. By default, only official achievement
+ * tallies are returned in the response. Import the `AchievementDistributionFlags`
+ * enum for possible values. This lets you see the count of players who have
+ * unlocked unofficial achievements.
+ *
+ * @param payload.hardcore Optional. By default, set to false, with both
+ * softcore and hardcore tallies returned in the response. If this option
+ * is set to true, only hardcore unlocks will be included in the totals.
+ *
+ * @example
+ * ```
+ * const achievementDistribution = await getAchievementDistribution(
+ *   authorization,
+ *   { gameId: 14402, hardcore: true }
+ * );
+ * ```
+ *
+ * @returns A dictionary where the keys represent the earned achievement
+ * count and the values represent the number of players who have unlocked
+ * that many achievements.
+ * ```
+ * {
+ *   '1': 64,
+ *   '2': 19,
+ *   '3': 11,
+ *   '4': 18,
+ *   '5': 25,
+ *   '6': 20,
+ *   '7': 26,
+ *   '8': 29,
+ *   '9': 54,
+ *   '10': 17,
+ *   '11': 29,
+ *   '12': 4
+ * }
+ * ```
+ */
+export declare const getAchievementDistribution: (authorization: AuthObject, payload: {
+    gameId: ID;
+    flags?: AchievementDistributionFlags;
+    hardcore?: boolean;
+}) => Promise<GetAchievementDistributionResponse>;

package/dist/game/getAchievementDistribution.test.d.ts

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

package/dist/game/getGame.d.ts

@@ -1,49 +1,49 @@
-import type { ID } from "../utils/internal";
-import type { AuthObject } from "../utils/public";
-import type { Game } from "./models";
-/**
- * A call to this function will retrieve basic metadata about
- * a game, targeted via its unique 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".
- *
- * @example
- * ```
- * const game = await getGame(
- *   authorization,
- *   { gameId: 14402 }
- * );
- * ```
- *
- * @returns An object containing basic metadata about a target game.
- * ```json
- * {
- *   id: 14402,
- *   title: "Dragster",
- *   forumTopicId: 9145,
- *   consoleId: 25,
- *   consoleName: "Atari 2600",
- *   flags: 0,
- *   imageIcon: "/Images/026368.png",
- *   gameIcon: "/Images/026368.png",
- *   imageTitle: "/Images/026366.png",
- *   imageIngame: "/Images/026367.png",
- *   imageBoxArt: "/Images/026365.png",
- *   publisher: "Activision",
- *   developer: "David Crane",
- *   genre: "Racing",
- *   released: 1980,
- *   gameTitle: "Dragster",
- *   console: "Atari 2600"
- * }
- * ```
- */
-export declare const getGame: (authorization: AuthObject, payload: {
-    gameId: ID;
-}) => Promise<Game>;
+import type { ID } from "../utils/internal";
+import type { AuthObject } from "../utils/public";
+import type { Game } from "./models";
+/**
+ * A call to this function will retrieve basic metadata about
+ * a game, targeted via its unique 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".
+ *
+ * @example
+ * ```
+ * const game = await getGame(
+ *   authorization,
+ *   { gameId: 14402 }
+ * );
+ * ```
+ *
+ * @returns An object containing basic metadata about a target game.
+ * ```json
+ * {
+ *   id: 14402,
+ *   title: "Dragster",
+ *   forumTopicId: 9145,
+ *   consoleId: 25,
+ *   consoleName: "Atari 2600",
+ *   flags: 0,
+ *   imageIcon: "/Images/026368.png",
+ *   gameIcon: "/Images/026368.png",
+ *   imageTitle: "/Images/026366.png",
+ *   imageIngame: "/Images/026367.png",
+ *   imageBoxArt: "/Images/026365.png",
+ *   publisher: "Activision",
+ *   developer: "David Crane",
+ *   genre: "Racing",
+ *   released: 1980,
+ *   gameTitle: "Dragster",
+ *   console: "Atari 2600"
+ * }
+ * ```
+ */
+export declare const getGame: (authorization: AuthObject, payload: {
+    gameId: ID;
+}) => Promise<Game>;

package/dist/game/getGame.test.d.ts

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

package/dist/game/getGameExtended.d.ts

@@ -1,69 +1,69 @@
-import type { ID } from "../utils/internal";
-import type { AuthObject } from "../utils/public";
-import type { GameExtended } from "./models";
-/**
- * A call to this function will retrieve extended metadata
- * about a game, targeted via its unique 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".
- *
- * @example
- * ```
- * const gameExtended = await getGameExtended(
- *   authorization,
- *   { gameId: 14402 }
- * );
- * ```
- *
- * @returns An object containing extended metadata about a target game.
- * ```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"
- *     }
- *   }
- * }
- * ```
- */
-export declare const getGameExtended: (authorization: AuthObject, payload: {
-    gameId: ID;
-}) => Promise<GameExtended>;
+import type { ID } from "../utils/internal";
+import type { AuthObject } from "../utils/public";
+import type { GameExtended } from "./models";
+/**
+ * A call to this function will retrieve extended metadata
+ * about a game, targeted via its unique 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".
+ *
+ * @example
+ * ```
+ * const gameExtended = await getGameExtended(
+ *   authorization,
+ *   { gameId: 14402 }
+ * );
+ * ```
+ *
+ * @returns An object containing extended metadata about a target game.
+ * ```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"
+ *     }
+ *   }
+ * }
+ * ```
+ */
+export declare const getGameExtended: (authorization: AuthObject, payload: {
+    gameId: ID;
+}) => Promise<GameExtended>;

package/dist/game/getGameExtended.test.d.ts

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

package/dist/game/getGameRankAndScore.d.ts

@@ -1,39 +1,39 @@
-import type { ID } from "../utils/internal";
-import type { AuthObject } from "../utils/public";
-import type { GameRankAndScoreEntity } from "./models";
-/**
- * A call to this function will retrieve metadata about
- * either the latest masters for a game, or the highest
- * points earners for a game. The game is targeted via
- * its unique 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.type Can either be "latest-masters" or "high-scores".
- *
- * @example
- * ```
- * const gameRankAndScore = await getGameRankAndScore(
- *   authorization,
- *   { gameId: 14402, type: "latest-masters" }
- * );
- * ```
- *
- * @returns An array containing a list of latest masters or
- * high score earners for a given game ID.
- * ```json
- * [
- *   {  user: 'Arekdias', totalScore: 189, lastAward: '2020-10-10 22:43:32' }
- * ]
- * ```
- */
-export declare const getGameRankAndScore: (authorization: AuthObject, payload: {
-    gameId: ID;
-    type: "latest-masters" | "high-scores";
-}) => Promise<GameRankAndScoreEntity[]>;
+import type { ID } from "../utils/internal";
+import type { AuthObject } from "../utils/public";
+import type { GameRankAndScoreEntity } from "./models";
+/**
+ * A call to this function will retrieve metadata about
+ * either the latest masters for a game, or the highest
+ * points earners for a game. The game is targeted via
+ * its unique 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.type Can either be "latest-masters" or "high-scores".
+ *
+ * @example
+ * ```
+ * const gameRankAndScore = await getGameRankAndScore(
+ *   authorization,
+ *   { gameId: 14402, type: "latest-masters" }
+ * );
+ * ```
+ *
+ * @returns An array containing a list of latest masters or
+ * high score earners for a given game ID.
+ * ```json
+ * [
+ *   {  user: 'Arekdias', totalScore: 189, lastAward: '2020-10-10 22:43:32' }
+ * ]
+ * ```
+ */
+export declare const getGameRankAndScore: (authorization: AuthObject, payload: {
+    gameId: ID;
+    type: "latest-masters" | "high-scores";
+}) => Promise<GameRankAndScoreEntity[]>;

package/dist/game/getGameRankAndScore.test.d.ts

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