@retroachievements/api 2.3.0 → 2.5.0

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

@@ -0,0 +1,3 @@
+export * from "./comment-entity.model";
+export * from "./comment-response.model";
+export * from "./get-comments-response.model";

package/dist/index.d.ts

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

package/dist/leaderboard/getLeaderboardEntries.d.ts

@@ -0,0 +1,46 @@
+import type { ID } from "../utils/internal";
+import type { AuthObject } from "../utils/public";
+import type { LeaderboardEntries } from "./models";
+/**
+ * A call to this endpoint will retrieve a given leaderboard's entries, targeted by its ID.
+ *
+ * @param authorization An object containing your username and webApiKey.
+ * This can be constructed with `buildAuthorization()`.
+ *
+ * @param payload.leaderboardId The target leaderboard ID.
+ *
+ * @param payload.offset Defaults to 0. The number of entries to skip.
+ *
+ * @param payload.count Defaults to 100, has a max of 500.
+ *
+ * @example
+ * ```
+ * const leaderboardEntries = await getLeaderboardEntries(
+ *   authorization,
+ *   { leaderboardId: 14402 }
+ * );
+ * ```
+ *
+ * @returns An object containing a leaderboard's entries.
+ * ```json
+ * {
+ *   "count": 100,
+ *   "total": 1287,
+ *   "results": [
+ *     {
+ *       "rank": 1,
+ *       "user": "vani11a",
+ *       "ulid": "00003EMFWR7XB8SDPEHB3K56ZQ",
+ *       "score": 390490,
+ *       "formattedScore": "390,490",
+ *       "dateSubmitted": "2024-07-25T15:51:00+00:00"
+ *     }
+ *   ]
+ * }
+ * ```
+ */
+export declare const getLeaderboardEntries: (authorization: AuthObject, payload: {
+    leaderboardId: ID;
+    offset?: number;
+    count?: number;
+}) => Promise<LeaderboardEntries>;

package/dist/leaderboard/getLeaderboardEntries.test.d.ts

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

package/dist/leaderboard/index.d.ts

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

package/dist/leaderboard/models/get-leaderboard-entries-response.model.d.ts

@@ -0,0 +1,12 @@
+export interface GetLeaderboardEntriesResponse {
+    Count: number;
+    Total: number;
+    Results: Array<{
+        Rank: number;
+        User: string;
+        ULID: string;
+        Score: number;
+        FormattedScore: string;
+        DateSubmitted: string;
+    }>;
+}

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

@@ -0,0 +1,2 @@
+export * from "./get-leaderboard-entries-response.model";
+export * from "./leaderboard-entries.model";

package/dist/leaderboard/models/leaderboard-entries.model.d.ts

@@ -0,0 +1,12 @@
+export interface LeaderboardEntries {
+    count: number;
+    total: number;
+    results: Array<{
+        rank: number;
+        user: string;
+        ulid: string;
+        score: number;
+        formattedScore: string;
+        dateSubmitted: string;
+    }>;
+}

package/package.json

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

package/src/comment/getComments.test.ts

