@retroachievements/api 1.2.1 → 1.4.0

package/dist/console/models/game-list.model.d.ts

@@ -1,15 +1,15 @@
-interface GameEntity {
-    title: string;
-    id: number;
-    consoleId: number;
-    consoleName: string;
-    imageIcon: string;
-    numAchievements: number;
-    numLeaderboards: number;
-    points: number;
-    dateModified: string;
-    forumTopicId: number;
-    hashes?: string[];
-}
-export type GameList = GameEntity[];
-export {};
+interface GameEntity {
+    title: string;
+    id: number;
+    consoleId: number;
+    consoleName: string;
+    imageIcon: string;
+    numAchievements: number;
+    numLeaderboards: number;
+    points: number;
+    dateModified: string;
+    forumTopicId: number;
+    hashes?: string[];
+}
+export type GameList = GameEntity[];
+export {};

package/dist/console/models/get-console-ids-response.model.d.ts

@@ -1,4 +1,4 @@
-export type GetConsoleIdsResponse = readonly {
-    ID: string;
-    Name: string;
-}[];
+export type GetConsoleIdsResponse = readonly {
+    ID: string;
+    Name: string;
+}[];

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

@@ -1,15 +1,15 @@
-interface RawGameListEntity {
-    Title: string;
-    ID: string;
-    ConsoleID: string;
-    ConsoleName: string;
-    ImageIcon: string;
-    NumAchievements: number;
-    NumLeaderboards: number;
-    Points: number;
-    DateModified: string;
-    ForumTopicID: number;
-    Hashes?: string[];
-}
-export type GetGameListResponse = RawGameListEntity[];
-export {};
+interface RawGameListEntity {
+    Title: string;
+    ID: string;
+    ConsoleID: string;
+    ConsoleName: string;
+    ImageIcon: string;
+    NumAchievements: number;
+    NumLeaderboards: number;
+    Points: number;
+    DateModified: string;
+    ForumTopicID: number;
+    Hashes?: string[];
+}
+export type GetGameListResponse = RawGameListEntity[];
+export {};

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

@@ -1,4 +1,4 @@
-export * from "./console-id.model";
-export * from "./game-list.model";
-export * from "./get-console-ids-response.model";
-export * from "./get-game-list-response.model";
+export * from "./console-id.model";
+export * from "./game-list.model";
+export * from "./get-console-ids-response.model";
+export * from "./get-game-list-response.model";

package/dist/feed/getAchievementOfTheWeek.d.ts

@@ -1,48 +1,48 @@
-import type { AuthObject } from "../utils/public";
-import type { AchievementOfTheWeek } from "./models";
-/**
- * A call to this function will retrieve comprehensive
- * metadata about the current Achievement of the Week.
- *
- * @param authorization An object containing your userName and webApiKey.
- * This can be constructed with `buildAuthorization()`.
- *
- * @example
- * ```
- * const achievementOfTheWeek = await getAchievementOfTheWeek(
- *   authorization
- * );
- * ```
- *
- * @returns An object containing comprehensive metadata
- * about the current Achievement of the Week.
- * ```
- * {
- *   achievement: {
- *     id: "165062",
- *     title: "The True Hero",
- *     description: "Receive any Ending as Han [Normal or Hard]",
- *     points: "10",
- *     trueRatio: "22",
- *     author: "BigWeedSmokerMan",
- *     dateCreated: "2021-08-08 17:47:46",
- *     dateModified: "2021-08-09 12:20:05"
- *   },
- *   console: { id: "39", title: "Saturn" },
- *   forumTopic: { id: "14767" },
- *   game: { id: "14513", title: "Guardian Heroes" },
- *   startAt: "2022-10-10 00:00:00",
- *   totalPlayers: "219",
- *   unlocks: [
- *     {
- *       user: "Tirbaba2",
- *       rAPoints: "72",
- *       dateAwarded: "2022-10-10 01:42:19",
- *       hardcoreMode: "1"
- *     }
- *   ],
- *   unlocksCount: "40"
- * }
- * ```
- */
-export declare const getAchievementOfTheWeek: (authorization: AuthObject) => Promise<AchievementOfTheWeek>;
+import type { AuthObject } from "../utils/public";
+import type { AchievementOfTheWeek } from "./models";
+/**
+ * A call to this function will retrieve comprehensive
+ * metadata about the current Achievement of the Week.
+ *
+ * @param authorization An object containing your userName and webApiKey.
+ * This can be constructed with `buildAuthorization()`.
+ *
+ * @example
+ * ```
+ * const achievementOfTheWeek = await getAchievementOfTheWeek(
+ *   authorization
+ * );
+ * ```
+ *
+ * @returns An object containing comprehensive metadata
+ * about the current Achievement of the Week.
+ * ```
+ * {
+ *   achievement: {
+ *     id: "165062",
+ *     title: "The True Hero",
+ *     description: "Receive any Ending as Han [Normal or Hard]",
+ *     points: "10",
+ *     trueRatio: "22",
+ *     author: "BigWeedSmokerMan",
+ *     dateCreated: "2021-08-08 17:47:46",
+ *     dateModified: "2021-08-09 12:20:05"
+ *   },
+ *   console: { id: "39", title: "Saturn" },
+ *   forumTopic: { id: "14767" },
+ *   game: { id: "14513", title: "Guardian Heroes" },
+ *   startAt: "2022-10-10 00:00:00",
+ *   totalPlayers: "219",
+ *   unlocks: [
+ *     {
+ *       user: "Tirbaba2",
+ *       rAPoints: "72",
+ *       dateAwarded: "2022-10-10 01:42:19",
+ *       hardcoreMode: "1"
+ *     }
+ *   ],
+ *   unlocksCount: "40"
+ * }
+ * ```
+ */
+export declare const getAchievementOfTheWeek: (authorization: AuthObject) => Promise<AchievementOfTheWeek>;

