Skip to content

Conversation

mehmet-yoti
Copy link
Contributor

To implement the new properties for configuring dark mode in the IDV Web SDK, follow this detailed implementation plan. The plan breaks down the tasks into manageable steps necessary to complete the feature from start to finish.

Step-by-Step Implementation Plan:

Step 1: Update the SdkConfig Object Model

  • Task 1.1: Add New Properties

    • Add dark_mode as a property of the SdkConfig object model.
    • Add primary_colour_dark_mode as a property of the SdkConfig object model.
  • Task 1.2: Modify Builders

    • Update the builder class for SdkConfig to include methods for setting these two new properties. Make sure methods are chainable to maintain current builder pattern consistency.

Step 2: Implement Helper Methods

  • Task 2.1: Create Helper Methods for dark_mode
    • Method 2.1.1: Implement a helper method setDarkModeOn() that sets the dark_mode to "ON".
    • Method 2.1.2: Implement a helper method setDarkModeOff() that sets the dark_mode to "OFF".
    • Method 2.1.3: Implement a helper method setDarkModeAuto() that sets the dark_mode to "AUTO".

Step 3: Modify JSON Serialization

  • Task 3.1: Update JSON Serialization Logic
    • Ensure that dark_mode and primary_colour_dark_mode are only included in the JSON payload if they are set by the Relying Business.

Step 4: Testing

  • Task 4.1: Unit Testing

    • Write tests for the new properties to ensure they are correctly set and serialized.
    • Test each helper method to ensure they set the dark_mode appropriately in the SdkConfig object.
  • Task 4.2: Integration Testing

    • Run integration tests to confirm that the entire IDV session creation process works smoothly with the new properties configured.

Step 5: Documentation

  • Task 5.1: Update Documentation
    • Update any relevant developer guides or inline documentation to include instructions on configuring dark_mode and primary_colour_dark_mode.
    • Document the new helper methods for easier developer comprehension.

Step 6: Code Review and Deployment

  • Task 6.1: Peer Code Review

    • Submit the code for review to ensure quality and adherence to project standards.
  • Task 6.2: Prepare for Deployment

    • Merge into the main branch if all tests pass and the code review is successful.
    • Follow the deployment process to deliver the updated SDK to Relying Businesses.

This implementation plan outlines the necessary steps to integrate and support the new dark mode configuration, ensuring a smooth development process and compliance with existing system architecture.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant