feat: add RunCommand

Author: Shinigami92

src/index.ts

@@ -47,4 +47,7 @@ export type {
   VerifyAuthenticationTokenRequest,
   VerifyAuthenticationTokenResponse,
   WrongPasswordErrorResponse,
+  RunCommandRequest,
+  RunCommandResponse,
+  RunCommandResponseData,
 } from "./v1/index.js";

src/v1/RunCommand.ts

@@ -0,0 +1,28 @@
+import type { ApiRequest, ApiSuccessResponse } from "./common.js";
+import { buildApiRequest } from "./common.js";
+
+export type RunCommandRequest = ApiRequest<
+  "RunCommand",
+  {
+    /**
+     * Command Line to run on the Dedicated Server.
+     */
+    command: string;
+  }
+>;
+
+export type RunCommandResponseData = {
+  /**
+   * Output of the command executed, with \n used as line separator.
+   */
+  commandResult: string;
+};
+
+export type RunCommandResponse = ApiSuccessResponse<RunCommandResponseData>;
+
+export const buildRunCommand = buildApiRequest<
+  RunCommandRequest,
+  RunCommandResponse
+>("v1", {
+  function: "RunCommand",
+});

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 { buildRunCommand } from "./RunCommand.js";
 import { buildSetAdminPassword } from "./SetAdminPassword.js";
 import { buildSetAutoLoadSessionName } from "./SetAutoLoadSessionName.js";
 import { buildSetClientPassword } from "./SetClientPassword.js";
@@ -109,6 +110,12 @@ export function buildV1(options: InternalClientOptions) {
      * Function does not return any data on success.
      */
     SetAutoLoadSessionName: buildSetAutoLoadSessionName(options),
+    /**
+     * Runs the given Console Command on the Dedicated Server, and returns it's output to the Console.
+     *
+     * Requires Admin privileges.
+     */
+    RunCommand: buildRunCommand(options),
   };
 }
 
@@ -123,6 +130,7 @@ export type * from "./PasswordlessLogin.js";
 export type * from "./PasswordLogin.js";
 export type * from "./QueryServerState.js";
 export type * from "./RenameServer.js";
+export type * from "./RunCommand.js";
 export type * from "./SetAdminPassword.js";
 export type * from "./SetAutoLoadSessionName.js";
 export type * from "./SetClientPassword.js";