@retroachievements/api 2.7.0 → 2.9.0

package/dist/game/getGameProgression.d.ts

@@ -0,0 +1,83 @@
+import type { ID } from "../utils/internal";
+import type { AuthObject } from "../utils/public";
+import type { GameProgression } from "./models";
+/**
+ * A call to this function will retrieve information about the average time to unlock achievements in a game.
+ *
+ * @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.hardcore Optional. If set to true, the player sampling
+ * for median calculations will prefer players based on their hardcore
+ * unlock count rather than their total unlock count.
+ *
+ * @example
+ * ```
+ * const game = await getGameProgression(
+ *   authorization,
+ *   { gameId: 14402, hardcore: true }
+ * );
+ * ```
+ *
+ * @returns An object containing information about the average time to unlock achievements in a game.
+ * ```json
+ * {
+ *   "id": 228,
+ *   "title": "Super Mario World",
+ *   "consoleId": 3,
+ *   "consoleName": "SNES/Super Famicom",
+ *   "imageIcon": "/Images/112443.png",
+ *   "numDistinctPlayers": 79281,
+ *   "timesUsedInBeatMedian": 4493,
+ *   "timesUsedInHardcoreBeatMedian": 8249,
+ *   "medianTimeToBeat": 17878,
+ *   "medianTimeToBeatHardcore": 19224,
+ *   "timesUsedInCompletionMedian": 155,
+ *   "timesUsedInMasteryMedian": 1091,
+ *   "medianTimeToComplete": 67017,
+ *   "medianTimeToMaster": 79744,
+ *   "numAchievements": 89,
+ *   "achievements": [
+ *     {
+ *       "id": 342,
+ *       "title": "Giddy Up!",
+ *       "description": "Catch a ride with a friend",
+ *       "points": 1,
+ *       "trueRatio": 1,
+ *       "type": null,
+ *       "badgeName": "46580",
+ *       "numAwarded": 75168,
+ *       "numAwardedHardcore": 37024,
+ *       "timesUsedInUnlockMedian": 63,
+ *       "timesUsedInHardcoreUnlockMedian": 69,
+ *       "medianTimeToUnlock": 274,
+ *       "medianTimeToUnlockHardcore": 323
+ *     },
+ *     {
+ *       "id": 341,
+ *       "title": "Unleash The Dragon",
+ *       "description": "Collect 5 Dragon Coins in a level",
+ *       "points": 2,
+ *       "trueRatio": 2,
+ *       "type": null,
+ *       "badgeName": "46591",
+ *       "numAwarded": 66647,
+ *       "numAwardedHardcore": 34051,
+ *       "timesUsedInUnlockMedian": 66,
+ *       "timesUsedInHardcoreUnlockMedian": 70,
+ *       "medianTimeToUnlock": 290,
+ *       "medianTimeToUnlockHardcore": 333
+ *     }
+ *   ]
+ * }
+ * ```
+ */
+export declare const getGameProgression: (authorization: AuthObject, payload: {
+    gameId: ID;
+    hardcore?: boolean;
+}) => Promise<GameProgression>;

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

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

package/dist/game/index.d.ts

@@ -3,6 +3,7 @@ export * from "./getAchievementDistribution";
 export * from "./getGame";
 export * from "./getGameExtended";
 export * from "./getGameHashes";
+export * from "./getGameProgression";
 export * from "./getGameRankAndScore";
 export * from "./getGameRating";
 export * from "./models";

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

@@ -0,0 +1,32 @@
+export interface GameProgression {
+    id: number;
+    title: string;
+    consoleId: number;
+    consoleName: string;
+    imageIcon: string;
+    numDistinctPlayers: number;
+    timesUsedInBeatMedian: number;
+    timesUsedInHardcoreBeatMedian: number;
+    medianTimeToBeat: number | null;
+    medianTimeToBeatHardcore: number | null;
+    timesUsedInCompletionMedian: number;
+    timesUsedInMasteryMedian: number;
+    medianTimeToComplete: number | null;
+    medianTimeToMaster: number | null;
+    numAchievements: number;
+    achievements: Array<{
+        id: number;
+        title: string;
+        description: string;
+        points: number;
+        trueRatio: number;
+        type: string | null;
+        badgeName: string;
+        numAwarded: number;
+        numAwardedHardcore: number;
+        timesUsedInUnlockMedian: number;
+        timesUsedInHardcoreUnlockMedian: number;
+        medianTimeToUnlock: number;
+        medianTimeToUnlockHardcore: number;
+    }>;
+}

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

