@retroachievements/api 1.2.1 → 1.4.0

package/dist/game/getGameRating.d.ts

@@ -1,39 +1,39 @@
-import type { ID } from "../utils/internal";
-import type { AuthObject } from "../utils/public";
-import type { GameRating } from "./models";
-/**
- * A call to this function will retrieve metadata about
- * how users have rated the game and its set.
- *
- * @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 gameRating = await getGameRating(
- *   authorization,
- *   { gameId: 14402 }
- * );
- * ```
- *
- * @returns An object with game rating metadata.
- * ```json
- * {
- *   gameId: 14402,
- *   ratings: {
- *     game: 3.1875,
- *     achievements: 0,
- *     gameNumVotes: 16,
- *     achievementsNumVotes: 0
- *   }
- * }
- * ```
- */
-export declare const getGameRating: (authorization: AuthObject, payload: {
-    gameId: ID;
-}) => Promise<GameRating>;
+import type { ID } from "../utils/internal";
+import type { AuthObject } from "../utils/public";
+import type { GameRating } from "./models";
+/**
+ * A call to this function will retrieve metadata about
+ * how users have rated the game and its set.
+ *
+ * @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 gameRating = await getGameRating(
+ *   authorization,
+ *   { gameId: 14402 }
+ * );
+ * ```
+ *
+ * @returns An object with game rating metadata.
+ * ```json
+ * {
+ *   gameId: 14402,
+ *   ratings: {
+ *     game: 3.1875,
+ *     achievements: 0,
+ *     gameNumVotes: 16,
+ *     achievementsNumVotes: 0
+ *   }
+ * }
+ * ```
+ */
+export declare const getGameRating: (authorization: AuthObject, payload: {
+    gameId: ID;
+}) => Promise<GameRating>;

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

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

package/dist/game/index.d.ts

@@ -1,7 +1,7 @@
-export * from "./getAchievementCount";
-export * from "./getAchievementDistribution";
-export * from "./getGame";
-export * from "./getGameExtended";
-export * from "./getGameRankAndScore";
-export * from "./getGameRating";
-export * from "./models";
+export * from "./getAchievementCount";
+export * from "./getAchievementDistribution";
+export * from "./getGame";
+export * from "./getGameExtended";
+export * from "./getGameRankAndScore";
+export * from "./getGameRating";
+export * from "./models";

package/dist/game/models/achievement-count.model.d.ts

@@ -1,4 +1,4 @@
-export interface AchievementCount {
-    gameId: number;
-    achievementIds: number[];
-}
+export interface AchievementCount {
+    gameId: number;
+    achievementIds: number[];
+}

package/dist/game/models/achievement-distribution-flags.enum.d.ts

@@ -1,4 +1,4 @@
-export declare enum AchievementDistributionFlags {
-    CoreAchievements = 3,
-    UnofficialAchievements = 5
-}
+export declare enum AchievementDistributionFlags {
+    CoreAchievements = 3,
+    UnofficialAchievements = 5
+}

package/dist/game/models/game-extended-achievement-entity.model.d.ts

@@ -1,15 +1,15 @@
-export interface GameExtendedAchievementEntity {
-    id: number;
-    numAwarded: number;
-    numAwardedHardcore: number;
-    title: string;
-    description: string;
-    points: number;
-    trueRatio: number;
-    author: string;
-    dateModified: string;
-    dateCreated: string;
-    badgeName: string;
-    displayOrder: number;
-    memAddr: string;
-}
+export interface GameExtendedAchievementEntity {
+    id: number;
+    numAwarded: number;
+    numAwardedHardcore: number;
+    title: string;
+    description: string;
+    points: number;
+    trueRatio: number;
+    author: string;
+    dateModified: string;
+    dateCreated: string;
+    badgeName: string;
+    displayOrder: number;
+    memAddr: string;
+}

package/dist/game/models/game-extended-claim-entity.model.d.ts

@@ -1,7 +1,7 @@
-export interface GameExtendedClaimEntity {
-    user: string;
-    setType: number;
-    claimType: number;
-    created: string;
-    expiration: string;
-}
+export interface GameExtendedClaimEntity {
+    user: string;
+    setType: number;
+    claimType: number;
+    created: string;
+    expiration: string;
+}

package/dist/game/models/game-extended.model.d.ts

