@retroachievements/api 1.2.1 → 1.4.0

package/dist/utils/public/index.d.ts

@@ -1,3 +1,3 @@
-export { call as unsafe_call } from "../internal/call";
-export * from "./buildAuthorization";
-export * from "./models";
+export { call as unsafe_call } from "../internal/call";
+export * from "./buildAuthorization";
+export * from "./models";

package/dist/utils/public/models/auth-object.model.d.ts

@@ -1,19 +1,19 @@
-/**
- * Each RetroAchievements API call is uniquely authenticated
- * using a userName + API key combination. Your account's personal
- * Web API Key can be found on the Settings page.
- */
-export interface AuthObject {
-    /**
-     * You or your app's exact username on the RetroAchievements.org website.
-     * For example, https://retroachievements.org/user/Scott would have a value
-     * of "Scott".
-     */
-    userName: string;
-    /**
-     * This can be found in the "Keys" section of your Settings page on the
-     * RetroAchievements.org website. This is a 32-digit alphanumeric key
-     * that is case-sensitive.
-     */
-    webApiKey: string;
-}
+/**
+ * Each RetroAchievements API call is uniquely authenticated
+ * using a userName + API key combination. Your account's personal
+ * Web API Key can be found on the Settings page.
+ */
+export interface AuthObject {
+    /**
+     * You or your app's exact username on the RetroAchievements.org website.
+     * For example, https://retroachievements.org/user/Scott would have a value
+     * of "Scott".
+     */
+    userName: string;
+    /**
+     * This can be found in the "Keys" section of your Settings page on the
+     * RetroAchievements.org website. This is a 32-digit alphanumeric key
+     * that is case-sensitive.
+     */
+    webApiKey: string;
+}

package/dist/utils/public/models/index.d.ts

@@ -1 +1 @@
-export * from "./auth-object.model";
+export * from "./auth-object.model";

package/package.json

@@ -10,7 +10,7 @@
     "raweb",
     "retro gaming"
   ],