package/dist/feed/getAchievementOfTheWeek.test.d.ts

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

package/dist/feed/getActiveClaims.d.ts

@@ -1,40 +1,40 @@
-import type { AuthObject } from "../utils/public";
-import type { SetClaim } from "./models";
-/**
- * A call to this function returns information about all
- * (1000 max) active set claims.
- *
- * @param authorization An object containing your userName and webApiKey.
- * This can be constructed with `buildAuthorization()`.
- *
- * @example
- * ```
- * const activeClaims = await getActiveClaims(authorization);
- * ```
- *
- * @returns An array containing metadata about all active claims.
- * ```
- * [
- *   {
- *     id: 7044,
- *     user: "blendedsea",
- *     gameId: 19212,
- *     gameTitle: "SpongeBob SquarePants: Battle for Bikini Bottom",
- *     gameIcon: "/Images/059776.png",
- *     consoleName: "PlayStation 2",
- *     consoleId: 22,
- *     claimType: 0,
- *     setType: 0,
- *     status: 0,
- *     extension: 0,
- *     special: 0,
- *     created: "2022-10-04 00:25:06",
- *     doneTime: "2023-01-04 00:25:06",
- *     updated: "2022-10-04 00:25:06",
- *     minutesLeft: 112523,
- *     userIsJrDev: false
- *   }
- * ]
- * ```
- */
-export declare const getActiveClaims: (authorization: AuthObject) => Promise<SetClaim[]>;
+import type { AuthObject } from "../utils/public";
+import type { SetClaim } from "./models";
+/**
+ * A call to this function returns information about all
+ * (1000 max) active set claims.
+ *
+ * @param authorization An object containing your userName and webApiKey.
+ * This can be constructed with `buildAuthorization()`.
+ *
+ * @example
+ * ```
+ * const activeClaims = await getActiveClaims(authorization);
+ * ```
+ *
+ * @returns An array containing metadata about all active claims.
+ * ```
+ * [
+ *   {
+ *     id: 7044,
+ *     user: "blendedsea",
+ *     gameId: 19212,
+ *     gameTitle: "SpongeBob SquarePants: Battle for Bikini Bottom",
+ *     gameIcon: "/Images/059776.png",
+ *     consoleName: "PlayStation 2",
+ *     consoleId: 22,
+ *     claimType: 0,
+ *     setType: 0,
+ *     status: 0,
+ *     extension: 0,
+ *     special: 0,
+ *     created: "2022-10-04 00:25:06",
+ *     doneTime: "2023-01-04 00:25:06",
+ *     updated: "2022-10-04 00:25:06",
+ *     minutesLeft: 112523,
+ *     userIsJrDev: false
+ *   }
+ * ]
+ * ```
+ */
+export declare const getActiveClaims: (authorization: AuthObject) => Promise<SetClaim[]>;

package/dist/feed/getActiveClaims.test.d.ts

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

package/dist/feed/getClaims.d.ts

@@ -1,7 +1,7 @@
-import type { AuthObject } from "../utils/public";
-import type { SetClaim } from "./models";
-type ClaimKind = "completed" | "dropped" | "expired";
-export declare const getClaims: (authorization: AuthObject, payload: {
-    claimKind: ClaimKind;
-}) => Promise<SetClaim[]>;
-export {};
+import type { AuthObject } from "../utils/public";
+import type { SetClaim } from "./models";
+type ClaimKind = "completed" | "dropped" | "expired";
+export declare const getClaims: (authorization: AuthObject, payload: {
+    claimKind: ClaimKind;
+}) => Promise<SetClaim[]>;
+export {};

package/dist/feed/getClaims.test.d.ts

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

package/dist/feed/getTopTenUsers.d.ts

@@ -1,24 +1,24 @@
-import type { AuthObject } from "../utils/public";
-import type { TopTenUsers } from "./models";
-/**
- * A call to this function will retrieve the current top ten users
- * on the site.
- *
- * @param authorization An object containing your userName and webApiKey.
- * This can be constructed with `buildAuthorization()`.
- *
- * @example
- * ```
- * const topTenUsers = await getTopTenUsers(authorization);
- * ```
- *
- * @returns An array containing the list of top ten users.
- * ```json
- * [
- *   { userName: "MockUser", totalPoints: 350000, totalRatioPoints: 995000 },
- *   { userName: "MockUser2", totalPoints: 345000, totalRatioPoints: 994000 },
- *   // ...
- * ]
- * ```
- */
-export declare const getTopTenUsers: (authorization: AuthObject) => Promise<TopTenUsers>;
+import type { AuthObject } from "../utils/public";
+import type { TopTenUsers } from "./models";
+/**
+ * A call to this function will retrieve the current top ten users
+ * on the site.
+ *
+ * @param authorization An object containing your userName and webApiKey.
+ * This can be constructed with `buildAuthorization()`.
+ *
+ * @example
+ * ```
+ * const topTenUsers = await getTopTenUsers(authorization);
+ * ```
+ *
+ * @returns An array containing the list of top ten users.
+ * ```json
+ * [
+ *   { userName: "MockUser", totalPoints: 350000, totalRatioPoints: 995000 },
+ *   { userName: "MockUser2", totalPoints: 345000, totalRatioPoints: 994000 },
+ *   // ...
+ * ]
+ * ```
+ */
+export declare const getTopTenUsers: (authorization: AuthObject) => Promise<TopTenUsers>;

package/dist/feed/getTopTenUsers.test.d.ts

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

package/dist/feed/index.d.ts

@@ -1,5 +1,5 @@
-export * from "./getAchievementOfTheWeek";
-export * from "./getActiveClaims";
-export * from "./getClaims";
-export * from "./getTopTenUsers";
-export * from "./models";
+export * from "./getAchievementOfTheWeek";
+export * from "./getActiveClaims";
+export * from "./getClaims";
+export * from "./getTopTenUsers";
+export * from "./models";

package/dist/feed/models/achievement-of-the-week.model.d.ts

@@ -1,32 +1,32 @@
-export interface AchievementOfTheWeek {
-    achievement: {
-        id: number;
-        title: string;
-        description: string;
-        points: number;
-        trueRatio: number;
-        author: string;
-        dateCreated: string;
-        dateModified: string;
-    };
-    console: {
-        id: number;
-        title: string;
-    };
-    forumTopic: {
-        id: number;
-    };
-    game: {
-        id: number;
-        title: string;
-    };
-    startAt: string;
-    totalPlayers: number;
-    unlocks: Array<{
-        user: string;
-        raPoints: number;
-        dateAwarded: string;
-        hardcoreMode: boolean;
-    }>;
-    unlocksCount: number;
-}
+export interface AchievementOfTheWeek {
+    achievement: {
+        id: number;
+        title: string;
+        description: string;
+        points: number;
+        trueRatio: number;
+        author: string;
+        dateCreated: string;
+        dateModified: string;
+    };
+    console: {
+        id: number;
+        title: string;
+    };
+    forumTopic: {
+        id: number;
+    };
+    game: {
+        id: number;
+        title: string;
+    };
+    startAt: string;
+    totalPlayers: number;
+    unlocks: Array<{
+        user: string;
+        raPoints: number;
+        dateAwarded: string;
+        hardcoreMode: boolean;
+    }>;
+    unlocksCount: number;
+}

package/dist/feed/models/claim-set-type.enum.d.ts

@@ -1,4 +1,4 @@
-export declare enum ClaimSetType {
-    NewSet = 0,
-    Revision = 1
-}
+export declare enum ClaimSetType {
+    NewSet = 0,
+    Revision = 1
+}

package/dist/feed/models/claim-status.enum.d.ts

@@ -1,5 +1,5 @@
-export declare enum ClaimStatus {
-    Active = 0,
-    Complete = 1,
-    Dropped = 2
-}
+export declare enum ClaimStatus {
+    Active = 0,
+    Complete = 1,
+    Dropped = 2
+}

package/dist/feed/models/claim-type.enum.d.ts