@@ -0,0 +1,277 @@
+/* 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 { getComments } from "./getComments";
+import type { CommentsResponse, GetCommentsResponse } from "./models";
+
+const server = setupServer();
+
+describe("Function: getComments", () => {
+  // MSW Setup
+  beforeAll(() => server.listen());
+  afterEach(() => server.resetHandlers());
+  afterAll(() => server.close());
+
+  it("is defined #sanity", () => {
+    // ASSERT
+    expect(getComments).toBeDefined();
+  });
+
+  it("retrieves the comments on a user's wall", async () => {
+    // ARRANGE
+    const authorization = buildAuthorization({
+      username: "mockUserName",
+      webApiKey: "mockWebApiKey",
+    });
+
+    const mockResponse: GetCommentsResponse = {
+      Count: 2,
+      Total: 2,
+      Results: [
+        {
+          User: "PlayTester",
+          Submitted: "2024-07-31T11:22:23.000000Z",
+          CommentText: "Comment 1",
+        },
+        {
+          User: "PlayTester",
+          Submitted: "2024-07-31T11:22:23.000000Z",
+          CommentText: "Comment 2",
+        },
+      ],
+    };
+
+    server.use(
+      http.get(`${apiBaseUrl}/API_GetComments.php`, () =>
+        HttpResponse.json(mockResponse)
+      )
+    );
+
+    // ACT
+    const response = await getComments(authorization, {
+      identifier: "xelnia",
+    });
+
+    // ASSERT
+    const expectedResponse: CommentsResponse = {
+      count: 2,
+      total: 2,
+      results: [
+        {
+          user: "PlayTester",
+          submitted: "2024-07-31T11:22:23.000000Z",
+          commentText: "Comment 1",
+        },
+        {
+          user: "PlayTester",
+          submitted: "2024-07-31T11:22:23.000000Z",
+          commentText: "Comment 2",
+        },
+      ],
+    };
+
+    expect(response).toEqual(expectedResponse);
+  });
+
+  it("retrieves the comments on an game", async () => {
+    // ARRANGE
+    const authorization = buildAuthorization({
+      username: "mockUserName",
+      webApiKey: "mockWebApiKey",
+    });
+
+    const mockResponse: GetCommentsResponse = {
+      Count: 2,
+      Total: 2,
+      Results: [
+        {
+          User: "PlayTester",
+          Submitted: "2024-07-31T11:22:23.000000Z",
+          CommentText: "Comment 1",
+        },
+        {
+          User: "PlayTester",
+          Submitted: "2024-07-31T11:22:23.000000Z",
+          CommentText: "Comment 2",
+        },
+      ],
+    };
+
+    server.use(
+      http.get(`${apiBaseUrl}/API_GetComments.php`, () =>
+        HttpResponse.json(mockResponse)
+      )
+    );
+
+    // ACT
+    const response = await getComments(authorization, {
+      identifier: 321_865,
+      kind: "game",
+    });
+
+    // ASSERT
+    const expectedResponse: CommentsResponse = {
+      count: 2,
+      total: 2,
+      results: [
+        {
+          user: "PlayTester",
+          submitted: "2024-07-31T11:22:23.000000Z",
+          commentText: "Comment 1",
+        },
+        {
+          user: "PlayTester",
+          submitted: "2024-07-31T11:22:23.000000Z",
+          commentText: "Comment 2",
+        },
+      ],
+    };
+
+    expect(response).toEqual(expectedResponse);
+  });
+
+  it("retrieves the comments on an achievement, respecting count", async () => {
+    // ARRANGE
+    const authorization = buildAuthorization({
+      username: "mockUserName",
+      webApiKey: "mockWebApiKey",
+    });
+
+    const mockResponse: GetCommentsResponse = {
+      Count: 2,
+      Total: 4,
+      Results: [
+        {
+          User: "PlayTester",
+          Submitted: "2024-07-31T11:22:23.000000Z",
+          CommentText: "Comment 1",
+        },
+        {
+          User: "PlayTester",
+          Submitted: "2024-07-31T11:22:23.000000Z",
+          CommentText: "Comment 2",
+        },
+      ],
+    };
+
+    server.use(
+      http.get(`${apiBaseUrl}/API_GetComments.php`, () =>
+        HttpResponse.json(mockResponse)
+      )
+    );
+
+    // ACT
+    const response = await getComments(authorization, {
+      identifier: 321_865,
+      count: 2,
+      kind: "achievement",
+    });
+
+    // ASSERT
+    const expectedResponse: CommentsResponse = {
+      count: 2,
+      total: 4,
+      results: [
+        {
+          user: "PlayTester",
+          submitted: "2024-07-31T11:22:23.000000Z",
+          commentText: "Comment 1",
+        },
+        {
+          user: "PlayTester",
+          submitted: "2024-07-31T11:22:23.000000Z",
+          commentText: "Comment 2",
+        },
+      ],
+    };
+
+    expect(response).toEqual(expectedResponse);
+  });
+
+  it("retrieves the comments on an game, respecting offset", async () => {
+    // ARRANGE
+    const authorization = buildAuthorization({
+      username: "mockUserName",
+      webApiKey: "mockWebApiKey",
+    });
+
+    const mockResponse: GetCommentsResponse = {
+      Count: 1,
+      Total: 2,
+      Results: [
+        {
+          User: "PlayTester",
+          Submitted: "2024-07-31T11:22:23.000000Z",
+          CommentText: "Comment 2",
+        },
+      ],
+    };
+
+    server.use(
+      http.get(`${apiBaseUrl}/API_GetComments.php`, () =>
+        HttpResponse.json(mockResponse)
+      )
+    );
+
+    // ACT
+    const response = await getComments(authorization, {
+      identifier: 321_865,
+      offset: 1,
+      kind: "game",
+    });
+
+    // ASSERT
+    const expectedResponse: CommentsResponse = {
+      count: 1,
+      total: 2,
+      results: [
+        {
+          user: "PlayTester",
+          submitted: "2024-07-31T11:22:23.000000Z",
+          commentText: "Comment 2",
+        },
+      ],
+    };
+
+    expect(response).toEqual(expectedResponse);
+  });
+
+  it("warns the developer when they don't specify kind for achievements/games", async () => {
+    // ARRANGE
+    const authorization = buildAuthorization({
+      username: "mockUserName",
+      webApiKey: "mockWebApiKey",
+    });
+
+    const mockResponse: GetCommentsResponse = {
+      Count: 1,
+      Total: 2,
+      Results: [
+        {
+          User: "PlayTester",
+          Submitted: "2024-07-31T11:22:23.000000Z",
+          CommentText: "Comment 2",
+        },
+      ],
+    };
+
+    server.use(
+      http.get(`${apiBaseUrl}/API_GetComments.php`, () =>
+        HttpResponse.json(mockResponse)
+      )
+    );
+
+    // ACT
+    const response = getComments(authorization, {
+      identifier: 321_865,
+      offset: 1,
+    });
+
+    // ASSERT
+    await expect(response).rejects.toThrow(TypeError);
+  });
+});

package/src/comment/getComments.ts

@@ -0,0 +1,107 @@
+import type { ID } from "../utils/internal";
+import {
+  apiBaseUrl,
+  buildRequestUrl,
+  call,
+  serializeProperties,
+} from "../utils/internal";
+import type { AuthObject } from "../utils/public";
+import type { CommentsResponse, GetCommentsResponse } from "./models";
+
+const kindMap: Record<"game" | "achievement" | "user", number> = {
+  game: 1,
+  achievement: 2,
+  user: 3,
+};
+
+/**
+ * A call to this function will retrieve a list of comments on a particular target.
+ *
+ * @param authorization An object containing your username and webApiKey.
+ * This can be constructed with `buildAuthorization()`.
+ *
+ * @param payload.identifier The identifier to retrieve. For user walls, this will
+ * be a string (the username), and for game and achievement walls, this will be a
+ * the ID of the object in question.
+ *
+ * @param payload.kind What kind of identifier was used. This can be "game",
+ * "achievement", or "user".
+ *
+ * @param payload.offset Defaults to 0. The number of entries to skip.
+ *
+ * @param payload.count Defaults to 50, has a max of 500.
+ *
+ * @example
+ * ```
+ * // Retrieving game/achievement comments
+ * const gameWallComments = await getComments(
+ *   authorization,
+ *   { identifier: 20294, kind: 'game', count: 4, offset: 0 },
+ * );
+ *
+ * // Retrieving comments on a user's wall
+ * const userWallComments = await getComments(
+ *   authorization,
+ *   { identifier: "xelnia", count: 4, offset: 0 },
+ * );
+ * ```
+ *
+ * @returns An object containing the amount of comments retrieved,
+ * the total comments, and an array of the comments themselves.
+ * ```
+ * {
+ *   count: 4,
+ *   total: 4,
+ *   results: [
+ *   {
+ *     user: "PlayTester",
+ *     submitted: "2024-07-31T11:22:23.000000Z",
+ *     commentText: "Comment 1"
+ *   },
+ *   // ...
+ *   ]
+ * }
+ * ```
+ */
+export const getComments = async (
+  authorization: AuthObject,
+  payload: {
+    identifier: ID;
+    kind?: "game" | "achievement" | "user";
+    offset?: number;
+    count?: number;
+  }
+): Promise<CommentsResponse> => {
+  const { identifier, kind, offset, count } = payload;
+
+  const queryParams: Record<string, number | string> = { i: identifier };
+
+  if (kind) {
+    queryParams.t = kindMap[kind];
+  } else if (typeof identifier === "number") {
+    throw new TypeError(
+      "'kind' must be specified when looking up an achievement or game."
+    );
+  }
+
+  if (offset) {
+    queryParams.o = offset;
+  }
+
+  if (count) {
+    queryParams.c = count;
+  }
+
+  const url = buildRequestUrl(
+    apiBaseUrl,
+    "/API_GetComments.php",
+    authorization,
+    queryParams
+  );
+
+  const rawResponse = await call<GetCommentsResponse>({ url });
+
+  return serializeProperties(rawResponse, {
+    shouldCastToNumbers: ["Count", "Total"],
+  });
+};

