Refactor Client to use Client object

Author: gcatanese

src/client.ts

@@ -1,94 +1,103 @@
 import Config from "./config";
+import { TERMINAL_API_ENDPOINT_TEST } from "./config";
+
 import HttpURLConnectionClient from "./httpClient/httpURLConnectionClient";
 import ClientInterface from "./httpClient/clientInterface";
 
-type ClientParametersOverload =
-| { config: Config }
-| { config: Config; httpClient: ClientInterface }
-| { username: string; password: string; environment: Environment}
-| { username: string; password: string; environment: Environment; httpClient: ClientInterface }
-| { username: string; password: string; environment: Environment; liveEndpointUrlPrefix: string }
-| { username: string; password: string; environment: Environment; liveEndpointUrlPrefix: string; httpClient: ClientInterface }
-| { username: string; password: string; environment: Environment; applicationName: string }
-| { username: string; password: string; environment: Environment; applicationName: string; httpClient: ClientInterface }
-| { username: string; password: string; environment: Environment; applicationName: string; liveEndpointUrlPrefix: string }
-| { username: string; password: string; environment: Environment; applicationName: string; liveEndpointUrlPrefix: string; httpClient: ClientInterface }
-| { apiKey: string; environment: Environment }
-| { apiKey: string; environment: Environment; httpClient: ClientInterface }
-| { apiKey: string; environment: Environment; liveEndpointUrlPrefix: string }
-| { apiKey: string; environment: Environment; liveEndpointUrlPrefix: string; httpClient: ClientInterface };
-
-interface ClientParameters {
-    config?: Config;
-    username?: string;
-    password?: string;
-    environment?: Environment;
-    applicationName?: string;
-    liveEndpointUrlPrefix?: string;
-    apiKey?: string;
-    httpClient?: ClientInterface;
-}
 
