SDK-2579: Add support for suppressing certain screens on the end-user flow

Author: MrBurtyyy

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

@@ -1,5 +1,8 @@
 package com.yoti.api.client.docs.session.create;
 
+import java.util.ArrayList;
+import java.util.List;
+
 import com.yoti.api.client.docs.DocScanConstants;
 
 import com.fasterxml.jackson.annotation.JsonProperty;
@@ -54,6 +57,9 @@ public class SdkConfig {
     @JsonProperty(Property.BIOMETRIC_CONSENT_FLOW)
     private final String biometricConsentFlow;
 
+    @JsonProperty(Property.SUPPRESSED_SCREENS)
+    private final List<String> suppressedScreens;
+
     SdkConfig(String allowedCaptureMethods,
             String primaryColour,
             String primaryColourDarkMode,
@@ -68,7 +74,7 @@ public class SdkConfig {
             Boolean allowHandoff,
             AttemptsConfiguration attemptsConfiguration,
             String brandId,
-            String biometricConsentFlow) {
+            String biometricConsentFlow, List<String> suppressedScreens) {
         this.allowedCaptureMethods = allowedCaptureMethods;
         this.primaryColour = primaryColour;
         this.primaryColourDarkMode = primaryColourDarkMode;
@@ -84,6 +90,7 @@ public class SdkConfig {
         this.attemptsConfiguration = attemptsConfiguration;
         this.brandId = brandId;
         this.biometricConsentFlow = biometricConsentFlow;
+        this.suppressedScreens = suppressedScreens;
     }
 
     public static SdkConfig.Builder builder() {
@@ -225,6 +232,15 @@ public String getBiometricConsentFlow() {
         return biometricConsentFlow;
     }
 
+    /**
+     * The list of screens to suppress in the end-user flow
+     *
+     * @return the list of suppressed screens
+     */
+    public List<String> getSuppressedScreens() {
+        return suppressedScreens;
+    }
+
     /**
      * Builder to assist in the creation of {@link SdkConfig}.
      */
@@ -245,8 +261,10 @@ public static class Builder {
         private AttemptsConfiguration attemptsConfiguration;
         private String brandId;
         private String biometricConsentFlow;
+        private List<String> suppressedScreens;
 
-        private Builder() {}
+        private Builder() {
+        }
 
         /**
          * Sets the allowed capture method to "CAMERA"
@@ -476,6 +494,20 @@ public Builder withBiometricConsentFlowJustInTime() {
             return withBiometricConsentFlow(DocScanConstants.JUST_IN_TIME);
         }
 
+        /**
+         * Add a named screen to the list of suppressed screen in the end-user flow
+         *
+         * @param suppressedScreen the name of the screen to suppress
+         * @return the builder
+         */
+        public Builder withSuppressedScreen(String suppressedScreen) {
+            if (suppressedScreens == null) {
+                suppressedScreens = new ArrayList<>();
+            }
+            suppressedScreens.add(suppressedScreen);
+            return this;
+        }
+
         /**
          * Builds the {@link SdkConfig} using the values supplied to the builder
          *
@@ -497,7 +529,8 @@ public SdkConfig build() {
                     allowHandoff,
                     attemptsConfiguration,
                     brandId,
-                    biometricConsentFlow
+                    biometricConsentFlow,
+                    suppressedScreens
             );
         }
     }
@@ -519,8 +552,10 @@ private static final class Property {
         private static final String ATTEMPTS_CONFIGURATION = "attempts_configuration";
         private static final String BRAND_ID = "brand_id";
         private static final String BIOMETRIC_CONSENT_FLOW = "biometric_consent_flow";
+        private static final String SUPPRESSED_SCREENS = "suppressed_screens";
 
-        private Property() {}
+        private Property() {
+        }
 
     }
 

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

@@ -20,6 +20,8 @@ public class SdkConfigTest {
     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";
+    private static final String SOME_SUPPRESSED_SCREEN = "someSuppressedScreen";
+    private static final String SOME_OTHER_SUPPRESSED_SCREEN = "someOtherSuppressedScreen";
 
     private static final String SOME_SUCCESS_URL = "https://yourdomain.com/some/success/endpoint";
     private static final String SOME_ERROR_URL = "https://yourdomain.com/some/error/endpoint";
@@ -44,6 +46,8 @@ public void shouldBuildSimpleSdkConfigWithAllOptions() {
                 .withAllowHandoff(true)
                 .withAttemptsConfiguration(attemptsConfigurationMock)
                 .withBrandId(SOME_BRAND_ID)
+                .withSuppressedScreen(SOME_SUPPRESSED_SCREEN)
+                .withSuppressedScreen(SOME_OTHER_SUPPRESSED_SCREEN)
                 .build();
 
         assertThat(result, is(instanceOf(SdkConfig.class)));
@@ -62,6 +66,8 @@ public void shouldBuildSimpleSdkConfigWithAllOptions() {
         assertThat(result.getAllowHandoff(), is(true));
         assertThat(result.getAttemptsConfiguration(), is(attemptsConfigurationMock));
         assertThat(result.getBrandId(), is(SOME_BRAND_ID));
+        assertThat(result.getSuppressedScreens(), hasSize(2));
+        assertThat(result.getSuppressedScreens(), hasItems(SOME_SUPPRESSED_SCREEN, SOME_OTHER_SUPPRESSED_SCREEN));
     }
 
     @Test
@@ -145,4 +151,12 @@ public void shouldSetDarkModeToAuto() {
         assertThat(result.getDarkMode(), is("AUTO"));
     }
 
+    @Test
+    public void suppressedScreens_shouldBeNullIfNotSet() {
+        SdkConfig result = SdkConfig.builder()
+                .build();
+
+        assertThat(result.getSuppressedScreens(), is(nullValue()));
+    }
+
 }