@@ -1,4 +1,4 @@
-export declare enum ClaimType {
-    Primary = 0,
-    Collaboration = 1
-}
+export declare enum ClaimType {
+    Primary = 0,
+    Collaboration = 1
+}

package/dist/feed/models/get-achievement-of-the-week-response.model.d.ts

@@ -1,32 +1,32 @@
-export interface GetAchievementOfTheWeekResponse {
-    Achievement: {
-        ID: string;
-        Title: string;
-        Description: string;
-        Points: string;
-        TrueRatio: string;
-        Author: string;
-        DateCreated: string;
-        DateModified: string;
-    };
-    Console: {
-        ID: string;
-        Title: string;
-    };
-    ForumTopic: {
-        ID: string;
-    };
-    Game: {
-        ID: string;
-        Title: string;
-    };
-    StartAt: string;
-    TotalPlayers: string;
-    Unlocks: Array<{
-        User: string;
-        RAPoints: string;
-        DateAwarded: string;
-        HardcoreMode: string;
-    }>;
-    UnlocksCount: string;
-}
+export interface GetAchievementOfTheWeekResponse {
+    Achievement: {
+        ID: string;
+        Title: string;
+        Description: string;
+        Points: string;
+        TrueRatio: string;
+        Author: string;
+        DateCreated: string;
+        DateModified: string;
+    };
+    Console: {
+        ID: string;
+        Title: string;
+    };
+    ForumTopic: {
+        ID: string;
+    };
+    Game: {
+        ID: string;
+        Title: string;
+    };
+    StartAt: string;
+    TotalPlayers: string;
+    Unlocks: Array<{
+        User: string;
+        RAPoints: string;
+        DateAwarded: string;
+        HardcoreMode: string;
+    }>;
+    UnlocksCount: string;
+}

package/dist/feed/models/get-set-claims-response.model.d.ts

@@ -1,21 +1,21 @@
-interface SetClaimResponseEntity {
-    ID: number;
-    User: string;
-    GameID: number;
-    GameTitle: string;
-    GameIcon: string;
-    ConsoleName: string;
-    ConsoleID: number;
-    ClaimType: number;
-    SetType: number;
-    Status: number;
-    Extension: number;
-    Special: number;
-    Created: string;
-    DoneTime: string;
-    Updated: string;
-    MinutesLeft: number;
-    UserIsJrDev: 0 | 1;
-}
-export type GetSetClaimsResponse = SetClaimResponseEntity[];
-export {};
+interface SetClaimResponseEntity {
+    ID: number;
+    User: string;
+    GameID: number;
+    GameTitle: string;
+    GameIcon: string;
+    ConsoleName: string;
+    ConsoleID: number;
+    ClaimType: number;
+    SetType: number;
+    Status: number;
+    Extension: number;
+    Special: number;
+    Created: string;
+    DoneTime: string;
+    Updated: string;
+    MinutesLeft: number;
+    UserIsJrDev: 0 | 1;
+}
+export type GetSetClaimsResponse = SetClaimResponseEntity[];
+export {};

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

@@ -1,10 +1,10 @@
-interface TopTenUsersResponseEntity {
-    /** Username */
-    "1": string;
-    /** Total points earned by the user */
-    "2": string;
-    /** Total ratio (white) points earned by the user  */
-    "3": string;
-}
-export type GetTopTenUsersResponse = TopTenUsersResponseEntity[];
-export {};
+interface TopTenUsersResponseEntity {
+    /** Username */
+    "1": string;
+    /** Total points earned by the user */
+    "2": string;
+    /** Total ratio (white) points earned by the user  */
+    "3": string;
+}
+export type GetTopTenUsersResponse = TopTenUsersResponseEntity[];
+export {};

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

@@ -1,10 +1,10 @@
-export * from "./achievement-of-the-week.model";
-export * from "./claim-set-type.enum";
-export * from "./claim-status.enum";
-export * from "./claim-type.enum";
-export * from "./get-achievement-of-the-week-response.model";
-export * from "./get-set-claims-response.model";
-export * from "./get-top-ten-users-response.model";
-export * from "./set-claim.model";
-export * from "./top-ten-users.model";
-export * from "./top-ten-users-entity.model";
+export * from "./achievement-of-the-week.model";
+export * from "./claim-set-type.enum";
+export * from "./claim-status.enum";
+export * from "./claim-type.enum";
+export * from "./get-achievement-of-the-week-response.model";
+export * from "./get-set-claims-response.model";
+export * from "./get-top-ten-users-response.model";
+export * from "./set-claim.model";
+export * from "./top-ten-users.model";
+export * from "./top-ten-users-entity.model";