@retroachievements/api 1.5.3 → 2.1.0

package/src/user/models/get-game-info-and-user-progress-response.model.ts

@@ -2,6 +2,7 @@ import type {
   GameExtendedRawAchievementEntity,
   GetGameExtendedResponse,
 } from "../../game/models";
+import type { AwardKind } from "../../utils/public";
 
 type GetGameExtendedResponseWithoutClaims = Omit<
   GetGameExtendedResponse,
@@ -25,4 +26,7 @@ export interface GetGameInfoAndUserProgressResponse
   NumAwardedToUserHardcore: number;
   UserCompletion: string;
   UserCompletionHardcore: string;
+
+  HighestAwardKind?: AwardKind | null;
+  HighestAwardDate?: string;
 }

package/src/user/models/get-user-completion-progress-response.model.ts

@@ -1,3 +1,5 @@
+import type { AwardKind } from "../../utils/public";
+
 interface RawUserCompletionProgressEntity {
   GameID: number;
   Title: string;
@@ -9,12 +11,7 @@ interface RawUserCompletionProgressEntity {
   NumAwardedHardcore: number;
 
   MostRecentAwardedDate?: string;
-  HighestAwardKind?:
-    | "mastered"
-    | "completed"
-    | "beaten-hardcore"
-    | "beaten-softcore"
-    | null;
+  HighestAwardKind?: AwardKind | null;
   HighestAwardDate?: string | null;
 }
 

package/src/user/models/user-completion-progress-entity.model.ts

@@ -1,3 +1,5 @@
+import type { AwardKind } from "../../utils/public";
+
 export interface UserCompletionProgressEntity {
   gameId: number;
   title: string;
@@ -9,11 +11,6 @@ export interface UserCompletionProgressEntity {
   numAwardedHardcore: number;
 
   mostRecentAwardedDate?: string;
-  highestAwardKind?:
-    | "mastered"
-    | "completed"
-    | "beaten-hardcore"
-    | "beaten-softcore"
-    | null;
+  highestAwardKind?: AwardKind | null;
   highestAwardDate?: string;
 }

package/src/utils/internal/buildRequestUrl.test.ts

@@ -22,7 +22,7 @@ describe("Util: buildRequestUrl", () => {
     const requestUrl = buildRequestUrl(
       baseUrl,
       endpointUrl,
-      { userName: "TestUser", webApiKey: "mockWebApiKey" },
+      { username: "TestUser", webApiKey: "mockWebApiKey" },
       args as any
     );
 
@@ -39,7 +39,7 @@ describe("Util: buildRequestUrl", () => {
 
     // ACT
     const requestUrl = buildRequestUrl(baseUrl, endpointUrl, {
-      userName: "TestUser",
+      username: "TestUser",
       webApiKey: "mockWebApiKey",
     });
 

package/src/utils/internal/buildRequestUrl.ts

@@ -14,7 +14,7 @@ export const buildRequestUrl = (
   // `z` and `y` are expected query params from the RA API.
   // Authentication is handled purely by query params.
   const queryParamValues: Record<string, string> = {
-    z: authObject.userName,
+    z: authObject.username,
     y: authObject.webApiKey,
   };
 

package/src/utils/public/buildAuthorization.test.ts

@@ -9,7 +9,7 @@ describe("Util: buildAuthorization", () => {
   it("returns the same object it is given", () => {
     // ARRANGE
     const myAuth = {
-      userName: "myUserName",
+      username: "myUserName",
       webApiKey: "myWebApiKey",
     };
 
@@ -20,7 +20,7 @@ describe("Util: buildAuthorization", () => {
     expect(authorization).toEqual(myAuth);
   });
 
-  it("throws an error if missing a userName", () => {
+  it("throws an error if missing a username", () => {
     // ASSERT
     // eslint-disable-next-line @typescript-eslint/ban-ts-comment
     // @ts-ignore - We're assuming the user is not using a TypeScript project.
@@ -31,6 +31,6 @@ describe("Util: buildAuthorization", () => {
     // ASSERT
     // eslint-disable-next-line @typescript-eslint/ban-ts-comment
     // @ts-ignore - We're assuming the user is not using a TypeScript project.
-    expect(() => buildAuthorization({ userName: "mockUserName" })).toThrow();
+    expect(() => buildAuthorization({ username: "mockUserName" })).toThrow();
   });
 });

package/src/utils/public/buildAuthorization.ts

@@ -15,19 +15,19 @@ import type { AuthObject } from "./models";
  * @example
  * ```
  * const authorization = buildAuthorization({
- *   userName: "Scott",
+ *   username: "Scott",
  *   webApiKey: "LtjCwW16nJI7cqOyPIQtXk8v1cfF0tmO"
  * });
  * ```
  */
 export const buildAuthorization = (options: AuthObject): AuthObject => {
-  if (!options.userName || !options.webApiKey) {
+  if (!options.username || !options.webApiKey) {
     throw new Error(`
       buildAuthorization() requires an object containing a
-      userName and webApiKey. eg:
+      username and webApiKey. eg:
 
       const authorization = buildAuthorization({
-        userName: "myUserName",
+        username: "myUserName",
         webApiKey: "myWebApiKey"
       })
     `);

package/src/utils/public/models/auth-object.model.ts

@@ -1,6 +1,6 @@
 /**
  * Each RetroAchievements API call is uniquely authenticated
- * using a userName + API key combination. Your account's personal
+ * using a username + API key combination. Your account's personal
  * Web API Key can be found on the Settings page.
  */
 export interface AuthObject {
@@ -9,7 +9,7 @@ export interface AuthObject {
    * For example, https://retroachievements.org/user/Scott would have a value
    * of "Scott".
    */
-  userName: string;
+  username: string;
 
   /**
    * This can be found in the "Keys" section of your Settings page on the

package/src/utils/public/models/award-kind.model.ts

@@ -0,0 +1,5 @@
+export type AwardKind =
+  | "beaten-softcore"
+  | "beaten-hardcore"
+  | "completed"
+  | "mastered";

package/src/utils/public/models/index.ts

@@ -1 +1,2 @@
 export * from "./auth-object.model";
+export * from "./award-kind.model";

package/src/console/models/console-id.model.ts

@@ -1,5 +0,0 @@
-export interface ConsoleId {
-  id: number;
-  name: string;
-  iconUrl: string;
-}