SDK-2486: Add support for dark mode to be set at sdk config creation

Author: Artem Lukyanau

yoti-sdk-api/src/main/java/com/yoti/api/client/docs/DocScanConstants.java

@@ -86,4 +86,8 @@ private DocScanConstants() { }
     public static final String EAGER = "EAGER";
     public static final String JUST_IN_TIME = "JUST_IN_TIME";
 
+    public static final String ON = "ON";
+    public static final String OFF = "OFF";
+    public static final String AUTO = "AUTO";
+
 }

yoti-sdk-api/src/main/java/com/yoti/api/client/docs/session/create/SdkConfig.java

@@ -24,6 +24,9 @@ public class SdkConfig {
     @JsonProperty(Property.FONT_COLOUR)
     private final String fontColour;
 
+    @JsonProperty(Property.DARK_MODE)
+    private final String darkMode;
+
     @JsonProperty(Property.LOCALE)
     private final String locale;
 
@@ -57,6 +60,7 @@ public class SdkConfig {
             String secondaryColour,
             String fontColour,
             String locale,
+            String darkMode,
             String presetIssuingCountry,
             String successUrl,
             String errorUrl,
@@ -71,6 +75,7 @@ public class SdkConfig {
         this.secondaryColour = secondaryColour;
         this.fontColour = fontColour;
         this.locale = locale;
+        this.darkMode = darkMode;
         this.presetIssuingCountry = presetIssuingCountry;
         this.successUrl = successUrl;
         this.errorUrl = errorUrl;
@@ -104,7 +109,7 @@ public String getPrimaryColour() {
     }
 
     /**
-     * The primary colour for the dark mode
+     * The primary colour for dark mode, configured for the session
      *
      * @return the primary colour
      */
@@ -139,6 +144,15 @@ public String getLocale() {
         return locale;
     }
 
+    /**
+     * The dark mode option configured for the session
+     *
+     * @return the dark mode
+     */
+    public String getDarkMode() {
+        return darkMode;
+    }
+
     /**
      * The preset issuing country
      *
@@ -222,6 +236,7 @@ public static class Builder {
         private String secondaryColour;
         private String fontColour;
         private String locale;
+        private String darkMode;
         private String presetIssuingCountry;
         private String successUrl;
         private String errorUrl;
@@ -317,6 +332,47 @@ public Builder withLocale(String locale) {
             return this;
         }
 
+        /**
+         * Sets the dark mode to be used by the web/native client
+         *
+         * @param darkMode the dark mode, e.g. "ON"
+         * @return the builder
+         */
+        public Builder withDarkMode(String darkMode) {
+            this.darkMode = darkMode;
+            return this;
+        }
+
+        /**
+         * Sets the dark mode to 'ON' to be used by the web/native client
+         *
+         * @return the builder
+         */
+        public Builder withDarkModeOn() {
+            this.darkMode = DocScanConstants.ON;
+            return this;
+        }
+
+        /**
+         * Sets the dark mode to 'OFF' to be used by the web/native client
+         *
+         * @return the builder
+         */
+        public Builder withDarkModeOff() {
+            this.darkMode = DocScanConstants.OFF;
+            return this;
+        }
+
+        /**
+         * Sets the dark mode to 'AUTO' to be used by the web/native client
+         *
+         * @return the builder
+         */
+        public Builder withDarkModeAuto() {
+            this.darkMode = DocScanConstants.AUTO;
+            return this;
+        }
+
         /**
          * Sets the preset issuing country used by the web/native client
          *
@@ -436,6 +492,7 @@ public SdkConfig build() {
                     secondaryColour,
                     fontColour,
                     locale,
+                    darkMode,
                     presetIssuingCountry,
                     successUrl,
                     errorUrl,
@@ -455,6 +512,7 @@ private static final class Property {
         private static final String PRIMARY_COLOUR_DARK_MODE = "primary_colour_dark_mode";
         private static final String SECONDARY_COLOUR = "secondary_colour";
         private static final String FONT_COLOUR = "font_colour";
+        private static final String DARK_MODE = "dark_mode";
         private static final String LOCALE = "locale";
         private static final String PRESET_ISSUING_COUNTRY = "preset_issuing_country";
         private static final String SUCCESS_URL = "success_url";

yoti-sdk-api/src/test/java/com/yoti/api/client/docs/session/create/SdkConfigTest.java

@@ -17,6 +17,7 @@ public class SdkConfigTest {
     private static final String SOME_SECONDARY_COLOUR = "#679bdd";
     private static final String SOME_FONT_COLOUR = "#b40c12";
     private static final String SOME_LOCALE = "en";
+    private static final String SOME_DARK_MODE = "ON";
     private static final String SOME_PRESET_ISSUING_COUNTRY = "USA";
     private static final String SOME_BRAND_ID = "someBrandId";
 
@@ -35,6 +36,7 @@ public void shouldBuildSimpleSdkConfigWithAllOptions() {
                 .withSecondaryColour(SOME_SECONDARY_COLOUR)
                 .withFontColour(SOME_FONT_COLOUR)
                 .withLocale(SOME_LOCALE)
+                .withDarkMode(SOME_DARK_MODE)
                 .withPresetIssuingCountry(SOME_PRESET_ISSUING_COUNTRY)
                 .withSuccessUrl(SOME_SUCCESS_URL)
                 .withErrorUrl(SOME_ERROR_URL)
@@ -52,6 +54,7 @@ public void shouldBuildSimpleSdkConfigWithAllOptions() {
         assertThat(result.getSecondaryColour(), is(SOME_SECONDARY_COLOUR));
         assertThat(result.getFontColour(), is(SOME_FONT_COLOUR));
         assertThat(result.getLocale(), is(SOME_LOCALE));
+        assertThat(result.getDarkMode(), is(SOME_DARK_MODE));
         assertThat(result.getPresetIssuingCountry(), is(SOME_PRESET_ISSUING_COUNTRY));
         assertThat(result.getSuccessUrl(), is(SOME_SUCCESS_URL));
         assertThat(result.getErrorUrl(), is(SOME_ERROR_URL));
@@ -115,5 +118,31 @@ public void shouldOverridePreviousAllowedCaptureMethods() {
         assertThat(result.getAllowedCaptureMethods(), is("CAMERA"));
     }
 
+    @Test
+    public void shouldSetDarkModeToOn() {
+        SdkConfig result = SdkConfig.builder()
+                .withDarkModeOn()
+                .build();
+
+        assertThat(result.getDarkMode(), is("ON"));
+    }
+
+    @Test
+    public void shouldSetDarkModeToOff() {
+        SdkConfig result = SdkConfig.builder()
+                .withDarkModeOff()
+                .build();
+
+        assertThat(result.getDarkMode(), is("OFF"));
+    }
+
+    @Test
+    public void shouldSetDarkModeToAuto() {
+        SdkConfig result = SdkConfig.builder()
+                .withDarkModeAuto()
+                .build();
+
+        assertThat(result.getDarkMode(), is("AUTO"));
+    }
 
 }