@retroachievements/api 2.9.1 → 2.10.0

package/dist/user/getUserSetRequests.d.ts

@@ -0,0 +1,54 @@
+import type { AuthObject } from "../utils/public";
+import type { RequestListType, UserSetRequests } from "./models";
+/**
+ * A call to this function will retrieve a given user's set requests.
+ *
+ * @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 set requests
+ * for.
+ *
+ * @param payload.requestListType An optional parameter to filter set requests
+ * by their current status. If omitted, the API will return only active
+ * requests.
+ *
+ * @example
+ * ```
+ * const userSetRequests = await getUserSetRequests(authorization, {
+ *   username: "ExampleUser"
+ * });
+ * ```
+ *
+ * @returns An object containing a list of requested sets that the
+ * given user made.
+ * ```json
+ * {
+ *   "requestedSets": [
+ *     {
+ *       "gameId": 8149,
+ *       "title": "Example Set 1",
+ *       "consoleId": 0,
+ *       "consoleName": "Example Console",
+ *       "imageIcon": "/Images/000001.png"
+ *     },
+ *     {
+ *       "gameId": 9001,
+ *       "title": "Example Set 2",
+ *       "consoleId": 2,
+ *       "consoleName": "Example Console 2",
+ *       "imageIcon": "/Images/000002.png"
+ *     }
+ *   ],
+ *   "totalRequests": 5,
+ *   "pointsForNext": 5000
+ * }
+ * ```
+ *
+ * @throws If the API was given invalid parameters (422) or if the
+ * API is currently down (503).
+ */
+export declare const getUserSetRequests: (authorization: AuthObject, payload: {
+    username: string;
+    requestListType?: RequestListType;
+}) => Promise<UserSetRequests>;

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

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

package/dist/user/getUsersFollowingMe.d.ts

@@ -0,0 +1,46 @@
+import type { AuthObject } from "../utils/public";
+import type { UsersFollowingMe } from "./models";
+/**
+ * A call to this function will retrieve the list of users that are
+ * following the caller.
+ *
+ * @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 usersFollowingMe = await getUsersFollowingMe(authorization);
+ * ```
+ *
+ * @returns An object containing a list of users that are following
+ * the caller.
+ * ```json
+ * {
+ *   "count": 1,
+ *   "total": 1,
+ *   "results": [
+ *     {
+ *       "user": "Example",
+ *       "ulid": "0123456789ABCDEFGHIJKLMNO",
+ *       "points": 9001,
+ *       "pointsSoftcore": 101,
+ *       "amIFollowing": true
+ *     }
+ *   ]
+ * }
+ * ```
+ *
+ * @throws If the API was given invalid parameters (422) or if the
+ * API is currently down (503).
+ */
+export declare const getUsersFollowingMe: (authorization: AuthObject, payload?: {
+    offset?: number;
+    count?: number;
+}) => Promise<UsersFollowingMe>;

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

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

package/dist/user/index.d.ts

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

package/dist/user/models/get-user-set-requests-response.model.d.ts

@@ -0,0 +1,11 @@
+export interface GetUserSetRequestsResponse {
+    RequestedSets: Array<{
+        GameID: number | string;
+        Title: string;
+        ConsoleID: number | string;
+        ConsoleName: string;
+        ImageIcon: string;
+    }>;
+    TotalRequests: number;
+    PointsForNext: number;
+}

package/dist/user/models/get-users-following-me-response.model.d.ts

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

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

@@ -12,9 +12,12 @@ export * from "./get-user-profile-response.model";
 export * from "./get-user-progress-response.model";
 export * from "./get-user-recent-achievements-response.model";
 export * from "./get-user-recently-played-games-response.model";
+export * from "./get-user-set-requests-response.model";
 export * from "./get-user-summary-response.model";
 export * from "./get-user-want-to-play-list-response.model";
+export * from "./get-users-following-me-response.model";
 export * from "./get-users-i-follow-response.model";
