Add and use EnvironmentEnum

Author: gcatanese

src/client.ts

@@ -1,4 +1,4 @@
-import Config from "./config";
+import Config, { EnvironmentEnum } from "./config";
 import { TERMINAL_API_ENDPOINT_TEST } from "./config";
 
 import HttpURLConnectionClient from "./httpClient/httpURLConnectionClient";
@@ -41,10 +41,10 @@ class Client {
         }
 
         // set Terminal API endpoints 
-        if (this.config.environment === "TEST") {
+        if (this.config.environment === EnvironmentEnum.TEST) {
             // one TEST endpoint for all regions
             this.config.terminalApiCloudEndpoint = TERMINAL_API_ENDPOINT_TEST;
-        } else if (this.config.environment === "LIVE") {
+        } else if (this.config.environment === EnvironmentEnum.LIVE) {
             // region-based LIVE endpoints
             if(this.config.region) {
                 if (!Config.isRegionValid(this.config.region)) {
@@ -55,9 +55,9 @@ class Client {
         }
 
         // legacy support for marketPayEndpoint
-        if (this.config.environment === "TEST") {
+        if (this.config.environment === EnvironmentEnum.TEST) {
             this.config.marketPayEndpoint = Client.MARKETPAY_ENDPOINT_TEST;
-        } else if (this.config.environment === "LIVE") {
+        } else if (this.config.environment === EnvironmentEnum.LIVE) {
             this.config.marketPayEndpoint = Client.MARKETPAY_ENDPOINT_LIVE;
         }
 

src/config.ts

@@ -8,6 +8,15 @@ const TERMINAL_API_ENDPOINT_AU_LIVE = "https://terminal-api-au.adyen.com";
 const TERMINAL_API_ENDPOINT_US_LIVE = "https://terminal-api-us.adyen.com";
 const TERMINAL_API_ENDPOINT_APSE_LIVE = "https://terminal-api-apse.adyen.com";
 
+
+/**
+ * Supported environments for the Adyen APIs.
+ */
+export enum EnvironmentEnum {
+  LIVE = "LIVE",
+  TEST = "TEST"
+}
+
 /**
  * Supported Regions for Terminal API integration.
  */
@@ -30,7 +39,7 @@ export const TERMINAL_API_ENDPOINTS_MAP: Record<RegionEnum, string> = {
 interface ConfigConstructor {
     username?: string;
     password?: string;
-    environment?: Environment;
+    environment?: EnvironmentEnum;
     marketPayEndpoint?: string;
     applicationName?: string;
     apiKey?: string;
@@ -48,7 +57,7 @@ class Config {
 
     public username?: string;
     public password?: string;
-    public environment?: Environment;
+    public environment?: EnvironmentEnum;
     public marketPayEndpoint?: string;
     public applicationName?: string;
     public apiKey?: string;
@@ -75,6 +84,15 @@ class Config {
         if (options.region) this.region = options.region;
     }
 
+    /**
+     * Checks if the provided environment is valid.
+     * @param environment - The environment to validate.
+     * @returns true if the environment exists in EnvironmentEnum, false otherwise.
+     */
+    public static isEnvironmentValid(environment: EnvironmentEnum): boolean {
+        return Object.values(EnvironmentEnum).includes(environment);
+    }
+
     /**
      * Checks if the provided region is a valid supported.
      * @param region - The region to validate.

src/service.ts

@@ -18,7 +18,7 @@
  */
 
 import Client from "./client";
-import Config from "./config";
+import Config, { EnvironmentEnum } from "./config";
 
 /**
  * Base Service class for all API services.
@@ -48,11 +48,11 @@ class Service {
             throw new Error("Endpoint URL must be provided.");
         }
 
-        if (config.environment !== "LIVE") {
+        if (config.environment !== EnvironmentEnum.LIVE) {
             return url.replace("-live", "-test");
         }
 
-        if(config.environment === "LIVE") {
+        if(config.environment === EnvironmentEnum.LIVE) {
             if(!config?.liveEndpointUrlPrefix) {
                 throw new Error("Live endpoint URL prefix must be provided for LIVE environment.");
             }