@retroachievements/api 1.4.0 → 1.5.1

package/src/feed/getAchievementOfTheWeek.test.ts

@@ -6,7 +6,10 @@ import { setupServer } from "msw/node";
 import { apiBaseUrl } from "../utils/internal";
 import { buildAuthorization } from "../utils/public";
 import { getAchievementOfTheWeek } from "./getAchievementOfTheWeek";
-import type { GetAchievementOfTheWeekResponse } from "./models";
+import type {
+  AchievementOfTheWeek,
+  GetAchievementOfTheWeekResponse
+} from "./models";
 
 const server = setupServer();
 
@@ -37,7 +40,9 @@ describe("Function: getAchievementOfTheWeek", () => {
         TrueRatio: "22",
         Author: "BigWeedSmokerMan",
         DateCreated: "2021-08-08 17:47:46",
-        DateModified: "2021-08-09 12:20:05"
+        DateModified: "2021-08-09 12:20:05",
+        BadgeName: "185805",
+        BadgeURL: "/Badge/185805.png"
       },
       Console: { ID: "39", Title: "Saturn" },
       ForumTopic: { ID: "14767" },
@@ -64,8 +69,7 @@ describe("Function: getAchievementOfTheWeek", () => {
     // ACT
     const response = await getAchievementOfTheWeek(authorization);
 
-    // ASSERT
-    expect(response).toEqual({
+    const expectedResponse: AchievementOfTheWeek = {
       achievement: {
         id: 165_062,
         title: "The True Hero",
@@ -74,7 +78,9 @@ describe("Function: getAchievementOfTheWeek", () => {
         trueRatio: 22,
         author: "BigWeedSmokerMan",
         dateCreated: "2021-08-08 17:47:46",
-        dateModified: "2021-08-09 12:20:05"
+        dateModified: "2021-08-09 12:20:05",
+        badgeName: "185805",
+        badgeUrl: "/Badge/185805.png"
       },
       console: { id: 39, title: "Saturn" },
       forumTopic: { id: 14_767 },
@@ -90,7 +96,10 @@ describe("Function: getAchievementOfTheWeek", () => {
         }
       ],
       unlocksCount: 40
-    });
+    };
+
+    // ASSERT
+    expect(response).toEqual(expectedResponse);
   });
 
   it("properly sets the hardcore boolean value when cleaning properties", async () => {
@@ -109,7 +118,9 @@ describe("Function: getAchievementOfTheWeek", () => {
         TrueRatio: "22",
         Author: "BigWeedSmokerMan",
         DateCreated: "2021-08-08 17:47:46",
-        DateModified: "2021-08-09 12:20:05"
+        DateModified: "2021-08-09 12:20:05",
+        BadgeName: "185805",
+        BadgeURL: "/Badge/185805.png"
       },
       Console: { ID: "39", Title: "Saturn" },
       ForumTopic: { ID: "14767" },
@@ -136,8 +147,7 @@ describe("Function: getAchievementOfTheWeek", () => {
     // ACT
     const response = await getAchievementOfTheWeek(authorization);
 
-    // ASSERT
-    expect(response).toEqual({
+    const expectedResponse: AchievementOfTheWeek = {
       achievement: {
         id: 165_062,
         title: "The True Hero",
@@ -146,7 +156,9 @@ describe("Function: getAchievementOfTheWeek", () => {
         trueRatio: 22,
         author: "BigWeedSmokerMan",
         dateCreated: "2021-08-08 17:47:46",
-        dateModified: "2021-08-09 12:20:05"
+        dateModified: "2021-08-09 12:20:05",
+        badgeName: "185805",
+        badgeUrl: "/Badge/185805.png"
       },
       console: { id: 39, title: "Saturn" },
       forumTopic: { id: 14_767 },
@@ -162,6 +174,9 @@ describe("Function: getAchievementOfTheWeek", () => {
         }
       ],
       unlocksCount: 40
-    });
+    };
+
+    // ASSERT
+    expect(response).toEqual(expectedResponse);
   });
 });

package/src/feed/getAchievementOfTheWeek.ts

@@ -36,7 +36,9 @@ import type {
  *     trueRatio: "22",
  *     author: "BigWeedSmokerMan",
  *     dateCreated: "2021-08-08 17:47:46",
- *     dateModified: "2021-08-09 12:20:05"
+ *     dateModified: "2021-08-09 12:20:05",
+ *     badgeName: "185805",
+ *     badgeUrl: "/Badge/185805.png"
  *   },
  *   console: { id: "39", title: "Saturn" },
  *   forumTopic: { id: "14767" },

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

@@ -8,6 +8,8 @@ export interface AchievementOfTheWeek {
     author: string;
     dateCreated: string;
     dateModified: string;
+    badgeName: string;
+    badgeUrl: string;
   };
 
   console: { id: number; title: string };

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

@@ -8,6 +8,8 @@ export interface GetAchievementOfTheWeekResponse {
     Author: string;
     DateCreated: string;
     DateModified: string;
+    BadgeName: string;
+    BadgeURL: string;
   };
 
   Console: { ID: string; Title: string };

package/src/set-version.js

@@ -0,0 +1,6 @@
+import packageJson from "../package.json" assert { type: "json" };
+
+const { version } = packageJson;
+
+process.env.PACKAGE_VERSION = version;
+console.log(`ℹ️  Set User-Agent header version variable to ${version}`);

package/src/user/getAchievementsEarnedBetween.test.ts

@@ -4,7 +4,10 @@ import { setupServer } from "msw/node";
 import { apiBaseUrl } from "../utils/internal";
 import { buildAuthorization } from "../utils/public";
 import { getAchievementsEarnedBetween } from "./getAchievementsEarnedBetween";
-import type { DatedUserAchievementsResponse } from "./models";
+import type {
+  DatedUserAchievement,
+  DatedUserAchievementsResponse
+} from "./models";
 
 const server = setupServer();
 
@@ -42,7 +45,8 @@ describe("Function: getAchievementsEarnedBetween", () => {
         ConsoleName: "PlayStation Portable",
         CumulScore: 40,
         BadgeURL: "/Badge/193797.png",
-        GameURL: "/game/3571"
+        GameURL: "/game/3571",
+        Type: "progression"
       }
     ];
 
@@ -59,8 +63,7 @@ describe("Function: getAchievementsEarnedBetween", () => {
       toDate: new Date("2022-10-13")
     });
 
-    // ASSERT
-    expect(response).toEqual([
+    const expectedResponse: DatedUserAchievement[] = [
       {
         date: "2022-10-12 07:36:31",
         hardcoreMode: true,
@@ -76,8 +79,12 @@ describe("Function: getAchievementsEarnedBetween", () => {
         consoleName: "PlayStation Portable",
         cumulScore: 40,
         badgeUrl: "/Badge/193797.png",
-        gameUrl: "/game/3571"
+        gameUrl: "/game/3571",
+        type: "progression"
       }
-    ]);
+    ];
+
+    // ASSERT
+    expect(response).toEqual(expectedResponse);
   });
 });

package/src/user/getAchievementsEarnedBetween.ts

@@ -57,7 +57,8 @@ import type {
  *     consoleName: 'PlayStation Portable',
  *     cumulScore: 120,
  *     badgeUrl: '/Badge/193756.png',
- *     gameUrl: '/game/3571'
+ *     gameUrl: '/game/3571',
+ *     type: 'progression'
  *   }
  * ]
  * ```

package/src/user/getAchievementsEarnedOnDay.test.ts

@@ -4,7 +4,10 @@ import { setupServer } from "msw/node";
 import { apiBaseUrl } from "../utils/internal";
 import { buildAuthorization } from "../utils/public";
 import { getAchievementsEarnedOnDay } from "./getAchievementsEarnedOnDay";
-import type { DatedUserAchievementsResponse } from "./models";
+import type {
+  DatedUserAchievement,
+  DatedUserAchievementsResponse
+} from "./models";
 
 const server = setupServer();
 
@@ -42,7 +45,8 @@ describe("Function: getAchievementsEarnedOnDay", () => {
         ConsoleName: "PlayStation Portable",
         CumulScore: 40,
         BadgeURL: "/Badge/193797.png",
-        GameURL: "/game/3571"
+        GameURL: "/game/3571",
+        Type: null
       }
     ];
 
@@ -58,8 +62,7 @@ describe("Function: getAchievementsEarnedOnDay", () => {
       onDate: new Date("2022-10-12")
     });
 
-    // ASSERT
-    expect(response).toEqual([
+    const expectedResponse: DatedUserAchievement[] = [
       {
         date: "2022-10-12 07:36:31",
         hardcoreMode: true,
@@ -75,8 +78,12 @@ describe("Function: getAchievementsEarnedOnDay", () => {
         consoleName: "PlayStation Portable",
         cumulScore: 40,
         badgeUrl: "/Badge/193797.png",
-        gameUrl: "/game/3571"
+        gameUrl: "/game/3571",
+        type: null
       }
-    ]);
+    ];
+
+    // ASSERT
+    expect(response).toEqual(expectedResponse);
   });
 });

package/src/user/getAchievementsEarnedOnDay.ts

@@ -56,7 +56,8 @@ import type {
  *      consoleName: 'PlayStation Portable',
  *      cumulScore: 120,
  *      badgeUrl: '/Badge/193756.png',
- *      gameUrl: '/game/3571'
+ *      gameUrl: '/game/3571',
+ *      type: 'progression'
  *    }
  *  ]
  * ```

package/src/user/models/dated-user-achievement.model.ts

@@ -14,4 +14,5 @@ export type DatedUserAchievement = {
   cumulScore: number;
   badgeUrl: string;
   gameUrl: string;
-}[];
+  type: "progression" | "win_condition" | "missable" | null;
+};

package/src/user/models/dated-user-achievements-response.model.ts

@@ -14,6 +14,7 @@ interface DatedUserAchievementResponseEntity {
   CumulScore: number;
   BadgeURL: string;
   GameURL: string;
+  Type: "progression" | "win_condition" | "missable" | null;
 }
 
 export type DatedUserAchievementsResponse =

package/src/utils/internal/call.ts

@@ -1,3 +1,5 @@
+const packageVersion = process.env?.["PACKAGE_VERSION"] ?? "Unknown";
+
 /**
  * Fetch an HTTP resource. This is publicly exposed in the
  * event you would like to access an endpoint that this
@@ -13,7 +15,11 @@ export const call = async <
 }) => {
   const { url } = config;
 
-  const rawResponse = await fetch(url);
+  const headers = new Headers({
+    "User-Agent": `RetroAchievements-api-js/${packageVersion}`
+  });
+
+  const rawResponse = await fetch(url, { headers });
 
   if (!rawResponse.ok) {
     throw new Error(