@@ -1,25 +1,25 @@
-import type { GameExtendedAchievementEntity } from "./game-extended-achievement-entity.model";
-import type { GameExtendedClaimEntity } from "./game-extended-claim-entity.model";
-export interface GameExtended {
-    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: number;
-    isFinal: boolean;
-    consoleName: string;
-    richPresencePatch: string;
-    numAchievements: number;
-    numDistinctPlayersCasual: number;
-    numDistinctPlayersHardcore: number;
-    claims: GameExtendedClaimEntity[];
-    achievements: Record<number, GameExtendedAchievementEntity>;
-}
+import type { GameExtendedAchievementEntity } from "./game-extended-achievement-entity.model";
+import type { GameExtendedClaimEntity } from "./game-extended-claim-entity.model";
+export interface GameExtended {
+    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;
+    numAchievements: number;
+    numDistinctPlayersCasual: number;
+    numDistinctPlayersHardcore: number;
+    claims: GameExtendedClaimEntity[];
+    achievements: Record<number, GameExtendedAchievementEntity>;
+}

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

@@ -1,6 +1,6 @@
-export interface GameRankAndScoreEntity {
-    user: string;
-    totalScore: number;
-    lastAward: string;
-    rank?: number;
-}
+export interface GameRankAndScoreEntity {
+    user: string;
+    totalScore: number;
+    lastAward: string;
+    rank?: number;
+}

package/dist/game/models/game-rating.model.d.ts

@@ -1,9 +1,9 @@
-export interface GameRating {
-    gameId: number;
-    ratings: {
-        game: number;
-        achievements: number;
-        gameNumVotes: number;
-        achievementsNumVotes: number;
-    };
-}
+export interface GameRating {
+    gameId: number;
+    ratings: {
+        game: number;
+        achievements: number;
+        gameNumVotes: number;
+        achievementsNumVotes: number;
+    };
+}

package/dist/game/models/game.model.d.ts

@@ -1,19 +1,19 @@
-export interface Game {
-    id: number;
-    title: string;
-    forumTopicId: number;
-    consoleId: number;
-    consoleName: string;
-    flags: number;
-    imageIcon: string;
-    gameIcon: string;
-    imageTitle: string;
-    imageIngame: string;
-    imageBoxArt: string;
-    publisher: string;
-    developer: string;
-    genre: string;
-    released: number;
-    gameTitle: string;
-    console: string;
-}
+export interface Game {
+    id: number;
+    title: string;
+    forumTopicId: number;
+    consoleId: number;
+    consoleName: string;
+    flags: number;
+    imageIcon: string;
+    gameIcon: string;
+    imageTitle: string;
+    imageIngame: string;
+    imageBoxArt: string;
+    publisher: string;
+    developer: string;
+    genre: string;
+    released: string;
+    gameTitle: string;
+    console: string;
+}

package/dist/game/models/get-achievement-count-response.model.d.ts

@@ -1,4 +1,4 @@
-export interface GetAchievementCountResponse {
-    GameID: number;
-    AchievementIDs: number[];
-}
+export interface GetAchievementCountResponse {
+    GameID: number;
+    AchievementIDs: number[];
+}

package/dist/game/models/get-achievement-distribution-response.model.d.ts

@@ -1 +1 @@
-export type GetAchievementDistributionResponse = Record<`${number}`, number>;
+export type GetAchievementDistributionResponse = Record<`${number}`, number>;

package/dist/game/models/get-game-extended-response.model.d.ts

@@ -1,50 +1,50 @@
-declare enum GameExtendedClaimType {
-    Primary = "0",
-    Collaboration = "1"
-}
-export interface GameExtendedRawAchievementEntity {
-    ID: string;
-    NumAwarded: string;
-    NumAwardedHardcore: string;
-    Title: string;
-    Description: string;
-    Points: string;
-    TrueRatio: string;
-    Author: string;
-    DateModified: string;
-    DateCreated: string;
-    BadgeName: string;
-    DisplayOrder: string;
-    MemAddr: string;
-}
-interface GameExtendedRawClaimEntity {
-    User: string;
-    SetType: string;
-    ClaimType: GameExtendedClaimType;
-    Created: string;
-    Expiration: string;
-}
-export interface GetGameExtendedResponse {
-    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;
-    NumAchievements: number;
-    NumDistinctPlayersCasual: string;
-    NumDistinctPlayersHardcore: string;
-    Claims: GameExtendedRawClaimEntity[];
-    Achievements: Record<number, GameExtendedRawAchievementEntity> | [];
-}
-export {};
+declare enum GameExtendedClaimType {
+    Primary = "0",
+    Collaboration = "1"
+}
+export interface GameExtendedRawAchievementEntity {
+    ID: string;
+    NumAwarded: string;
+    NumAwardedHardcore: string;
+    Title: string;
+    Description: string;
+    Points: string;
+    TrueRatio: string;
+    Author: string;
+    DateModified: string;
+    DateCreated: string;
+    BadgeName: string;
+    DisplayOrder: string;
+    MemAddr: string;
+}
+interface GameExtendedRawClaimEntity {
+    User: string;
+    SetType: string;
+    ClaimType: GameExtendedClaimType;
+    Created: string;
+    Expiration: string;
+}
+export interface GetGameExtendedResponse {
+    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;
+    NumAchievements: number;
+    NumDistinctPlayersCasual: string;
+    NumDistinctPlayersHardcore: string;
+    Claims: GameExtendedRawClaimEntity[];
+    Achievements: Record<number, GameExtendedRawAchievementEntity> | [];
+}
+export {};

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

@@ -1,8 +1,8 @@
-interface RawGameRankAndScoreEntity {
-    User: string;
-    TotalScore: string;
-    LastAward: string;
-    Rank: number;
-}
-export type GetGameRankAndScoreResponse = RawGameRankAndScoreEntity[];
-export {};
+interface RawGameRankAndScoreEntity {
+    User: string;
+    TotalScore: string;
+    LastAward: string;
+    Rank: number;
+}
+export type GetGameRankAndScoreResponse = RawGameRankAndScoreEntity[];
+export {};

package/dist/game/models/get-game-rating-response.model.d.ts

@@ -1,9 +1,9 @@
-export interface GetGameRatingResponse {
-    GameID: number;
-    Ratings: {
-        Game: number;
-        Achievements: number;
-        GameNumVotes: number;
-        AchievementsNumVotes: number;
-    };
-}
+export interface GetGameRatingResponse {
+    GameID: number;
+    Ratings: {
+        Game: number;
+        Achievements: number;
+        GameNumVotes: number;
+        AchievementsNumVotes: number;
+    };
+}

package/dist/game/models/get-game-response.model.d.ts

@@ -1,19 +1,19 @@
-export interface GetGameResponse {
-    ID: string;
-    Title: string;
-    ForumTopicID: string;
-    ConsoleID: string;
-    ConsoleName: string;
-    Flags: string;
-    ImageIcon: string;
-    GameIcon: string;
-    ImageTitle: string;
-    ImageIngame: string;
-    ImageBoxArt: string;
-    Publisher: string;
-    Developer: string;
-    Genre: string;
-    Released: string;
-    GameTitle: string;
-    Console: string;
-}
+export interface GetGameResponse {
+    ID: string;
+    Title: string;
+    ForumTopicID: string;
+    ConsoleID: string;
+    ConsoleName: string;
+    Flags: string;
+    ImageIcon: string;
+    GameIcon: string;
+    ImageTitle: string;
+    ImageIngame: string;
+    ImageBoxArt: string;
+    Publisher: string;
+    Developer: string;
+    Genre: string;
+    Released: string;
+    GameTitle: string;
+    Console: string;
+}

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

@@ -1,14 +1,14 @@
-export * from "./achievement-count.model";
-export * from "./achievement-distribution-flags.enum";
-export * from "./game.model";
-export * from "./game-extended.model";
-export * from "./game-extended-achievement-entity.model";
-export * from "./game-extended-claim-entity.model";
-export * from "./game-rank-and-score-entity.model";
-export * from "./game-rating.model";
-export * from "./get-achievement-count-response.model";
-export * from "./get-achievement-distribution-response.model";
-export * from "./get-game-extended-response.model";
-export * from "./get-game-rank-and-score-response.model";
-export * from "./get-game-rating-response.model";
-export * from "./get-game-response.model";
+export * from "./achievement-count.model";
+export * from "./achievement-distribution-flags.enum";
+export * from "./game.model";
+export * from "./game-extended.model";
+export * from "./game-extended-achievement-entity.model";
+export * from "./game-extended-claim-entity.model";
+export * from "./game-rank-and-score-entity.model";
+export * from "./game-rating.model";
+export * from "./get-achievement-count-response.model";
+export * from "./get-achievement-distribution-response.model";
+export * from "./get-game-extended-response.model";
+export * from "./get-game-rank-and-score-response.model";
+export * from "./get-game-rating-response.model";
+export * from "./get-game-response.model";

package/dist/index.d.ts

@@ -1,7 +1,7 @@
-export * from "./achievement";
-export * from "./console";
-export * from "./feed";
-export * from "./game";
-export * from "./ticket";
-export * from "./user";
-export * from "./utils/public";
+export * from "./achievement";
+export * from "./console";
+export * from "./feed";
+export * from "./game";
+export * from "./ticket";
+export * from "./user";
+export * from "./utils/public";