Skip to content

Release/4.12.0 #539

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 5 commits into from
Nov 5, 2025
Merged

Release/4.12.0 #539

merged 5 commits into from
Nov 5, 2025

Conversation

@laurent-yoti
Copy link
Collaborator

@laurent-yoti laurent-yoti commented Oct 30, 2025

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'

dependabot bot and others added 4 commits October 24, 2025 09:02
@dependabot @laurent-yoti
Bump on-headers and express-session in /examples/idv
97e8ee0 
Bumps [on-headers](https://github.com/jshttp/on-headers) to 1.1.0 and updates ancestor dependency [express-session](https://github.com/expressjs/session). These dependencies need to be updated together.


Updates `on-headers` from 1.0.2 to 1.1.0
- [Release notes](https://github.com/jshttp/on-headers/releases)
- [Changelog](https://github.com/jshttp/on-headers/blob/master/HISTORY.md)
- [Commits](jshttp/on-headers@v1.0.2...v1.1.0)

Updates `express-session` from 1.18.1 to 1.18.2
- [Release notes](https://github.com/expressjs/session/releases)
- [Changelog](https://github.com/expressjs/session/blob/master/HISTORY.md)
- [Commits](expressjs/session@v1.18.1...v1.18.2)

---
updated-dependencies:
- dependency-name: on-headers
  dependency-version: 1.1.0
  dependency-type: indirect
- dependency-name: express-session
  dependency-version: 1.18.2
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <[email protected]>
@laurent-yoti
SDK-2740 Expose IDV breakdown's process field (#537)
042e9de 
* Added optional 'process' field in BreakdownResponse.
Updated "idv" and "idv-identity-checks" examples view partial "check.ejs".

* Update JSDOC in BreakdownResponse
@laurent-yoti
SDK-2617 IDV session SDK configuration with suppressed screens (#538)
1085653 
* Added optional 'suppressed_screens' in the IDV session SDK configuration.

* Fix JSDOC description

* Added example for the suppressed screens option.
@laurent-yoti
Bump minor version (to 4.12.0)
093c613
@saurabh-yoti saurabh-yoti requested a review from Copilot October 31, 2025 11:01
Copilot AI reviewed Oct 31, 2025
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@laurent-yoti laurent-yoti merged commit e2f49ca into master Nov 5, 2025
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@saurabh-yoti saurabh-yoti saurabh-yoti approved these changes

@abdalmajeed-yoti abdalmajeed-yoti Awaiting requested review from abdalmajeed-yoti

@nikhilPank nikhilPank Awaiting requested review from nikhilPank

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@laurent-yoti @saurabh-yoti