@@ -0,0 +1,32 @@
+export interface GetGameProgressionResponse {
+    ID: number;
+    Title: string;
+    ConsoleID: number;
+    ConsoleName: string;
+    ImageIcon: string;
+    NumDistinctPlayers: number;
+    TimesUsedInBeatMedian: number;
+    TimesUsedInHardcoreBeatMedian: number;
+    MedianTimeToBeat: number | null;
+    MedianTimeToBeatHardcore: number | null;
+    TimesUsedInCompletionMedian: number;
+    TimesUsedInMasteryMedian: number;
+    MedianTimeToComplete: number | null;
+    MedianTimeToMaster: number | null;
+    NumAchievements: number;
+    Achievements: Array<{
+        ID: number;
+        Title: string;
+        Description: string;
+        Points: number;
+        TrueRatio: number;
+        Type: string | null;
+        BadgeName: string;
+        NumAwarded: number;
+        NumAwardedHardcore: number;
+        TimesUsedInUnlockMedian: number;
+        TimesUsedInHardcoreUnlockMedian: number;
+        MedianTimeToUnlock: number;
+        MedianTimeToUnlockHardcore: number;
+    }>;
+}

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

@@ -5,12 +5,14 @@ export * from "./game-extended.model";
 export * from "./game-extended-achievement-entity.model";
 export * from "./game-extended-claim-entity.model";
 export * from "./game-hashes.model";
+export * from "./game-progression.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-hashes-response.model";
+export * from "./get-game-progression-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/leaderboard/getUserGameLeaderboards.d.ts

@@ -48,7 +48,7 @@ import type { UserGameLeaderboards } from "./models";
  */
 export declare const getUserGameLeaderboards: (authorization: AuthObject, payload: {
     gameId: ID;
-    username?: string;
+    username: string;
     offset?: number;
     count?: number;
 }) => Promise<UserGameLeaderboards>;

package/dist/leaderboard/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./getLeaderboardEntries";
+export * from "./getUserGameLeaderboards";
 export * from "./models";

package/dist/user/getUsersIFollow.d.ts

@@ -0,0 +1,46 @@
+import type { AuthObject } from "../utils/public";
+import type { UsersIFollow } from "./models";
+/**
+ * A call to this function will retrieve the list of users that the
+ * caller is following.
+ *
+ * @param authorization An object containing your username and webApiKey.
+ * This can be constructed with `buildAuthorization()`.
+ *
+ * @param payload.offset The number of entries to skip. The API will default
+ * to 0 if the parameter is not specified.
+ *
+ * @param payload.count The number of entries to return. The API will
+ * default to 100 if the parameter is not specified. The max number
+ * of entries that can be returned is 500.
+ *
+ * @example
+ * ```
+ * const usersIFollow = await getUsersIFollow(authorization);
+ * ```
+ *
+ * @returns An object containing a list of users that the caller is
+ * following.
+ * ```json
+ * {
+ *   "count": 1,
+ *   "total": 1,
+ *   "results": [
+ *     {
+ *       "user": "Example",
+ *       "ulid": "0123456789ABCDEFGHIJKLMNO",
+ *       "points": 9001,
+ *       "pointsSoftcore": 101,
+ *       "isFollowingMe": false
+ *     }
+ *   ]
+ * }
+ * ```
+ *
+ * @throws If the API was given invalid parameters (422) or if the
+ * API is currently down (503).
+ */
+export declare const getUsersIFollow: (authorization: AuthObject, payload?: {
+    offset?: number;
+    count?: number;
+}) => Promise<UsersIFollow>;

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

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

package/dist/user/index.d.ts

@@ -11,6 +11,7 @@ export * from "./getUserProfile";
 export * from "./getUserProgress";
 export * from "./getUserRecentAchievements";
 export * from "./getUserRecentlyPlayedGames";
+export * from "./getUsersIFollow";
 export * from "./getUserSummary";
 export * from "./getUserWantToPlayList";
 export * from "./models";

package/dist/user/models/get-users-i-follow-response.model.d.ts

@@ -0,0 +1,11 @@
+export interface GetUsersIFollowResponse {
+    Count: number;
+    Total: number;
+    Results: Array<{
+        User: string;
+        ULID: string;
+        Points: number;
+        PointsSoftcore: number;
+        IsFollowingMe: boolean;
+    }>;
+}

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

