Release/4.12.0

[laurent-yoti]

NEW

IDV session configuration suppressed_screens

    .withSdkConfig(
      new SdkConfigBuilder()
        .withLocale('en-GB')
        // ...more options
        // [NEW] option to set which screens should be suppressed
        .withSuppressedScreens([
          'ID_DOCUMENT_EDUCATION',
          'ID_DOCUMENT_REQUIREMENTS',
        ])
        .build()
    )

IDV session result breakdown item now includes process

      const session = await getSession('some-id');
      const [firstAuthenticityCheck] = session.getAuthenticityChecks()
      const report = firstAuthenticityCheck.getReport();
      const [firstBreakdownItem] = report.getBreakdown();
      // [NEW] method to get the process
      const process = firstBreakdownItem.getProcess();
      console.log(process); // 'AUTOMATED' or 'EXPERT_REVIEW'

[Copilot]

Pull Request Overview

This PR adds support for suppressed screens configuration in IDV sessions and exposes process information in breakdown responses, while updating the SDK version to 4.12.0.

Key changes:

• Added suppressedScreens parameter to SdkConfig and SdkConfigBuilder to allow specifying screens to be hidden in the IDV flow
• Added process field to BreakdownResponse to indicate whether a check was processed via 'AUTOMATED' or 'EXPERT_REVIEW'
• Updated version from 4.11.1 to 4.12.0 across all package files

Reviewed Changes

Copilot reviewed 14 out of 24 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
types/src/idv_service/session/retrieve/breakdown.response.d.ts	Added TypeScript definitions for the new process field and getProcess() method
types/src/idv_service/session/create/sdk.config.d.ts	Added TypeScript definitions for the new suppressedScreens parameter
types/src/idv_service/session/create/sdk.config.builder.d.ts	Added TypeScript definitions for withSuppressedScreens() builder method
src/idv_service/session/retrieve/breakdown.response.js	Implemented process field extraction and getProcess() method
src/idv_service/session/create/sdk.config.js	Implemented suppressedScreens parameter validation and serialization
src/idv_service/session/create/sdk.config.builder.js	Implemented withSuppressedScreens() builder method
tests/idv_service/session/retrieve/breakdown.response.spec.js	Added test coverage for getProcess() method
tests/idv_service/session/create/sdk.config.builder.test.js	Added test coverage for suppressedScreens in the builder
examples/idv/src/controllers/use-cases/suppressed.screens.check.controller.js	Added new example demonstrating suppressed screens usage
examples/idv/src/useCases.js	Added suppressed screens use case configuration
examples/idv/src/routes/use-cases-router.js	Registered suppressed screens controller
examples/idv/src/controllers/use-cases/index.js	Exported suppressed screens controller
examples/idv/views/pages/partials/check.ejs	Added UI to display process information
examples/idv-identity-checks/views/pages/partials/check.ejs	Added UI to display process information
examples/idv/package.json	Updated express-session dependency to 1.18.2
package.json	Updated SDK version to 4.12.0
sonar-project.properties	Updated project version to 4.12.0
package-lock.json	Updated version and lockfile entries
examples/*/package-lock.json	Updated version references across all examples

Files not reviewed (6)

• examples/aml-check/package-lock.json: Language not supported
• examples/digital-identity/package-lock.json: Language not supported
• examples/idv-identity-checks/package-lock.json: Language not supported
• examples/idv/package-lock.json: Language not supported
• examples/profile-identity-checks/package-lock.json: Language not supported
• examples/profile/package-lock.json: Language not supported

Comments suppressed due to low confidence (1)

tests/idv_service/session/create/sdk.config.builder.test.js:52

• There is no test coverage for building an SdkConfig without the suppressedScreens parameter to verify that the field is handled correctly when omitted. This is important since suppressedScreens is optional and line 132 in sdk.config.js may serialize it as undefined.

  it('should build SdkConfig with allows camera and upload', () => {
    const sdkConfig = new SdkConfigBuilder()
      .withAllowsCameraAndUpload()
      .build();

    const expectedJson = JSON.stringify({
      allowed_capture_methods: 'CAMERA_AND_UPLOAD',
    });

    expect(JSON.stringify(sdkConfig)).toBe(expectedJson);
  });

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.