SDK-2615: PHP - Support configuration for IDV shortened flow - php

.claude/settings.local.json

@@ -0,0 +1,9 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(git rev-list *)",
+      "Bash(./vendor/bin/phpunit --filter 'SdkConfigBuilderTest|SessionConfigurationResponseTest')",
+      "Bash(git config *)"
+    ]
+  }
+}

src/DocScan/Session/Create/SdkConfig.php

@@ -296,4 +296,19 @@ public function getSuppressedScreens(): ?array
     {
         return $this->suppressedScreens;
     }
+
+    /**
+     * Returns true when the given screen identifier has been configured to be suppressed.
+     *
+     * @param string $screenIdentifier
+     * @return bool
+     */
+    public function isScreenSuppressed(string $screenIdentifier): bool
+    {
+        if ($this->suppressedScreens === null) {
+            return false;
+        }
+
+        return in_array($screenIdentifier, $this->suppressedScreens, true);
+    }
 }

src/DocScan/Session/Create/SuppressedScreen.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yoti\DocScan\Session\Create;
+
+class SuppressedScreen
+{
+    public const ID_DOCUMENT_EDUCATION = 'ID_DOCUMENT_EDUCATION';
+    public const ID_DOCUMENT_REQUIREMENTS = 'ID_DOCUMENT_REQUIREMENTS';
+    public const SUPPLEMENTARY_DOCUMENT_EDUCATION = 'SUPPLEMENTARY_DOCUMENT_EDUCATION';
+    public const ZOOM_LIVENESS_EDUCATION = 'ZOOM_LIVENESS_EDUCATION';
+    public const STATIC_LIVENESS_EDUCATION = 'STATIC_LIVENESS_EDUCATION';
+    public const FACE_CAPTURE_EDUCATION = 'FACE_CAPTURE_EDUCATION';
+    public const FLOW_COMPLETION = 'FLOW_COMPLETION';
+}

tests/DocScan/Session/Create/SdkConfigBuilderTest.php

@@ -4,6 +4,7 @@
 
 use Yoti\DocScan\Constants;
 use Yoti\DocScan\Session\Create\SdkConfigBuilder;
+use Yoti\DocScan\Session\Create\SuppressedScreen;
 use Yoti\Test\TestCase;
 
 /**
@@ -440,4 +441,114 @@ public function shouldNotIncludeSuppressedScreensInJsonWhenNull()
         $jsonData = $result->jsonSerialize();
         $this->assertFalse(property_exists($jsonData, 'suppressed_screens'));
     }
+
+    /**
+     * @test
+     * @covers ::withSuppressedScreens
+     * @covers \Yoti\DocScan\Session\Create\SdkConfig::getSuppressedScreens
+     */
+    public function shouldAllowEmptySuppressedScreensArray()
+    {
+        $result = (new SdkConfigBuilder())
+            ->withSuppressedScreens([])
+            ->build();
+
+        $this->assertSame([], $result->getSuppressedScreens());
+    }
+
+    /**
+     * @test
+     * @covers ::withSuppressedScreens
+     * @covers \Yoti\DocScan\Session\Create\SdkConfig::getSuppressedScreens
+     */
+    public function shouldBuildUsingSuppressedScreenConstants()
+    {
+        $suppressedScreens = [
+            SuppressedScreen::ID_DOCUMENT_EDUCATION,
+            SuppressedScreen::ID_DOCUMENT_REQUIREMENTS,
+            SuppressedScreen::SUPPLEMENTARY_DOCUMENT_EDUCATION,
+            SuppressedScreen::ZOOM_LIVENESS_EDUCATION,
+            SuppressedScreen::STATIC_LIVENESS_EDUCATION,
+            SuppressedScreen::FACE_CAPTURE_EDUCATION,
+            SuppressedScreen::FLOW_COMPLETION,
+        ];
+
+        $result = (new SdkConfigBuilder())
+            ->withSuppressedScreens($suppressedScreens)
+            ->build();
+
+        $this->assertEquals($suppressedScreens, $result->getSuppressedScreens());
+    }
+
+    /**
+     * @test
+     * @covers \Yoti\DocScan\Session\Create\SuppressedScreen
+     */
+    public function suppressedScreenConstantsShouldHaveExpectedValues()
+    {
+        $this->assertSame('ID_DOCUMENT_EDUCATION', SuppressedScreen::ID_DOCUMENT_EDUCATION);
+        $this->assertSame('ID_DOCUMENT_REQUIREMENTS', SuppressedScreen::ID_DOCUMENT_REQUIREMENTS);
+        $this->assertSame(
+            'SUPPLEMENTARY_DOCUMENT_EDUCATION',
+            SuppressedScreen::SUPPLEMENTARY_DOCUMENT_EDUCATION
+        );
+        $this->assertSame('ZOOM_LIVENESS_EDUCATION', SuppressedScreen::ZOOM_LIVENESS_EDUCATION);
+        $this->assertSame('STATIC_LIVENESS_EDUCATION', SuppressedScreen::STATIC_LIVENESS_EDUCATION);
+        $this->assertSame('FACE_CAPTURE_EDUCATION', SuppressedScreen::FACE_CAPTURE_EDUCATION);
+        $this->assertSame('FLOW_COMPLETION', SuppressedScreen::FLOW_COMPLETION);
+    }
+
+    /**
+     * @test
+     * @covers \Yoti\DocScan\Session\Create\SdkConfig::isScreenSuppressed
+     */
+    public function isScreenSuppressedShouldReturnTrueForListedScreen()
+    {
+        $result = (new SdkConfigBuilder())
+            ->withSuppressedScreens([
+                SuppressedScreen::ID_DOCUMENT_EDUCATION,
+                SuppressedScreen::FLOW_COMPLETION,
+            ])
+            ->build();
+
+        $this->assertTrue($result->isScreenSuppressed(SuppressedScreen::ID_DOCUMENT_EDUCATION));
+        $this->assertTrue($result->isScreenSuppressed(SuppressedScreen::FLOW_COMPLETION));
+    }
+
+    /**
+     * @test
+     * @covers \Yoti\DocScan\Session\Create\SdkConfig::isScreenSuppressed
+     */
+    public function isScreenSuppressedShouldReturnFalseForUnlistedScreen()
+    {
+        $result = (new SdkConfigBuilder())
+            ->withSuppressedScreen(SuppressedScreen::ID_DOCUMENT_EDUCATION)
+            ->build();
+
+        $this->assertFalse($result->isScreenSuppressed(SuppressedScreen::FLOW_COMPLETION));
+    }
+
+    /**
+     * @test
+     * @covers \Yoti\DocScan\Session\Create\SdkConfig::isScreenSuppressed
+     */
+    public function isScreenSuppressedShouldReturnFalseWhenSuppressedScreensIsNull()
+    {
+        $result = (new SdkConfigBuilder())->build();
+
+        $this->assertFalse($result->isScreenSuppressed(SuppressedScreen::ID_DOCUMENT_EDUCATION));
+    }
+
+    /**
+     * @test
+     * @covers \Yoti\DocScan\Session\Create\SdkConfig::isScreenSuppressed
+     */
+    public function isScreenSuppressedShouldBeCaseSensitive()
+    {
+        $result = (new SdkConfigBuilder())
+            ->withSuppressedScreen(SuppressedScreen::ID_DOCUMENT_EDUCATION)
+            ->build();
+
+        $this->assertFalse($result->isScreenSuppressed('id_document_education'));
+    }
 }