package/src/comment/index.ts

@@ -0,0 +1,2 @@
+export * from "./getComments";
+export * from "./models";

package/src/comment/models/comment-entity.model.ts

@@ -0,0 +1,7 @@
+export interface CommentEntity {
+  user: string;
+  submitted: string;
+  commentText: string;
+}
+
+export type Comment = CommentEntity;

package/src/comment/models/comment-response.model.ts

@@ -0,0 +1,7 @@
+import type { CommentEntity } from "./comment-entity.model";
+
+export interface CommentsResponse {
+  count: number;
+  total: number;
+  results: CommentEntity[];
+}

package/src/comment/models/get-comments-response.model.ts

@@ -0,0 +1,13 @@
+interface RawCommentsResponseEntity {
+  Count: number;
+  Total: number;
+  Results: RawComment[];
+}
+
+interface RawComment {
+  User: string;
+  Submitted: string;
+  CommentText: string;
+}
+
+export type GetCommentsResponse = RawCommentsResponseEntity;

package/src/comment/models/index.ts

@@ -0,0 +1,3 @@
+export * from "./comment-entity.model";
+export * from "./comment-response.model";
+export * from "./get-comments-response.model";

package/src/index.ts

@@ -1,9 +1,11 @@
 // This file is the single public-facing API of the entire library.
 
 export * from "./achievement";