@@ -14,6 +14,7 @@ export * from "./get-user-recent-achievements-response.model";
 export * from "./get-user-recently-played-games-response.model";
 export * from "./get-user-summary-response.model";
 export * from "./get-user-want-to-play-list-response.model";
+export * from "./get-users-i-follow-response.model";
 export * from "./user-awards.model";
 export * from "./user-claims.model";
 export * from "./user-claims-response.model";
@@ -28,3 +29,4 @@ export * from "./user-recent-achievement.model";
 export * from "./user-recently-played-games.model";
 export * from "./user-summary.model";
 export * from "./user-want-to-play-list.model";
+export * from "./users-i-follow.model";

package/dist/user/models/users-i-follow.model.d.ts

@@ -0,0 +1,11 @@
+export interface UsersIFollow {
+    count: number;
+    total: number;
+    results: Array<{
+        user: string;
+        ulid: string;
+        points: number;
+        pointsSoftcore: number;
+        isFollowingMe: boolean;
+    }>;
+}

package/package.json

@@ -10,7 +10,7 @@
     "raweb",
     "retro gaming"
   ],
-  "version": "2.7.0",
+  "version": "2.9.0",
   "typings": "dist/index.d.ts",
   "exports": {
     ".": {

package/src/game/getGameProgression.test.ts

@@ -0,0 +1,114 @@
+/* eslint-disable sonarjs/no-duplicate-string */
+
+import { http, HttpResponse } from "msw";
+import { setupServer } from "msw/node";
+
+import { apiBaseUrl } from "../utils/internal";
+import { buildAuthorization } from "../utils/public";
+import { getGameProgression } from "./getGameProgression";
+import type { GetGameProgressionResponse } from "./models";
+
+const server = setupServer();
+
+describe("Function: getGameProgression", () => {
+  // MSW Setup
+  beforeAll(() => server.listen());
+  afterEach(() => server.resetHandlers());
+  afterAll(() => server.close());
+
+  it("is defined #sanity", () => {
+    // ASSERT
+    expect(getGameProgression).toBeDefined();
+  });
+
+  it("given a game ID, retrieves information about the average time to unlock achievements in a game", async () => {
+    // ARRANGE
+    const authorization = buildAuthorization({
+      username: "mockUserName",
+      webApiKey: "mockWebApiKey",
+    });
+
+    const mockResponse: GetGameProgressionResponse = {
+      ID: 228,
+      Title: "Super Mario World",
+      ConsoleID: 3,
+      ConsoleName: "SNES/Super Famicom",
+      ImageIcon: "/Images/112443.png",
+      NumDistinctPlayers: 79_281,
+      TimesUsedInBeatMedian: 4493,
+      TimesUsedInHardcoreBeatMedian: 8249,
+      MedianTimeToBeat: 17_878,
+      MedianTimeToBeatHardcore: 19_224,
+      TimesUsedInCompletionMedian: 155,
+      TimesUsedInMasteryMedian: 1091,
+      MedianTimeToComplete: 67_017,
+      MedianTimeToMaster: 79_744,
+      NumAchievements: 89,
+      Achievements: [
+        {
+          ID: 342,
+          Title: "Giddy Up!",
+          Description: "Catch a ride with a friend",
+          Points: 1,
+          TrueRatio: 1,
+          Type: null,
+          BadgeName: "46580",
+          NumAwarded: 75_168,
+          NumAwardedHardcore: 37_024,
+          TimesUsedInUnlockMedian: 63,
+          TimesUsedInHardcoreUnlockMedian: 69,
+          MedianTimeToUnlock: 274,
+          MedianTimeToUnlockHardcore: 323,
+        },
+      ],
+    };
+
+    server.use(
+      http.get(`${apiBaseUrl}/API_GetGameProgression.php`, () =>
+        HttpResponse.json(mockResponse)
+      )
+    );
+
+    // ACT
+    const response = await getGameProgression(authorization, {
+      gameId: 104_370,
+      hardcore: true,
+    });
+
+    // ASSERT
+    expect(response).toEqual({
+      id: 228,
+      title: "Super Mario World",
+      consoleId: 3,
+      consoleName: "SNES/Super Famicom",
+      imageIcon: "/Images/112443.png",
+      numDistinctPlayers: 79_281,
+      timesUsedInBeatMedian: 4493,
+      timesUsedInHardcoreBeatMedian: 8249,
+      medianTimeToBeat: 17_878,
+      medianTimeToBeatHardcore: 19_224,
+      timesUsedInCompletionMedian: 155,
+      timesUsedInMasteryMedian: 1091,
+      medianTimeToComplete: 67_017,
+      medianTimeToMaster: 79_744,
+      numAchievements: 89,
+      achievements: [
+        {
+          id: 342,
+          title: "Giddy Up!",
+          description: "Catch a ride with a friend",
+          points: 1,
+          trueRatio: 1,
+          type: null,
+          badgeName: "46580",
+          numAwarded: 75_168,
+          numAwardedHardcore: 37_024,
+          timesUsedInUnlockMedian: 63,
+          timesUsedInHardcoreUnlockMedian: 69,
+          medianTimeToUnlock: 274,
+          medianTimeToUnlockHardcore: 323,
+        },
+      ],
+    });
+  });
+});

package/src/game/getGameProgression.ts

@@ -0,0 +1,112 @@
+import type { ID } from "../utils/internal";
+import {
+  apiBaseUrl,
+  buildRequestUrl,
+  call,
+  serializeProperties,
+} from "../utils/internal";
+import type { AuthObject } from "../utils/public";
+import type { GameProgression, GetGameProgressionResponse } from "./models";
+
+/**
+ * A call to this function will retrieve information about the average time to unlock achievements in a game.
+ *
+ * @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.hardcore Optional. If set to true, the player sampling
+ * for median calculations will prefer players based on their hardcore
+ * unlock count rather than their total unlock count.
+ *
+ * @example
+ * ```
+ * const game = await getGameProgression(
+ *   authorization,
+ *   { gameId: 14402, hardcore: true }
+ * );
+ * ```
+ *
+ * @returns An object containing information about the average time to unlock achievements in a game.
+ * ```json
+ * {
+ *   "id": 228,
+ *   "title": "Super Mario World",
+ *   "consoleId": 3,
+ *   "consoleName": "SNES/Super Famicom",
+ *   "imageIcon": "/Images/112443.png",
+ *   "numDistinctPlayers": 79281,
+ *   "timesUsedInBeatMedian": 4493,
+ *   "timesUsedInHardcoreBeatMedian": 8249,
+ *   "medianTimeToBeat": 17878,
+ *   "medianTimeToBeatHardcore": 19224,
+ *   "timesUsedInCompletionMedian": 155,
+ *   "timesUsedInMasteryMedian": 1091,
+ *   "medianTimeToComplete": 67017,
+ *   "medianTimeToMaster": 79744,
+ *   "numAchievements": 89,
+ *   "achievements": [
+ *     {
+ *       "id": 342,
+ *       "title": "Giddy Up!",
+ *       "description": "Catch a ride with a friend",
+ *       "points": 1,
+ *       "trueRatio": 1,
+ *       "type": null,
+ *       "badgeName": "46580",
+ *       "numAwarded": 75168,
+ *       "numAwardedHardcore": 37024,
+ *       "timesUsedInUnlockMedian": 63,
+ *       "timesUsedInHardcoreUnlockMedian": 69,
+ *       "medianTimeToUnlock": 274,
+ *       "medianTimeToUnlockHardcore": 323
+ *     },
+ *     {
+ *       "id": 341,
+ *       "title": "Unleash The Dragon",
+ *       "description": "Collect 5 Dragon Coins in a level",
+ *       "points": 2,
+ *       "trueRatio": 2,
+ *       "type": null,
+ *       "badgeName": "46591",
+ *       "numAwarded": 66647,
+ *       "numAwardedHardcore": 34051,
+ *       "timesUsedInUnlockMedian": 66,
+ *       "timesUsedInHardcoreUnlockMedian": 70,
+ *       "medianTimeToUnlock": 290,
+ *       "medianTimeToUnlockHardcore": 333
+ *     }
+ *   ]
+ * }
+ * ```
+ */
+export const getGameProgression = async (
+  authorization: AuthObject,
+  payload: {
+    gameId: ID;
+    hardcore?: boolean;
+  }
+): Promise<GameProgression> => {
+  const { gameId, hardcore } = payload;
+
+  const queryParams: Record<string, any> = { i: gameId };
+
+  if (hardcore !== undefined) {
+    queryParams["h"] = hardcore === true ? 1 : 0;
+  }
+
+  const url = buildRequestUrl(
+    apiBaseUrl,
+    "/API_GetGameProgression.php",
+    authorization,
+    queryParams
+  );
+
+  const rawResponse = await call<GetGameProgressionResponse>({ url });
+
+  return serializeProperties(rawResponse);
+};

package/src/game/index.ts

@@ -3,6 +3,7 @@ export * from "./getAchievementDistribution";
 export * from "./getGame";
 export * from "./getGameExtended";
 export * from "./getGameHashes";
+export * from "./getGameProgression";
 export * from "./getGameRankAndScore";
 export * from "./getGameRating";
 export * from "./models";

package/src/game/models/game-progression.model.ts

@@ -0,0 +1,32 @@
+export interface GameProgression {
+  id: number;
+  title: string;
+  consoleId: number;
+  consoleName: string;
+  imageIcon: string;
+  numDistinctPlayers: number;
+  timesUsedInBeatMedian: number;
+  timesUsedInHardcoreBeatMedian: number;
+  medianTimeToBeat: number | null;
+  medianTimeToBeatHardcore: number | null;
+  timesUsedInCompletionMedian: number;
+  timesUsedInMasteryMedian: number;
+  medianTimeToComplete: number | null;
+  medianTimeToMaster: number | null;
+  numAchievements: number;
+  achievements: Array<{
+    id: number;
+    title: string;
+    description: string;
+    points: number;
+    trueRatio: number;
+    type: string | null;
+    badgeName: string;
+    numAwarded: number;
+    numAwardedHardcore: number;
+    timesUsedInUnlockMedian: number;
+    timesUsedInHardcoreUnlockMedian: number;
+    medianTimeToUnlock: number;
+    medianTimeToUnlockHardcore: number;
+  }>;
+}

package/src/game/models/get-game-progression-response.model.ts

@@ -0,0 +1,32 @@
+export interface GetGameProgressionResponse {
+  ID: number;
+  Title: string;
+  ConsoleID: number;
+  ConsoleName: string;
+  ImageIcon: string;
+  NumDistinctPlayers: number;
+  TimesUsedInBeatMedian: number;
+  TimesUsedInHardcoreBeatMedian: number;
+  MedianTimeToBeat: number | null;
+  MedianTimeToBeatHardcore: number | null;
+  TimesUsedInCompletionMedian: number;
+  TimesUsedInMasteryMedian: number;
+  MedianTimeToComplete: number | null;
+  MedianTimeToMaster: number | null;
+  NumAchievements: number;
+  Achievements: Array<{
+    ID: number;
+    Title: string;
+    Description: string;
+    Points: number;
+    TrueRatio: number;
+    Type: string | null;
+    BadgeName: string;
+    NumAwarded: number;
+    NumAwardedHardcore: number;
+    TimesUsedInUnlockMedian: number;
+    TimesUsedInHardcoreUnlockMedian: number;
+    MedianTimeToUnlock: number;
+    MedianTimeToUnlockHardcore: number;
+  }>;
+}

package/src/game/models/index.ts

@@ -5,12 +5,14 @@ export * from "./game-extended.model";
 export * from "./game-extended-achievement-entity.model";
 export * from "./game-extended-claim-entity.model";
 export * from "./game-hashes.model";
+export * from "./game-progression.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-hashes-response.model";
+export * from "./get-game-progression-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/src/leaderboard/getUserGameLeaderboards.ts

@@ -58,13 +58,11 @@ import type {
  */
 export const getUserGameLeaderboards = async (
   authorization: AuthObject,
-  payload: { gameId: ID; username?: string; offset?: number; count?: number }
+  payload: { gameId: ID; username: string; offset?: number; count?: number }
 ): Promise<UserGameLeaderboards> => {
   const queryParams: Record<string, any> = {};
   queryParams.i = payload.gameId;
-  if (payload?.username) {
-    queryParams.u = payload.username;
-  }
+  queryParams.u = payload.username;
   if (payload?.offset) {
     queryParams.o = payload.offset;
   }

package/src/leaderboard/index.ts

@@ -1,2 +1,3 @@
 export * from "./getLeaderboardEntries";
+export * from "./getUserGameLeaderboards";
 export * from "./models";