feat: add SetAdminPassword

Author: Shinigami92

src/index.ts

@@ -7,6 +7,7 @@ export type {
   ApplyAdvancedGameSettingsRequest,
   ApplyAdvancedGameSettingsResponse,
   BooleanString,
+  CannotResetAdminPasswordErrorResponse,
   ClaimServerRequest,
   ClaimServerResponse,
   ClaimServerResponseData,
@@ -23,6 +24,7 @@ export type {
   InsufficientScopeErrorResponse,
   InvalidTokenErrorResponse,
   MissingParamsErrorResponse,
+  PasswordInUseErrorResponse,
   PasswordLoginRequest,
   PasswordLoginResponse,
   PasswordLoginResponseData,
@@ -32,14 +34,15 @@ export type {
   QueryServerStateRequest,
   QueryServerStateResponse,
   QueryServerStateResponseData,
-  VerifyAuthenticationTokenRequest,
-  VerifyAuthenticationTokenResponse,
-  WrongPasswordErrorResponse,
   RenameServerRequest,
   RenameServerResponse,
   ServerClaimedErrorResponse,
-  PasswordInUseErrorResponse,
   ServerNotClaimedErrorResponse,
+  SetAdminPasswordRequest,
+  SetAdminPasswordResponse,
   SetClientPasswordRequest,
   SetClientPasswordResponse,
+  VerifyAuthenticationTokenRequest,
+  VerifyAuthenticationTokenResponse,
+  WrongPasswordErrorResponse,
 } from "./v1/index.js";

src/v1/SetAdminPassword.ts

@@ -0,0 +1,25 @@
+import type { ApiRequest } from "./common.js";
+import { buildApiRequest } from "./common.js";
+
+export type SetAdminPasswordRequest = ApiRequest<
+  "SetAdminPassword",
+  {
+    /**
+     * Admin Password to set on the Dedicated Server, in plaintext.
+     */
+    password: string;
+    /**
+     * New Admin authentication token to use, since the token used for this request will become invalidated.
+     */
+    authenticationToken: string;
+  }
+>;
+
+export type SetAdminPasswordResponse = string;
+
+export const buildSetAdminPassword = buildApiRequest<
+  SetAdminPasswordRequest,
+  SetAdminPasswordResponse
+>("v1", {
+  function: "SetAdminPassword",
+});

src/v1/error.ts

@@ -44,3 +44,7 @@ export interface ServerNotClaimedErrorResponse extends ErrorResponse {
 export interface PasswordInUseErrorResponse extends ErrorResponse {
   errorCode: "password_in_use";
 }
+
+export interface CannotResetAdminPasswordErrorResponse extends ErrorResponse {
+  errorCode: "cannot_reset_admin_password";
+}

src/v1/index.ts

@@ -8,6 +8,7 @@ import { buildPasswordlessLogin } from "./PasswordlessLogin.js";
 import { buildPasswordLogin } from "./PasswordLogin.js";
 import { buildQueryServerState } from "./QueryServerState.js";
 import { buildRenameServer } from "./RenameServer.js";
+import { buildSetAdminPassword } from "./SetAdminPassword.js";
 import { buildSetClientPassword } from "./SetClientPassword.js";
 import { buildVerifyAuthenticationToken } from "./VerifyAuthenticationToken.js";
 
@@ -87,6 +88,16 @@ export function buildV1(options: InternalClientOptions) {
      * Function does not return any data on success.
      */
     SetClientPassword: buildSetClientPassword(options),
+    /**
+     * Updates the currently set Admin Password.
+     *
+     * This will invalidate all previously issued Client and Admin authentication tokens.
+     *
+     * Requires Admin privileges.
+     *
+     * Function does not return any data on success.
+     */
+    SetAdminPassword: buildSetAdminPassword(options),
   };
 }
 
@@ -101,5 +112,6 @@ export type * from "./PasswordlessLogin.js";
 export type * from "./PasswordLogin.js";
 export type * from "./QueryServerState.js";
 export type * from "./RenameServer.js";
+export type * from "./SetAdminPassword.js";
 export type * from "./SetClientPassword.js";
 export type * from "./VerifyAuthenticationToken.js";