feat: add EnumerateSessions

Author: Shinigami92

README.md

@@ -106,4 +106,8 @@ client.v1
   .then(() => {
     // response will be an empty string if valid
   });
+
+client.v1.EnumerateSessions().then((response) => {
+  console.log("EnumerateSessions Response:", response);
+});
 ```

src/index.ts

@@ -15,6 +15,10 @@ export type {
   ClaimServerResponseData,
   CreateNewGameRequest,
   CreateNewGameResponse,
+  EnumerateSessionsFailedErrorResponse,
+  EnumerateSessionsRequest,
+  EnumerateSessionsResponse,
+  EnumerateSessionsResponseData,
   ErrorResponse,
   GetAdvancedGameSettingsRequest,
   GetAdvancedGameSettingsResponse,
@@ -46,8 +50,10 @@ export type {
   SaveGameFailedErrorResponse,
   SaveGameRequest,
   SaveGameResponse,
+  SaveHeader,
   ServerClaimedErrorResponse,
   ServerNotClaimedErrorResponse,
+  SessionSaveStruct,
   SetAdminPasswordRequest,
   SetAdminPasswordResponse,
   SetAutoLoadSessionNameRequest,

src/v1/EnumerateSessions.ts

@@ -0,0 +1,84 @@
+import type { ApiRequest, ApiSuccessResponse } from "./common.js";
+import { buildApiRequest } from "./common.js";
+
+export interface SaveHeader {
+  /**
+   * Version of the Save Game format this file was saved with.
+   */
+  saveVersion: number;
+  /**
+   * Changelist of the game or dedicated server this file was saved by.
+   */
+  buildVersion: number;
+  /**
+   * Name of the save game file in the filesystem.
+   */
+  saveName: string;
+  saveLocationInfo: string;
+  /**
+   * Path to the map package this save game file is based on.
+   */
+  mapName: string;
+  /**
+   * Additional Map URL options this save game was saved with.
+   */
+  mapOptions: string;
+  /**
+   * Name of the session this save game file belongs to.
+   */
+  sessionName: string;
+  /**
+   * Amount of seconds the game has been running for in total since the session was created.
+   */
+  playDurationSeconds: number;
+  /**
+   * Date and time on which the save game file was saved.
+   */
+  saveDateTime: string;
+  /**
+   * True if this save game file was saved with mods.
+   */
+  isModdedSave: boolean;
+  /**
+   * True if this save game file has been edited by third party tools.
+   */
+  isEditedSave: boolean;
+  /**
+   * True if Advanced Game Settings are enabled for this save game.
+   */
+  isCreativeModeEnabled: boolean;
+}
+
+export interface SessionSaveStruct {
+  /**
+   * Name of the save session.
+   */
+  sessionName: string;
+  /**
+   * All save game files belonging to this session.
+   */
+  saveHeaders: SaveHeader[];
+}
+
+export type EnumerateSessionsRequest = ApiRequest<"EnumerateSessions">;
+
+export type EnumerateSessionsResponseData = {
+  /**
+   * List of sessions available on the Dedicated Server.
+   */
+  sessions: SessionSaveStruct[];
+  /**
+   * Index of the currently selected session in the list.
+   */
+  currentSessionIndex: number;
+};
+
+export type EnumerateSessionsResponse =
+  ApiSuccessResponse<EnumerateSessionsResponseData>;
+
+export const buildEnumerateSessions = buildApiRequest<
+  EnumerateSessionsRequest,
+  EnumerateSessionsResponse
+>("v1", {
+  function: "EnumerateSessions",
+});

src/v1/error.ts

@@ -52,3 +52,7 @@ export interface CannotResetAdminPasswordErrorResponse extends ErrorResponse {
 export interface SaveGameFailedErrorResponse extends ErrorResponse {
   errorCode: "save_game_failed";
 }
+
+export interface EnumerateSessionsFailedErrorResponse extends ErrorResponse {
+  errorCode: "enumerate_sessions_failed";
+}

src/v1/index.ts

@@ -3,6 +3,7 @@ import { buildApplyServerOptions } from "./ApplyServerOptions.js";
 import { buildClaimServer } from "./ClaimServer.js";
 import type { InternalClientOptions } from "./common.js";
 import { buildCreateNewGame } from "./CreateNewGame.js";
+import { buildEnumerateSessions } from "./EnumerateSessions.js";
 import { buildGetAdvancedGameSettings } from "./GetAdvancedGameSettings.js";
 import { buildGetServerOptions } from "./GetServerOptions.js";
 import { buildHealthCheck } from "./HealthCheck.js";
@@ -158,6 +159,14 @@ export function buildV1(options: InternalClientOptions) {
      * Function does not return any data on success.
      */
     SaveGame: buildSaveGame(options),
+    /**
+     * Enumerates all save game files available on the Dedicated Server.
+     *
+     * Requires Admin privileges.
+     *
+     * Function does not require any additional parameters.
+     */
+    EnumerateSessions: buildEnumerateSessions(options),
   };
 }
 
@@ -166,6 +175,7 @@ export type * from "./ApplyServerOptions.js";
 export type * from "./ClaimServer.js";
 export type * from "./common.js";
 export type * from "./CreateNewGame.js";
+export type * from "./EnumerateSessions.js";
 export type * from "./error.js";
 export type * from "./GetAdvancedGameSettings.js";
 export type * from "./GetServerOptions.js";

test.js

@@ -87,3 +87,7 @@ client.v1
   .then((response) => {
     console.log("RenameServer Response:", typeof response);
   });
+
+client.v1.EnumerateSessions().then((response) => {
+  console.log("EnumerateSessions Response:", response);
+});