+export * from "./comment";
 export * from "./console";
 export * from "./feed";
 export * from "./game";
+export * from "./leaderboard";
 export * from "./ticket";
 export * from "./user";
 export * from "./utils/public";

package/src/leaderboard/getLeaderboardEntries.test.ts

@@ -0,0 +1,73 @@
+/* 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 { getLeaderboardEntries } from "./getLeaderboardEntries";
+import type { GetLeaderboardEntriesResponse } from "./models";
+
+const server = setupServer();
+
+describe("Function: getLeaderboardEntries", () => {
+  // MSW Setup
+  beforeAll(() => server.listen());
+  afterEach(() => server.resetHandlers());
+  afterAll(() => server.close());
+
+  it("is defined #sanity", () => {
+    // ASSERT
+    expect(getLeaderboardEntries).toBeDefined();
+  });
+
+  it("given a leaderboard ID, retrieves the entries in that leaderboard", async () => {
+    // ARRANGE
+    const authorization = buildAuthorization({
+      username: "mockUserName",
+      webApiKey: "mockWebApiKey",
+    });
+
+    const mockResponse: GetLeaderboardEntriesResponse = {
+      Count: 100,
+      Total: 1287,
+      Results: [
+        {
+          Rank: 1,
+          User: "vani11a",
+          ULID: "00003EMFWR7XB8SDPEHB3K56ZQ",
+          Score: 390_490,
+          FormattedScore: "390,490",
+          DateSubmitted: "2024-07-25T15:51:00+00:00",
+        },
+      ],
+    };
+
+    server.use(
+      http.get(`${apiBaseUrl}/API_GetLeaderboardEntries.php`, () =>
+        HttpResponse.json(mockResponse)
+      )
+    );
+
+    // ACT
+    const response = await getLeaderboardEntries(authorization, {
+      leaderboardId: 104_370,
+    });
+
+    // ASSERT
+    expect(response).toEqual({
+      count: 100,
+      total: 1287,
+      results: [
+        {
+          rank: 1,
+          user: "vani11a",
+          ulid: "00003EMFWR7XB8SDPEHB3K56ZQ",
+          score: 390_490,
+          formattedScore: "390,490",
+          dateSubmitted: "2024-07-25T15:51:00+00:00",
+        },
+      ],
+    });
+  });
+});

package/src/leaderboard/getLeaderboardEntries.ts

@@ -0,0 +1,75 @@
+import type { ID } from "../utils/internal";
+import {
+  apiBaseUrl,
+  buildRequestUrl,
+  call,
+  serializeProperties,
+} from "../utils/internal";
+import type { AuthObject } from "../utils/public";
+import type {
+  GetLeaderboardEntriesResponse,
+  LeaderboardEntries,
+} from "./models";
+
+/**
+ * A call to this endpoint will retrieve a given leaderboard's entries, targeted by its ID.
+ *
+ * @param authorization An object containing your username and webApiKey.
+ * This can be constructed with `buildAuthorization()`.
+ *
+ * @param payload.leaderboardId The target leaderboard ID.
+ *
+ * @param payload.offset Defaults to 0. The number of entries to skip.
+ *
+ * @param payload.count Defaults to 100, has a max of 500.
+ *
+ * @example
+ * ```
+ * const leaderboardEntries = await getLeaderboardEntries(
+ *   authorization,
+ *   { leaderboardId: 14402 }
+ * );
+ * ```
+ *
+ * @returns An object containing a leaderboard's entries.
+ * ```json
+ * {
+ *   "count": 100,
+ *   "total": 1287,
+ *   "results": [
+ *     {
+ *       "rank": 1,
+ *       "user": "vani11a",
+ *       "ulid": "00003EMFWR7XB8SDPEHB3K56ZQ",
+ *       "score": 390490,
+ *       "formattedScore": "390,490",
+ *       "dateSubmitted": "2024-07-25T15:51:00+00:00"
+ *     }
+ *   ]
+ * }
+ * ```
+ */
+export const getLeaderboardEntries = async (
+  authorization: AuthObject,
+  payload: { leaderboardId: ID; offset?: number; count?: number }
+): Promise<LeaderboardEntries> => {
+  const queryParams: Record<string, any> = {};
+  queryParams.i = payload.leaderboardId;
+  if (payload?.offset) {
+    queryParams.o = payload.offset;
+  }
+  if (payload?.count) {
+    queryParams.c = payload.count;
+  }
+
+  const url = buildRequestUrl(
+    apiBaseUrl,
+    "/API_GetLeaderboardEntries.php",
+    authorization,
+    queryParams
+  );
+
+  const rawResponse = await call<GetLeaderboardEntriesResponse>({ url });
+
+  return serializeProperties(rawResponse);
+};