+/**
+ * Main Adyen API Client class.
+ * Handles configuration, authentication, and HTTP client setup for API requests.
+ */
 class Client {
+    // Static endpoints and API version constants
+    // @deprecated: use Config.TERMINAL_API_ENDPOINT_TEST instead
+    public static TERMINAL_API_ENDPOINT_TEST = "https://terminal-api-test.adyen.com";
+    // @deprecated: use Config.TERMINAL_API_ENDPOINT_LIVE instead
+    public static TERMINAL_API_ENDPOINT_LIVE = "https://terminal-api-live.adyen.com";
+    // legacy support for marketPayEndpoint
     public static MARKETPAY_ENDPOINT_TEST = "https://cal-test.adyen.com/cal/services";
     public static MARKETPAY_ENDPOINT_LIVE = "https://cal-live.adyen.com/cal/services";
     public static MARKETPAY_ACCOUNT_API_VERSION = "v6";
     public static MARKETPAY_FUND_API_VERSION = "v6";
     public static MARKETPAY_HOP_API_VERSION = "v6";
     public static MARKETPAY_NOTIFICATION_API_VERSION = "v5";
     public static MARKETPAY_NOTIFICATION_CONFIGURATION_API_VERSION = "v6";
-    public static TERMINAL_API_ENDPOINT_TEST = "https://terminal-api-test.adyen.com";
-    public static TERMINAL_API_ENDPOINT_LIVE = "https://terminal-api-live.adyen.com";
+
 
     private _httpClient!: ClientInterface;
     public config: Config;
-    public liveEndpointUrlPrefix: string;
-
-    public constructor(clientParameters: ClientParametersOverload);
-    public constructor(options: ClientParameters) {
-        if (options.config) {
-            this.config = options.config;
-        } else {
-            this.config = new Config();
+
+    /**
+     * Constructs a new Client instance.
+     * @param options - Configuration object
+     */
+    public constructor(options: Config, httpClient?: ClientInterface) {
+        
+        this.config = options;
+
+        if (!this.config.environment) {
+            throw new Error("Environment must be defined");
         }
-        this.liveEndpointUrlPrefix = options.liveEndpointUrlPrefix ?? "";
-
-        const environment = options.environment ?? this.config.environment;
-        if (environment) {
-            this.setEnvironment(environment, options.liveEndpointUrlPrefix);
-            if (options.username && options.password) {
-                this.config.username = options.username;
-                this.config.password = options.password;
-            }
 
-            if (options.apiKey) {
-                this.config.apiKey = options.apiKey;
+        // set Terminal API endpoints 
+        if (this.config.environment === "TEST") {
+            // one TEST endpoint for all regions
+            this.config.terminalApiCloudEndpoint = TERMINAL_API_ENDPOINT_TEST;
+        } else if (this.config.environment === "LIVE") {
+            // region-based LIVE endpoints
+            if(this.config.region) {
+                if (!Config.isRegionValid(this.config.region)) {
+                    throw new Error(`Invalid region provided: ${this.config.region}`);
+                }
+                this.config.terminalApiCloudEndpoint = Config.getTerminalApiEndpoint(this.config.region);  
+            } else {
+                console.info("TerminalAPI Region is not be defined: ignore this if you are not using Terminal API.");
             }
         }
 
+        if(this.config.environment === "LIVE" && !this.config.liveEndpointUrlPrefix) {
+            throw new Error("Live endpoint URL prefix must be provided for LIVE environment.");
+        }
+
+        // legacy support for marketPayEndpoint
+        if (this.config.environment === "TEST") {
+            this.config.marketPayEndpoint = Client.MARKETPAY_ENDPOINT_TEST;
+        } else if (this.config.environment === "LIVE") {
+            this.config.marketPayEndpoint = Client.MARKETPAY_ENDPOINT_LIVE;
+        }
+
+        // Set application name if provided
         if(options.applicationName) {
             this.config.applicationName = options.applicationName;
         }
 
-        if (options.httpClient) {
-            this._httpClient = options.httpClient;
+        // Set custom HTTP client if provided
+        if (httpClient) {
+            this._httpClient = httpClient;
         }
+
     }
 
+    /**
+     * Sets the environment and updates endpoints in the config.
+     * @param environment - The environment ("TEST" or "LIVE").
+     * @param liveEndpointUrlPrefix - Optional live endpoint prefix.
+     */
     public setEnvironment(environment: Environment, liveEndpointUrlPrefix?: string): void {
-        // ensure environment and liveUrlPrefix is set in config
+        // ensure environment is set in config
         this.config.environment = environment;
-        this.liveEndpointUrlPrefix = liveEndpointUrlPrefix ?? "";
 
         if (environment === "TEST") {
             this.config.marketPayEndpoint = Client.MARKETPAY_ENDPOINT_TEST;
-            this.config.terminalApiCloudEndpoint = Client.TERMINAL_API_ENDPOINT_TEST;
         } else if (environment === "LIVE") {
             this.config.marketPayEndpoint = Client.MARKETPAY_ENDPOINT_LIVE;
-            this.config.terminalApiCloudEndpoint = Client.TERMINAL_API_ENDPOINT_LIVE;
         }
     }
 
+    /**
+     * Gets the HTTP client instance, creating a default one if not set.
+     */
     public get httpClient(): ClientInterface {
         if (!this._httpClient) {
             this._httpClient = new HttpURLConnectionClient();
@@ -97,17 +106,30 @@ class Client {
         return this._httpClient;
     }
 
+    /**
+     * Sets a custom HTTP client.
+     * @param httpClient - The HTTP client to use.
+     */
     public set httpClient(httpClient: ClientInterface) {
         this._httpClient = httpClient;
     }
 
+    /**
+     * Sets the application name in the config.
+     * @param applicationName - The application name.
+     */
     public setApplicationName(applicationName: string): void {
         this.config.applicationName = applicationName;
     }
 
+    /**
+     * Sets the connection timeout in milliseconds.
+     * @param connectionTimeoutMillis - Timeout in milliseconds.
+     */
     public setTimeouts(connectionTimeoutMillis: number): void {
         this.config.connectionTimeoutMillis = connectionTimeoutMillis;
     }
 }
 
 export default Client;
+