feat: add PasswordlessLogin

Author: Shinigami92

src/index.ts

@@ -1,5 +1,6 @@
 export { createClient } from "./client.js";
 export type { Client, ClientOptions } from "./client.js";
+export { PrivilegeLevel } from "./v1/common.js";
 export type {
   ApiRequest,
   ApiSuccessResponse,
@@ -17,6 +18,9 @@ export type {
   InsufficientScopeErrorResponse,
   InvalidTokenErrorResponse,
   MissingParamsErrorResponse,
+  PasswordlessLoginRequest,
+  PasswordlessLoginResponse,
+  PasswordlessLoginResponseData,
   QueryServerStateRequest,
   QueryServerStateResponse,
   QueryServerStateResponseData,

src/v1/PasswordlessLogin.ts

@@ -0,0 +1,33 @@
+import type {
+  ApiRequest,
+  ApiSuccessResponse,
+  PrivilegeLevel,
+} from "./common.js";
+import { buildApiRequest } from "./common.js";
+
+export type PasswordlessLoginRequest = ApiRequest<
+  "PasswordlessLogin",
+  {
+    /**
+     * Minimum privilege level to attempt to acquire by logging in.
+     */
+    minimumPrivilegeLevel: `${PrivilegeLevel}`;
+  }
+>;
+
+export type PasswordlessLoginResponseData = {
+  /**
+   * Authentication Token in case login is successful.
+   */
+  authenticationToken: string;
+};
+
+export type PasswordlessLoginResponse =
+  ApiSuccessResponse<PasswordlessLoginResponseData>;
+
+export const buildPasswordlessLogin = buildApiRequest<
+  PasswordlessLoginRequest,
+  PasswordlessLoginResponse
+>("v1", {
+  function: "PasswordlessLogin",
+});

src/v1/common.ts

@@ -49,3 +49,26 @@ export interface InternalClientOptions {
    */
   accessToken: string;
 }
+
+export enum PrivilegeLevel {
+  /**
+   * The client is not Authenticated.
+   */
+  NotAuthenticated = "NotAuthenticated",
+  /**
+   * Client is Authenticated with Client privileges.
+   */
+  Client = "Client",
+  /**
+   * Client is Authenticated with Admin privileges.
+   */
+  Administrator = "Administrator",
+  /**
+   * Client is Authenticated as Initial Admin with privileges to Claim the server.
+   */
+  InitialAdmin = "InitialAdmin",
+  /**
+   * Client is Authenticated as Third Party Application.
+   */
+  APIToken = "APIToken",
+}

src/v1/index.ts

@@ -2,6 +2,7 @@ import type { InternalClientOptions } from "./common.js";
 import { buildGetAdvancedGameSettings } from "./GetAdvancedGameSettings.js";
 import { buildGetServerOptions } from "./GetServerOptions.js";
 import { buildHealthCheck } from "./HealthCheck.js";
+import { buildPasswordlessLogin } from "./PasswordlessLogin.js";
 import { buildQueryServerState } from "./QueryServerState.js";
 import { buildVerifyAuthenticationToken } from "./VerifyAuthenticationToken.js";
 
@@ -19,6 +20,14 @@ export function buildV1(options: InternalClientOptions) {
      * This function does not require input parameters and does not return any data.
      */
     VerifyAuthenticationToken: buildVerifyAuthenticationToken(options),
+    /**
+     * Attempts to perform a passwordless login to the Dedicated Server as a player.
+     *
+     * Passwordless login is possible if the Dedicated Server is not claimed, or if Client Protection Password is not set for the Dedicated Server.
+     *
+     * This function requires no Authentication.
+     */
+    PasswordlessLogin: buildPasswordlessLogin(options),
     /**
      * Retrieves the current state of the Dedicated Server.
      */
@@ -39,5 +48,6 @@ export type * from "./error.js";
 export type * from "./GetAdvancedGameSettings.js";
 export type * from "./GetServerOptions.js";
 export type * from "./HealthCheck.js";
+export type * from "./PasswordlessLogin.js";
 export type * from "./QueryServerState.js";
 export type * from "./VerifyAuthenticationToken.js";

test.js

@@ -1,6 +1,6 @@
 // @ts-check
 import { env } from "node:process";
-import { createClient } from "./dist/index.js";
+import { createClient, PrivilegeLevel } from "./dist/index.js";
 
 env.NODE_TLS_REJECT_UNAUTHORIZED = "0";
 
@@ -33,3 +33,13 @@ client.v1.GetServerOptions().then((response) => {
 client.v1.GetAdvancedGameSettings().then((response) => {
   console.log("GetAdvancedGameSettings Response:", response);
 });
+
+client.v1
+  .PasswordlessLogin({
+    data: {
+      minimumPrivilegeLevel: PrivilegeLevel.NotAuthenticated,
+    },
+  })
+  .then((response) => {
+    console.log("PasswordlessLogin Response:", response);
+  });