-  "version": "1.2.1",
+  "version": "1.4.0",
   "typings": "dist/index.d.ts",
   "exports": {
     ".": {
@@ -37,17 +37,12 @@
     "format:check": "prettier --check . '**/*.{json,md,js,ts,tsx}'",
     "lint": "eslint --ignore-path .gitignore --ext .js,.ts,.tsx .",
     "lint:fix": "eslint --ignore-path .gitignore --ext .js,.ts,.tsx . --fix",
-    "test": "NODE_OPTIONS='--no-experimental-fetch' jest --selectProjects UNIT",
-    "test:coverage": "jest --selectProjects UNIT --coverage",
-    "verify": "yarn format:check && yarn lint && yarn test:coverage && yarn build && yarn size && yarn docs:build",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "verify": "yarn format:check && yarn lint && yarn test:coverage && yarn build && yarn size",
     "size": "size-limit",
-    "start": "microbundle watch",
-    "docs:dev": "vitepress dev docs",
-    "docs:build": "vitepress build docs",
-    "docs:preview": "vitepress preview docs"
-  },
-  "dependencies": {
-    "isomorphic-unfetch": "^3.1.0"
+    "start": "microbundle watch"
   },
   "peerDependencies": {},
   "devDependencies": {
@@ -55,33 +50,31 @@
     "@commitlint/config-conventional": "^17.4.2",
     "@digitak/esrun": "^3.2.19",
     "@size-limit/preset-small-lib": "^8.1.2",
-    "@swc/core": "^1.3.30",
-    "@swc/jest": "^0.2.24",
     "@tsconfig/recommended": "^1.0.2",
-    "@types/jest": "^29.4.0",
-    "@typescript-eslint/eslint-plugin": "^5.49.0",
-    "@typescript-eslint/parser": "^5.49.0",
+    "@typescript-eslint/eslint-plugin": "^6.9.1",
+    "@typescript-eslint/parser": "^6.9.1",
+    "@vitest/coverage-v8": "^0.34.6",
     "cz-conventional-changelog": "^3.3.0",
     "dotenv-flow-cli": "^1.0.0",
-    "eslint": "^8.33.0",
+    "eslint": "^8.53.0",
     "eslint-config-prettier": "^8.6.0",
-    "eslint-import-resolver-typescript": "^3.5.3",
-    "eslint-plugin-import": "^2.27.5",
+    "eslint-import-resolver-typescript": "^3.6.1",
+    "eslint-plugin-import": "^2.29.0",
     "eslint-plugin-simple-import-sort": "^10.0.0",
-    "eslint-plugin-sonarjs": "^0.18.0",
-    "eslint-plugin-unicorn": "^45.0.2",
+    "eslint-plugin-sonarjs": "^0.23.0",
+    "eslint-plugin-unicorn": "^49.0.0",
     "husky": "4.3.8",
-    "jest": "^29.4.1",
     "microbundle": "^0.15.1",
-    "msw": "^1.0.1",
+    "msw": "^2.0.3",
     "prettier": "2.8.3",
     "pretty-quick": "3.1.3",
     "size-limit": "^8.1.2",
-    "tslib": "^2.5.0",
-    "type-fest": "^3.5.3",
-    "typescript": "^4.9.4",
-    "vitepress": "^1.0.0-alpha.43",
-    "vue": "^3.2.45"
+    "tslib": "^2.6.2",
+    "type-fest": "^4.6.0",
+    "typescript": "^5.2.2",
+    "undici": "^5.27.2",
+    "vite": "^4.5.0",
+    "vitest": "^0.34.6"
   },
   "size-limit": [
     {
@@ -117,11 +110,11 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/RetroAchievements/retroachievements-api-js.git"
+    "url": "git+https://github.com/RetroAchievements/api-js.git"
   },
   "bugs": {
-    "url": "https://github.com/RetroAchievements/retroachievements-api-js/issues"
+    "url": "https://github.com/RetroAchievements/api-js/issues"
   },
-  "homepage": "https://github.com/RetroAchievements/retroachievements-api-js#readme",
+  "homepage": "https://github.com/RetroAchievements/api-js#readme",
   "author": "RAWeb Team"
 }

package/src/achievement/getAchievementUnlocks.test.ts

@@ -1,4 +1,4 @@
-import { rest } from "msw";
+import { http, HttpResponse } from "msw";
 import { setupServer } from "msw/node";
 
 import { apiBaseUrl } from "../utils/internal";
@@ -51,16 +51,13 @@ describe("Function: getAchievementUnlocks", () => {
       ]
     };
 
-    let searchParams = "";
+    let requestUrl = "";
 
     server.use(
-      rest.get(
-        `${apiBaseUrl}/API_GetAchievementUnlocks.php`,
-        (req, res, ctx) => {
-          searchParams = req.url.search;
-          return res(ctx.json(mockResponse));
-        }
-      )
+      http.get(`${apiBaseUrl}/API_GetAchievementUnlocks.php`, (info) => {
+        requestUrl = info.request.url;
+        return HttpResponse.json(mockResponse);
+      })
     );
 
     // ACT
@@ -71,9 +68,9 @@ describe("Function: getAchievementUnlocks", () => {
     });
 
     // ASSERT
-    expect(searchParams).toContain("a=18000");
-    expect(searchParams).toContain("o=1");
-    expect(searchParams).toContain("c=1");
+    expect(requestUrl).toContain("a=18000");
+    expect(requestUrl).toContain("o=1");
+    expect(requestUrl).toContain("c=1");
 
     expect(response).toEqual({
       achievement: {

package/src/console/getConsoleIds.test.ts

@@ -1,6 +1,6 @@
 /* eslint-disable sonarjs/no-duplicate-string */
 
-import { rest } from "msw";
+import { http, HttpResponse } from "msw";
 import { setupServer } from "msw/node";
 
 import { apiBaseUrl } from "../utils/internal";
@@ -35,8 +35,8 @@ describe("Function: getConsoleIds", () => {
     ];
 
     server.use(
-      rest.get(`${apiBaseUrl}/API_GetConsoleIDs.php`, (_, res, ctx) =>
-        res(ctx.json(mockResponse))
+      http.get(`${apiBaseUrl}/API_GetConsoleIDs.php`, () =>
+        HttpResponse.json(mockResponse)
       )
     );
 

package/src/console/getGameList.test.ts

@@ -1,6 +1,6 @@
 /* eslint-disable sonarjs/no-duplicate-string */
 
-import { rest } from "msw";
+import { http, HttpResponse } from "msw";
 import { setupServer } from "msw/node";
 
 import { apiBaseUrl } from "../utils/internal";
@@ -48,8 +48,8 @@ describe("Function: getGameList", () => {
     ];
 
     server.use(
-      rest.get(`${apiBaseUrl}/API_GetGameList.php`, (_, res, ctx) =>
-        res(ctx.json(mockResponse))
+      http.get(`${apiBaseUrl}/API_GetGameList.php`, () =>
+        HttpResponse.json(mockResponse)
       )
     );
 

package/src/feed/getAchievementOfTheWeek.test.ts

@@ -1,6 +1,6 @@
 /* eslint-disable sonarjs/no-duplicate-string */
 
-import { rest } from "msw";
+import { http, HttpResponse } from "msw";
 import { setupServer } from "msw/node";
 
 import { apiBaseUrl } from "../utils/internal";
@@ -56,8 +56,8 @@ describe("Function: getAchievementOfTheWeek", () => {
     };
 
     server.use(
-      rest.get(`${apiBaseUrl}/API_GetAchievementOfTheWeek.php`, (_, res, ctx) =>
-        res(ctx.json(mockResponse))
+      http.get(`${apiBaseUrl}/API_GetAchievementOfTheWeek.php`, () =>
+        HttpResponse.json(mockResponse)
       )
     );
 
@@ -128,8 +128,8 @@ describe("Function: getAchievementOfTheWeek", () => {
     };
 
     server.use(
-      rest.get(`${apiBaseUrl}/API_GetAchievementOfTheWeek.php`, (_, res, ctx) =>
-        res(ctx.json(mockResponse))
+      http.get(`${apiBaseUrl}/API_GetAchievementOfTheWeek.php`, () =>
+        HttpResponse.json(mockResponse)
       )
     );
 

package/src/feed/getActiveClaims.test.ts

@@ -1,6 +1,6 @@
 /* eslint-disable sonarjs/no-duplicate-string */
 
-import { rest } from "msw";
+import { http, HttpResponse } from "msw";
 import { setupServer } from "msw/node";
 
 import { apiBaseUrl } from "../utils/internal";
@@ -51,8 +51,8 @@ describe("Function: getActiveClaims", () => {
     ];
 
     server.use(
-      rest.get(`${apiBaseUrl}/API_GetActiveClaims.php`, (_, res, ctx) =>
-        res(ctx.json(mockResponse))
+      http.get(`${apiBaseUrl}/API_GetActiveClaims.php`, () =>
+        HttpResponse.json(mockResponse)
       )
     );
 

package/src/feed/getClaims.test.ts

@@ -1,6 +1,6 @@
 /* eslint-disable sonarjs/no-duplicate-string */
 
-import { rest } from "msw";
+import { http, HttpResponse } from "msw";
 import { setupServer } from "msw/node";
 
 import { apiBaseUrl } from "../utils/internal";
@@ -51,8 +51,8 @@ describe("Function: getClaims", () => {
     ];
 
     server.use(
-      rest.get(`${apiBaseUrl}/API_GetClaims.php`, (_, res, ctx) =>
-        res(ctx.json(mockResponse))
+      http.get(`${apiBaseUrl}/API_GetClaims.php`, () =>
+        HttpResponse.json(mockResponse)
       )
     );
 

package/src/feed/getTopTenUsers.test.ts

@@ -1,4 +1,4 @@
-import { rest } from "msw";
+import { http, HttpResponse } from "msw";
 import { setupServer } from "msw/node";
 
 import { apiBaseUrl } from "../utils/internal";
@@ -40,8 +40,8 @@ describe("Function: getTopTenUsers", () => {
     ];
 
     server.use(
-      rest.get(`${apiBaseUrl}/API_GetTopTenUsers.php`, (_, res, ctx) =>
-        res(ctx.json(mockResponse))
+      http.get(`${apiBaseUrl}/API_GetTopTenUsers.php`, () =>
+        HttpResponse.json(mockResponse)
       )
     );
 

package/src/game/getAchievementCount.test.ts

@@ -1,4 +1,4 @@
-import { rest } from "msw";
+import { http, HttpResponse } from "msw";
 import { setupServer } from "msw/node";
 
 import { apiBaseUrl } from "../utils/internal";
@@ -32,8 +32,8 @@ describe("Function: getAchievementCount", () => {
     };
 
     server.use(
-      rest.get(`${apiBaseUrl}/API_GetAchievementCount.php`, (_, res, ctx) =>
-        res(ctx.json(mockResponse))
+      http.get(`${apiBaseUrl}/API_GetAchievementCount.php`, () =>
+        HttpResponse.json(mockResponse)
       )
     );
 

package/src/game/getAchievementDistribution.test.ts

@@ -1,4 +1,4 @@
-import { rest } from "msw";
+import { http, HttpResponse } from "msw";
 import { setupServer } from "msw/node";
 
 import { apiBaseUrl } from "../utils/internal";
@@ -35,16 +35,14 @@ describe("Function: getAchievementDistribution", () => {
       "5": 1
     };
 
-    let detectedSearchParams: URLSearchParams;
+    let requestUrl = "";
 
     server.use(
-      rest.get(
-        `${apiBaseUrl}/API_GetAchievementDistribution.php`,
-        (req, res, ctx) => {
-          detectedSearchParams = req.url.searchParams;
-          return res(ctx.json(mockResponse));
-        }
-      )
+      http.get(`${apiBaseUrl}/API_GetAchievementDistribution.php`, (info) => {
+        requestUrl = info.request.url;
+
+        return HttpResponse.json(mockResponse);
+      })
     );
 
     // ACT
@@ -55,9 +53,9 @@ describe("Function: getAchievementDistribution", () => {
     // ASSERT
     expect(response).toEqual(mockResponse);
 
-    expect(detectedSearchParams!.get("i")).toEqual("14402");
-    expect(detectedSearchParams!.has("f")).toBeFalsy();
-    expect(detectedSearchParams!.has("h")).toBeFalsy();
+    expect(requestUrl).toContain("i=14402");
+    expect(requestUrl).not.toContain("f=");
+    expect(requestUrl).not.toContain("h=");
   });
 
   it("given flags, successfully attaches the option to the call", async () => {
@@ -75,16 +73,13 @@ describe("Function: getAchievementDistribution", () => {
       "5": 1
     };
 
-    let detectedSearchParams: URLSearchParams;
+    let requestUrl = "";
 
     server.use(
-      rest.get(
-        `${apiBaseUrl}/API_GetAchievementDistribution.php`,
-        (req, res, ctx) => {
-          detectedSearchParams = req.url.searchParams;
-          return res(ctx.json(mockResponse));
-        }
-      )
+      http.get(`${apiBaseUrl}/API_GetAchievementDistribution.php`, (info) => {
+        requestUrl = info.request.url;
+        return HttpResponse.json(mockResponse);
+      })
     );
 
     // ACT
@@ -96,11 +91,11 @@ describe("Function: getAchievementDistribution", () => {
     // ASSERT
     expect(response).toEqual(mockResponse);
 
-    expect(detectedSearchParams!.get("i")).toEqual("14402");
-    expect(detectedSearchParams!.get("f")).toEqual(
-      String(AchievementDistributionFlags.UnofficialAchievements)
+    expect(requestUrl).toContain("i=14402");
+    expect(requestUrl).toContain(
+      `f=${AchievementDistributionFlags.UnofficialAchievements}`
     );
-    expect(detectedSearchParams!.has("h")).toBeFalsy();
+    expect(requestUrl).not.toContain("h=");
   });
 
   it("given a truthy hardcore value, successfully attaches the option to the call", async () => {
@@ -118,16 +113,13 @@ describe("Function: getAchievementDistribution", () => {
       "5": 1
     };
 
-    let detectedSearchParams: URLSearchParams;
+    let requestUrl = "";
 
     server.use(
-      rest.get(
-        `${apiBaseUrl}/API_GetAchievementDistribution.php`,
-        (req, res, ctx) => {
-          detectedSearchParams = req.url.searchParams;
-          return res(ctx.json(mockResponse));
-        }
-      )
+      http.get(`${apiBaseUrl}/API_GetAchievementDistribution.php`, (info) => {
+        requestUrl = info.request.url;
+        return HttpResponse.json(mockResponse);
+      })
     );
 
     // ACT
@@ -139,8 +131,8 @@ describe("Function: getAchievementDistribution", () => {
     // ASSERT
     expect(response).toEqual(mockResponse);
 
-    expect(detectedSearchParams!.get("i")).toEqual("14402");
-    expect(detectedSearchParams!.get("h")).toEqual("1");
+    expect(requestUrl).toContain("i=14402");
+    expect(requestUrl).toContain("h=1");
   });
 
   it("given a falsy hardcore value, successfully attaches the option to the call", async () => {
@@ -158,16 +150,13 @@ describe("Function: getAchievementDistribution", () => {
       "5": 1
     };
 
-    let detectedSearchParams: URLSearchParams;
+    let requestUrl = "";
 
     server.use(
-      rest.get(
-        `${apiBaseUrl}/API_GetAchievementDistribution.php`,
-        (req, res, ctx) => {
-          detectedSearchParams = req.url.searchParams;
-          return res(ctx.json(mockResponse));
-        }
-      )
+      http.get(`${apiBaseUrl}/API_GetAchievementDistribution.php`, (info) => {
+        requestUrl = info.request.url;
+        return HttpResponse.json(mockResponse);
+      })
     );
 
     // ACT
@@ -179,7 +168,7 @@ describe("Function: getAchievementDistribution", () => {
     // ASSERT
     expect(response).toEqual(mockResponse);
 
-    expect(detectedSearchParams!.get("i")).toEqual("14402");
-    expect(detectedSearchParams!.get("h")).toEqual("0");
+    expect(requestUrl).toContain("i=14402");
+    expect(requestUrl).toContain("h=0");
   });
 });

package/src/game/getGame.test.ts

@@ -1,6 +1,6 @@
 /* eslint-disable sonarjs/no-duplicate-string */
 
-import { rest } from "msw";
+import { http, HttpResponse } from "msw";
 import { setupServer } from "msw/node";
 
 import { apiBaseUrl } from "../utils/internal";
@@ -49,8 +49,8 @@ describe("Function: getGame", () => {
     };
 
     server.use(
-      rest.get(`${apiBaseUrl}/API_GetGame.php`, (_, res, ctx) =>
-        res(ctx.json(mockResponse))
+      http.get(`${apiBaseUrl}/API_GetGame.php`, () =>
+        HttpResponse.json(mockResponse)
       )
     );
 
@@ -73,7 +73,7 @@ describe("Function: getGame", () => {
       publisher: "Activision ",
       developer: "David Crane",
       genre: "Racing",
-      released: 1980,
+      released: "1980",
       gameTitle: "Dragster",
       console: "Atari 2600"
     });

package/src/game/getGame.ts

@@ -45,7 +45,7 @@ import type { Game, GetGameResponse } from "./models";
  *   publisher: "Activision",
  *   developer: "David Crane",
  *   genre: "Racing",
- *   released: 1980,
+ *   released: "1980",
  *   gameTitle: "Dragster",
  *   console: "Atari 2600"
  * }
@@ -64,12 +64,6 @@ export const getGame = async (
   const rawResponse = await call<GetGameResponse>({ url });
 
   return serializeProperties(rawResponse, {
-    shouldCastToNumbers: [
-      "ID",
-      "ForumTopicID",
-      "ConsoleID",
-      "Flags",
-      "Released"
-    ]
+    shouldCastToNumbers: ["ID", "ForumTopicID", "ConsoleID", "Flags"]
   });
 };

package/src/game/getGameExtended.test.ts

@@ -1,6 +1,6 @@
 /* eslint-disable sonarjs/no-duplicate-string */
 
-import { rest } from "msw";
+import { http, HttpResponse } from "msw";
 import { setupServer } from "msw/node";
 
 import { apiBaseUrl } from "../utils/internal";
@@ -69,8 +69,8 @@ describe("Function: getGameExtended", () => {
     };
 
     server.use(
-      rest.get(`${apiBaseUrl}/API_GetGameExtended.php`, (_, res, ctx) =>
-        res(ctx.json(mockResponse))
+      http.get(`${apiBaseUrl}/API_GetGameExtended.php`, () =>
+        HttpResponse.json(mockResponse)
       )
     );
 
@@ -91,7 +91,7 @@ describe("Function: getGameExtended", () => {
       publisher: "Activision ",
       developer: "David Crane",
       genre: "Racing",
-      released: 1980,
+      released: "1980",
       isFinal: false,
       consoleName: "Atari 2600",
       richPresencePatch: "2b92fa1bf9635c303b3b7f8feea3ed3c",

package/src/game/getGameExtended.ts

@@ -43,7 +43,7 @@ import type { GameExtended, GetGameExtendedResponse } from "./models";
  *   publisher: "Activision",
  *   developer: "David Crane",
  *   genre: "Racing",
- *   released: 1980,
+ *   released: "1980",
  *   isFinal: false,
  *   consoleName: "Atari 2600",
  *   richPresencePatch: "2b92fa1bf9635c303b3b7f8feea3ed3c",
@@ -73,17 +73,23 @@ import type { GameExtended, GetGameExtendedResponse } from "./models";
  */
 export const getGameExtended = async (
   authorization: AuthObject,
-  payload: { gameId: ID }
+  payload: { gameId: ID; isRequestingUnofficialAchievements: boolean }
 ): Promise<GameExtended> => {
-  const { gameId } = payload;
+  const { gameId, isRequestingUnofficialAchievements } = payload;
+
+  const params: Record<string, string | number> = {
+    i: gameId
+  };
+
+  if (isRequestingUnofficialAchievements) {
+    params["f"] = 5;
+  }
 
   const url = buildRequestUrl(
     apiBaseUrl,
     "/API_GetGameExtended.php",
     authorization,
-    {
-      i: gameId
-    }
+    params
   );
 
   const rawResponse = await call<GetGameExtendedResponse>({ url });
@@ -97,8 +103,7 @@ export const getGameExtended = async (
       "TrueRatio",
       "DisplayOrder",
       "NumDistinctPlayersCasual",
-      "NumDistinctPlayersHardcore",
-      "Released"
+      "NumDistinctPlayersHardcore"
     ]
   });
 };

package/src/game/getGameRankAndScore.test.ts

@@ -1,6 +1,6 @@
 /* eslint-disable sonarjs/no-duplicate-string */
 
-import { rest } from "msw";
+import { http, HttpResponse } from "msw";
 import { setupServer } from "msw/node";
 
 import { apiBaseUrl } from "../utils/internal";
@@ -38,8 +38,8 @@ describe("Function: getGameRankAndScore", () => {
     ];
 
     server.use(
-      rest.get(`${apiBaseUrl}/API_GetGameRankAndScore.php`, (_, res, ctx) =>
-        res(ctx.json(mockResponse))
+      http.get(`${apiBaseUrl}/API_GetGameRankAndScore.php`, () =>
+        HttpResponse.json(mockResponse)
       )
     );
 

package/src/game/getGameRating.test.ts

@@ -1,4 +1,4 @@
-import { rest } from "msw";
+import { http, HttpResponse } from "msw";
 import { setupServer } from "msw/node";
 
 import { apiBaseUrl } from "../utils/internal";
@@ -37,8 +37,8 @@ describe("Function: getGameRating", () => {
     };
 
     server.use(
-      rest.get(`${apiBaseUrl}/API_GetGameRating.php`, (_, res, ctx) =>
-        res(ctx.json(mockResponse))
+      http.get(`${apiBaseUrl}/API_GetGameRating.php`, () =>
+        HttpResponse.json(mockResponse)
       )
     );
 

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

@@ -14,7 +14,7 @@ export interface GameExtended {
   publisher: string;
   developer: string;
   genre: string;
-  released: number;
+  released: string;
   isFinal: boolean;
   consoleName: string;
   richPresencePatch: string;

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

@@ -13,7 +13,7 @@ export interface Game {
   publisher: string;
   developer: string;
   genre: string;
-  released: number;
+  released: string;
   gameTitle: string;
   console: string;
 }