+export * from "./request-list-type.enum";
 export * from "./user-awards.model";
 export * from "./user-claims.model";
 export * from "./user-claims-response.model";
@@ -27,6 +30,8 @@ export * from "./user-profile.model";
 export * from "./user-progress.model";
 export * from "./user-recent-achievement.model";
 export * from "./user-recently-played-games.model";
+export * from "./user-set-requests.model";
 export * from "./user-summary.model";
 export * from "./user-want-to-play-list.model";
+export * from "./users-following-me.model";
 export * from "./users-i-follow.model";

package/dist/user/models/request-list-type.enum.d.ts

@@ -0,0 +1,4 @@
+export declare enum RequestListType {
+    ActiveRequests = 0,
+    AllRequests = 1
+}

package/dist/user/models/user-set-requests.model.d.ts

@@ -0,0 +1,11 @@
+export interface UserSetRequests {
+    requestedSets: Array<{
+        gameId: number;
+        title: string;
+        consoleId: number;
+        consoleName: string;
+        imageIcon: string;
+    }>;
+    totalRequests: number;
+    pointsForNext: number;
+}

package/dist/user/models/users-following-me.model.d.ts

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

package/package.json

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

package/src/user/getUserSetRequests.test.ts

@@ -0,0 +1,149 @@
+import { http, HttpResponse } from "msw";
+import { setupServer } from "msw/node";
+
+import { apiBaseUrl } from "../utils/internal";
+import { buildAuthorization } from "../utils/public";
+import { getUserSetRequests } from "./getUserSetRequests";
+import type { GetUserSetRequestsResponse, UserSetRequests } from "./models";
+import { RequestListType } from "./models";
+
+const server = setupServer();
+
+describe("Function: getUserSetRequests", () => {
+  // MSW Setup
+  beforeAll(() => server.listen());
+  afterEach(() => server.resetHandlers());
+  afterAll(() => server.close());
+
+  it("is defined #sanity", () => {
+    // ASSERT
+    expect(getUserSetRequests).toBeDefined();
+  });
+
+  it("using defaults, retrieves the list of set requests of the given user", async () => {
+    // ARRANGE
+    const authorization = buildAuthorization({
+      username: "mockUserName",
+      webApiKey: "mockWebApiKey",
+    });
+
+    const mockResponse = mockGetUserSetRequestsResponse;
+
+    server.use(
+      http.get(`${apiBaseUrl}/API_GetUserSetRequests.php`, (info) => {
+        const url = new URL(info.request.url);
+        expect(url.searchParams.get("u")).toEqual(mockOtherUsername);
+        expect(url.searchParams.has("t")).toBeFalsy();
+        return HttpResponse.json(mockResponse);
+      })
+    );
+
+    // ACT
+    const response = await getUserSetRequests(authorization, {
+      username: mockOtherUsername,
+    });
+    expect(response).toEqual(mockUserSetRequestsValue);
+  });
+
+  it.each([
+    { requestListType: RequestListType.ActiveRequests },
+    { requestListType: RequestListType.AllRequests },
+  ])(
+    "calls the 'User Set Requests' endpoint with a given request list type ($requestListType)",
+    async ({ requestListType: expectedRequestListType }) => {
+      // ARRANGE
+      const authorization = buildAuthorization({
+        username: "mockUserName",
+        webApiKey: "mockWebApiKey",
+      });
+
+      server.use(
+        http.get(`${apiBaseUrl}/API_GetUserSetRequests.php`, (info) => {
+          const url = new URL(info.request.url);
+          expect(url.searchParams.get("u")).toEqual(mockOtherUsername);
+          expect(url.searchParams.get("t")).toEqual(
+            String(expectedRequestListType)
+          );
+          return HttpResponse.json(mockGetUserSetRequestsResponse);
+        })
+      );
+
+      // ACT
+      await getUserSetRequests(authorization, {
+        username: mockOtherUsername,
+        requestListType: expectedRequestListType,
+      });
+    }
+  );
+
+  it.each([
+    { status: 503, statusText: "The API is currently down" },
+    { status: 422, statusText: "HTTP Error: Status 422 Unprocessable Entity" },
+  ])(
+    "given the API returns a $status, throws an error",
+    async ({ status, statusText }) => {
+      // ARRANGE
+      const authorization = buildAuthorization({
+        username: "mockUserName",
+        webApiKey: "mockWebApiKey",
+      });
+
+      const mockResponse = `<html><body>${statusText}</body></html>`;
+
+      server.use(
+        http.get(`${apiBaseUrl}/API_GetUserSetRequests.php`, () =>
+          HttpResponse.json(mockResponse, { status, statusText })
+        )
+      );
+
+      // ASSERT
+      await expect(
+        getUserSetRequests(authorization, { username: mockOtherUsername })
+      ).rejects.toThrow();
+    }
+  );
+});
+
+const mockOtherUsername = "otherMockUser";
+
+const mockGetUserSetRequestsResponse: GetUserSetRequestsResponse = {
+  RequestedSets: [
+    {
+      GameID: 8149,
+      Title: "Example Set 1",
+      ConsoleID: 0,
+      ConsoleName: "Example Console",
+      ImageIcon: "/Images/000001.png",
+    },
+    {
+      GameID: 9001,
+      Title: "Example Set 2",
+      ConsoleID: 2,
+      ConsoleName: "Example Console 2",
+      ImageIcon: "/Images/000002.png",
+    },
+  ],
+  TotalRequests: 5,
+  PointsForNext: 5000,
+};
+
+const mockUserSetRequestsValue: UserSetRequests = {
+  requestedSets: [
+    {
+      gameId: 8149,
+      title: "Example Set 1",
+      consoleId: 0,
+      consoleName: "Example Console",
+      imageIcon: "/Images/000001.png",
+    },
+    {
+      gameId: 9001,
+      title: "Example Set 2",
+      consoleId: 2,
+      consoleName: "Example Console 2",
+      imageIcon: "/Images/000002.png",
+    },
+  ],
+  totalRequests: 5,
+  pointsForNext: 5000,
+};

package/src/user/getUserSetRequests.ts

@@ -0,0 +1,92 @@
+import {
+  apiBaseUrl,
+  buildRequestUrl,
+  call,
+  serializeProperties,
+} from "../utils/internal";
+import type { AuthObject } from "../utils/public";
+import type {
+  GetUserSetRequestsResponse,
+  RequestListType,
+  UserSetRequests,
+} from "./models";
+
+/**
+ * A call to this function will retrieve a given user's set requests.
+ *
+ * @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 set requests
+ * for.
+ *
+ * @param payload.requestListType An optional parameter to filter set requests
+ * by their current status. If omitted, the API will return only active
+ * requests.
+ *
+ * @example
+ * ```
+ * const userSetRequests = await getUserSetRequests(authorization, {
+ *   username: "ExampleUser"
+ * });
+ * ```
+ *
+ * @returns An object containing a list of requested sets that the
+ * given user made.
+ * ```json
+ * {
+ *   "requestedSets": [
+ *     {
+ *       "gameId": 8149,
+ *       "title": "Example Set 1",
+ *       "consoleId": 0,
+ *       "consoleName": "Example Console",
+ *       "imageIcon": "/Images/000001.png"
+ *     },
+ *     {
+ *       "gameId": 9001,
+ *       "title": "Example Set 2",
+ *       "consoleId": 2,
+ *       "consoleName": "Example Console 2",
+ *       "imageIcon": "/Images/000002.png"
+ *     }
+ *   ],
+ *   "totalRequests": 5,
+ *   "pointsForNext": 5000
+ * }
+ * ```
+ *
+ * @throws If the API was given invalid parameters (422) or if the
+ * API is currently down (503).
+ */
+export const getUserSetRequests = async (
+  authorization: AuthObject,
+  payload: { username: string; requestListType?: RequestListType }
+): Promise<UserSetRequests> => {
+  const queryParams: Record<string, number | string> = {};
+  queryParams.u = payload.username;
+  if (
+    payload.requestListType !== null &&
+    payload.requestListType !== undefined
+  ) {
+    queryParams.t = payload.requestListType;
+  }
+
+  const url = buildRequestUrl(
+    apiBaseUrl,
+    "/API_GetUserSetRequests.php",
+    authorization,
+    queryParams
+  );
+
+  const rawResponse = await call<GetUserSetRequestsResponse>({ url });
+
+  return serializeProperties(rawResponse, {
+    shouldCastToNumbers: [
+      "GameID",
+      "ConsoleID",
+      "TotalRequests",
+      "PointsForNext",
+    ],
+  });
+};

package/src/user/getUsersFollowingMe.test.ts

@@ -0,0 +1,124 @@
+import { http, HttpResponse } from "msw";
+import { setupServer } from "msw/node";
+
+import { apiBaseUrl } from "../utils/internal";
+import { buildAuthorization } from "../utils/public";
+import { getUsersFollowingMe } from "./getUsersFollowingMe";
+import type { GetUsersFollowingMeResponse, UsersFollowingMe } from "./models";
+
+const server = setupServer();
+
+describe("Function: getUsersFollowingMe", () => {
+  // MSW Setup
+  beforeAll(() => server.listen());
+  afterEach(() => server.resetHandlers());
+  afterAll(() => server.close());
+
+  it("is defined #sanity", () => {
+    // ASSERT
+    expect(getUsersFollowingMe).toBeDefined();
+  });
+
+  it("using defaults, retrieves the list of users that are following the caller", async () => {
+    // ARRANGE
+    const authorization = buildAuthorization({
+      username: "mockUserName",
+      webApiKey: "mockWebApiKey",
+    });
+
+    const mockResponse = mockGetUsersFollowingMeResponse;
+
+    server.use(
+      http.get(`${apiBaseUrl}/API_GetUsersFollowingMe.php`, (info) => {
+        const url = new URL(info.request.url);
+        expect(url.searchParams.has("c")).toBeFalsy();
+        expect(url.searchParams.has("o")).toBeFalsy();
+        return HttpResponse.json(mockResponse);
+      })
+    );
+
+    // ACT
+    const response = await getUsersFollowingMe(authorization);
+    expect(response).toEqual(mockUsersFollowingMeValue);
+  });
+
+  it.each([{ offset: 1, count: 1 }, { offset: 5 }, { count: 20 }])(
+    "calls the 'Users Following Me' endpoint with a given offset ($offset) and/or count ($count)",
+    async (mockPayload) => {
+      // ARRANGE
+      const authorization = buildAuthorization({
+        username: "mockUserName",
+        webApiKey: "mockWebApiKey",
+      });
+
+      server.use(
+        http.get(`${apiBaseUrl}/API_GetUsersFollowingMe.php`, (info) => {
+          const url = new URL(info.request.url);
+          const c = url.searchParams.get("c");
+          const o = url.searchParams.get("o");
+          expect(String(c)).toEqual(String(mockPayload.count ?? null));
+          expect(String(o)).toEqual(String(mockPayload.offset ?? null));
+          return HttpResponse.json(mockGetUsersFollowingMeResponse);
+        })
+      );
+
+      // ACT
+      await getUsersFollowingMe(authorization, mockPayload);
+    }
+  );
+
+  it.each([
+    { status: 503, statusText: "The API is currently down" },
+    { status: 422, statusText: "HTTP Error: Status 422 Unprocessable Entity" },
+  ])(
+    "given the API returns a $status, throws an error",
+    async ({ status, statusText }) => {
+      // ARRANGE
+      const authorization = buildAuthorization({
+        username: "mockUserName",
+        webApiKey: "mockWebApiKey",
+      });
+
+      const mockResponse = `<html><body>${statusText}</body></html>`;
+
+      server.use(
+        http.get(`${apiBaseUrl}/API_GetUsersFollowingMe.php`, () =>
+          HttpResponse.json(mockResponse, { status, statusText })
+        )
+      );
+
+      // ASSERT
+      await expect(
+        getUsersFollowingMe(authorization, { count: 0 })
+      ).rejects.toThrow();
+    }
+  );
+});
+
+const mockGetUsersFollowingMeResponse: GetUsersFollowingMeResponse = {
+  Count: 1,
+  Total: 1,
+  Results: [
+    {
+      User: "Example",
+      ULID: "0123456789ABCDEFGHIJKLMNO",
+      Points: 9001,
+      PointsSoftcore: 101,
+      AmIFollowing: true,
+    },
+  ],
+};
+
+const mockUsersFollowingMeValue: UsersFollowingMe = {
+  count: 1,
+  total: 1,
+  results: [
+    {
+      user: "Example",
+      ulid: "0123456789ABCDEFGHIJKLMNO",
+      points: 9001,
+      pointsSoftcore: 101,
+      amIFollowing: true,
+    },
+  ],
+};

