feat: add ClaimServer

Author: Shinigami92

README.md

@@ -82,7 +82,18 @@ client.v1
       },
     },
   })
+  .then(() => {
+    // response will be an empty string if valid
+  });
+
+client.v1
+  .ClaimServer({
+    data: {
+      serverName: "your-server",
+      adminPassword: "your-password",
+    },
+  })
   .then((response) => {
-    console.log("ApplyAdvancedGameSettings Response:", typeof response);
+    console.log("ClaimServer Response:", response);
   });
 ```

src/index.ts

@@ -7,6 +7,9 @@ export type {
   ApplyAdvancedGameSettingsRequest,
   ApplyAdvancedGameSettingsResponse,
   BooleanString,
+  ClaimServerRequest,
+  ClaimServerResponse,
+  ClaimServerResponseData,
   ErrorResponse,
   GetAdvancedGameSettingsRequest,
   GetAdvancedGameSettingsResponse,

src/v1/ClaimServer.ts

@@ -0,0 +1,32 @@
+import type { ApiRequest, ApiSuccessResponse } from "./common.js";
+import { buildApiRequest } from "./common.js";
+
+export type ClaimServerRequest = ApiRequest<
+  "ClaimServer",
+  {
+    /**
+     * 	New name of the Dedicated Server.
+     */
+    serverName: string;
+    /**
+     * 	Admin Password to set on the Dedicated Server, in plaintext.
+     */
+    adminPassword: string;
+  }
+>;
+
+export type ClaimServerResponseData = {
+  /**
+   * New Authentication Token that the Caller should use to drop Initial Admin privileges.
+   */
+  authenticationToken: string;
+};
+
+export type ClaimServerResponse = ApiSuccessResponse<ClaimServerResponseData>;
+
+export const buildClaimServer = buildApiRequest<
+  ClaimServerRequest,
+  ClaimServerResponse
+>("v1", {
+  function: "ClaimServer",
+});

src/v1/error.ts

@@ -15,12 +15,10 @@ export interface ErrorResponse {
 
 export interface InvalidTokenErrorResponse extends ErrorResponse {
   errorCode: "invalid_token";
-  errorMessage: "Token has expired";
 }
 
 export interface InsufficientScopeErrorResponse extends ErrorResponse {
   errorCode: "insufficient_scope";
-  errorMessage: "The client is missing required privileges to access the given function";
 }
 
 export interface MissingParamsErrorResponse extends ErrorResponse {
@@ -33,5 +31,8 @@ export interface MissingParamsErrorResponse extends ErrorResponse {
 
 export interface WrongPasswordErrorResponse extends ErrorResponse {
   errorCode: "wrong_password";
-  errorMessage: string;
+}
+
+export interface ServerClaimedErrorResponse extends ErrorResponse {
+  errorCode: "server_claimed";
 }

src/v1/index.ts

@@ -1,4 +1,5 @@
 import { buildApplyAdvancedGameSettings } from "./ApplyAdvancedGameSettings.js";
+import { buildClaimServer } from "./ClaimServer.js";
 import type { InternalClientOptions } from "./common.js";
 import { buildGetAdvancedGameSettings } from "./GetAdvancedGameSettings.js";
 import { buildGetServerOptions } from "./GetServerOptions.js";
@@ -54,10 +55,21 @@ export function buildV1(options: InternalClientOptions) {
      * Will automatically enable Advanced Game Settings for the currently loaded save if they are not enabled already.
      */
     ApplyAdvancedGameSettings: buildApplyAdvancedGameSettings(options),
+    /**
+     * Claims this Dedicated Server if it is not claimed.
+     *
+     * Requires InitialAdmin privilege level, which can only be acquired by attempting passwordless login while the server does not have an Admin Password set, e.g. it is not claimed yet.
+     *
+     * Function does not return any data in case of success, and the server is claimed.
+     *
+     * The client should drop InitialAdmin privileges after that and use returned AuthenticationToken instead, and update it's cached server game state by calling QueryServerState.
+     */
+    ClaimServer: buildClaimServer(options),
   };
 }
 
 export type * from "./ApplyAdvancedGameSettings.js";
+export type * from "./ClaimServer.js";
 export type * from "./common.js";
 export type * from "./error.js";
 export type * from "./GetAdvancedGameSettings.js";

test.js

@@ -66,3 +66,14 @@ client.v1
   .then((response) => {
     console.log("ApplyAdvancedGameSettings Response:", typeof response);
   });
+
+client.v1
+  .ClaimServer({
+    data: {
+      serverName: "your-server",
+      adminPassword: "your-password",
+    },
+  })
+  .then((response) => {
+    console.log("ClaimServer Response:", response);
+  });