feat: add PasswordLogin

Author: Shinigami92

README.md

@@ -62,4 +62,15 @@ client.v1
   .then((response) => {
     console.log("PasswordlessLogin Response:", response);
   });
+
+client.v1
+  .PasswordLogin({
+    data: {
+      minimumPrivilegeLevel: PrivilegeLevel.NotAuthenticated,
+      password: "your-password",
+    },
+  })
+  .then((response) => {
+    console.log("PasswordLogin Response:", response);
+  });
 ```

src/index.ts

@@ -18,6 +18,9 @@ export type {
   InsufficientScopeErrorResponse,
   InvalidTokenErrorResponse,
   MissingParamsErrorResponse,
+  PasswordLoginRequest,
+  PasswordLoginResponse,
+  PasswordLoginResponseData,
   PasswordlessLoginRequest,
   PasswordlessLoginResponse,
   PasswordlessLoginResponseData,
@@ -26,4 +29,5 @@ export type {
   QueryServerStateResponseData,
   VerifyAuthenticationTokenRequest,
   VerifyAuthenticationTokenResponse,
+  WrongPasswordErrorResponse,
 } from "./v1/index.js";

src/v1/PasswordLogin.ts

@@ -0,0 +1,37 @@
+import type {
+  ApiRequest,
+  ApiSuccessResponse,
+  PrivilegeLevel,
+} from "./common.js";
+import { buildApiRequest } from "./common.js";
+
+export type PasswordLoginRequest = ApiRequest<
+  "PasswordLogin",
+  {
+    /**
+     * Minimum privilege level to attempt to acquire by logging in.
+     */
+    minimumPrivilegeLevel: `${PrivilegeLevel}`;
+    /**
+     * Password to attempt to log in with, in plaintext.
+     */
+    password: string;
+  }
+>;
+
+export type PasswordLoginResponseData = {
+  /**
+   * Authentication Token in case login is successful.
+   */
+  authenticationToken: string;
+};
+
+export type PasswordLoginResponse =
+  ApiSuccessResponse<PasswordLoginResponseData>;
+
+export const buildPasswordLogin = buildApiRequest<
+  PasswordLoginRequest,
+  PasswordLoginResponse
+>("v1", {
+  function: "PasswordLogin",
+});

src/v1/error.ts

@@ -30,3 +30,8 @@ export interface MissingParamsErrorResponse extends ErrorResponse {
     invalidParameters: Record<string, unknown>;
   };
 }
+
+export interface WrongPasswordErrorResponse extends ErrorResponse {
+  errorCode: "wrong_password";
+  errorMessage: string;
+}

src/v1/index.ts

@@ -3,6 +3,7 @@ import { buildGetAdvancedGameSettings } from "./GetAdvancedGameSettings.js";
 import { buildGetServerOptions } from "./GetServerOptions.js";
 import { buildHealthCheck } from "./HealthCheck.js";
 import { buildPasswordlessLogin } from "./PasswordlessLogin.js";
+import { buildPasswordLogin } from "./PasswordLogin.js";
 import { buildQueryServerState } from "./QueryServerState.js";
 import { buildVerifyAuthenticationToken } from "./VerifyAuthenticationToken.js";
 
@@ -28,6 +29,12 @@ export function buildV1(options: InternalClientOptions) {
      * This function requires no Authentication.
      */
     PasswordlessLogin: buildPasswordlessLogin(options),
+    /**
+     * Attempts to log in to the Dedicated Server as a player using either Admin Password or Client Protection Password.
+     *
+     * This function requires no Authentication.
+     */
+    PasswordLogin: buildPasswordLogin(options),
     /**
      * Retrieves the current state of the Dedicated Server.
      */
@@ -49,5 +56,6 @@ export type * from "./GetAdvancedGameSettings.js";
 export type * from "./GetServerOptions.js";
 export type * from "./HealthCheck.js";
 export type * from "./PasswordlessLogin.js";
+export type * from "./PasswordLogin.js";
 export type * from "./QueryServerState.js";
 export type * from "./VerifyAuthenticationToken.js";

test.js

@@ -43,3 +43,14 @@ client.v1
   .then((response) => {
     console.log("PasswordlessLogin Response:", response);
   });
+
+client.v1
+  .PasswordLogin({
+    data: {
+      minimumPrivilegeLevel: PrivilegeLevel.NotAuthenticated,
+      password: "your-password",
+    },
+  })
+  .then((response) => {
+    console.log("PasswordLogin Response:", response);
+  });