package/src/user/getUsersFollowingMe.ts

@@ -0,0 +1,75 @@
+import {
+  apiBaseUrl,
+  buildRequestUrl,
+  call,
+  serializeProperties,
+} from "../utils/internal";
+import type { AuthObject } from "../utils/public";
+import type { GetUsersFollowingMeResponse, UsersFollowingMe } from "./models";
+
+/**
+ * A call to this function will retrieve the list of users that are
+ * following the caller.
+ *
+ * @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 usersFollowingMe = await getUsersFollowingMe(authorization);
+ * ```
+ *
+ * @returns An object containing a list of users that are following
+ * the caller.
+ * ```json
+ * {
+ *   "count": 1,
+ *   "total": 1,
+ *   "results": [
+ *     {
+ *       "user": "Example",
+ *       "ulid": "0123456789ABCDEFGHIJKLMNO",
+ *       "points": 9001,
+ *       "pointsSoftcore": 101,
+ *       "amIFollowing": true
+ *     }
+ *   ]
+ * }
+ * ```
+ *
+ * @throws If the API was given invalid parameters (422) or if the
+ * API is currently down (503).
+ */
+export const getUsersFollowingMe = async (
+  authorization: AuthObject,
+  payload?: { offset?: number; count?: number }
+): Promise<UsersFollowingMe> => {
+  const queryParams: Record<string, number> = {};
+  if (payload?.offset !== null && payload?.offset !== undefined) {
+    queryParams.o = payload.offset;
+  }
+  if (payload?.count !== null && payload?.count !== undefined) {
+    queryParams.c = payload.count;
+  }
+
+  const url = buildRequestUrl(
+    apiBaseUrl,
+    "/API_GetUsersFollowingMe.php",
+    authorization,
+    queryParams
+  );
+
+  const rawResponse = await call<GetUsersFollowingMeResponse>({ url });
+
+  return serializeProperties(rawResponse, {
+    shouldCastToNumbers: ["Points", "PointsSoftcore"],
+    shouldMapToBooleans: ["AmIFollowing"],
+  });
+};

package/src/user/index.ts

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

package/src/user/models/get-user-set-requests-response.model.ts

@@ -0,0 +1,11 @@
+export interface GetUserSetRequestsResponse {
+  RequestedSets: Array<{
+    GameID: number | string;
+    Title: string;
+    ConsoleID: number | string;
+    ConsoleName: string;
+    ImageIcon: string;
+  }>;
+  TotalRequests: number;
+  PointsForNext: number;
+}

package/src/user/models/get-users-following-me-response.model.ts

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