Release Notes

January 10th, 2025

`@caf.io/[email protected]`

Fixes

Android

Change namespace from org.caf.documentdetector to io.caf.documentdetector

December 11th, 2024

`@caf.io/[email protected]`

Highlights

Android

Added style themes for android by styles.xml and colors.xml.

iOS

Added uploadBackgroundColor for change color in upload screen.
Added previewBackgroundColor for change color in preview screen.

Breaking changes

Android

Removed style propertie for Android

December 04th, 2024

November 18th, 2024

`@caf.io/[email protected]`

Highlights

Removed the requirement for the READ_MEDIA_IMAGES permission.
Correction of the internal dependency that was causing the duplicate class problem.
Removed data binding to improve build time.
Crashlytics Integration
Analytics Integration

Breaking changes

Android

Updated Kotlin version from 1.5.32 to 1.9.10.
Updated Gradle from 6.9.1 to 8.4.
Updated Android Gradle Plugin from 7.4.2 to 8.3.2.
Updated compile and taget SDK from 33 to 34.
Updated minimum SDK from 21 to 26.
Removed useEmulator from DocumentDetectorSecuritySettings.
Removed useRoot from DocumentDetectorSecuritySettings

October 17th, 2024

`@caf.io/[email protected]`

Fixes

Resolved nested navigation issue resolved on iOS

October 09th, 2024

`@caf.io/[email protected]`

Fixes

Resolved compatibility issues with Xcode versions

July 02nd, 2024

`@caf.io/[email protected]`

Highlights

We have replaced the Kotlin Serialization library with our own custom compiler and processor. This allows us to generate classes during compile time more efficiently and tailored to our specific needs.
A significant portion of the main bridge code has been decoupled and moved into an AAR (Android Archive). This enhances modularity and simplifies code maintenance and updates.

Breaking changes

The personId attribute has been removed from DocumentDetectorSettings.
The method startDocumentDetector now requires a new parameter personId.\

June 13th, 2024

`@caf.io/[email protected]`

Highlights

New AI for smart capture, based on analyzing the framing of documents.
Similarity between what is being shown on the screen camera and the captured/analyzed photo.
New design and capture experience.

News

Added TensorFlowLite library dependency.
Added method showStepLabel to DocumentDetectorstep.
Added parameters predictorScanDocumentMessage, predictorGetCloserMessage, predictorCentralizeMessage, predictorMoveAwayMessage, predictorAlignDocumentMessage, predictorTurnDocumentMessage, predictorCapturedMessage,wrongDocumentMessage in the setMessageSettings.
Changed default resolution to FULL_HD.
Changed default values used to compress pictures.
Removed audio playback at the beginning of the capture.
New UI/UX.

Features

Added method analyticsSettings
Added method popupSettings
Added method networkSettings
Added method sensorSettings
Added method proxySettings
Added method previewSettings
Added method compressSettings
Added method imageUrlExpireTime
Added method currentStepDoneDelay
Added method resolutionSettings
Added method allowedPassportList
Added method style

iOS

Added method captureStages
Added method enableGoogleServices

Android

Added method manualCaptureSettings
Added method enableMultiLanguage

Breaking changes

Removed methods setMask from DocumentDetectorStep and DocumentDetectorSdk.Builder.
Removed OTHERS from Document. Use ANY to capture any type of document.

iOS

Removed method enableSound from DocumentDetectorSdkSdk.Builder.
Removed methos wrongDocumentMessage_RG_FRONT, wrongDocumentMessage_RG_BACK, wrongDocumentMessage_RG_FULL, wrongDocumentMessage_CNH_FRONT, wrongDocumentMessage_CNH_BACK, wrongDocumentMessage_CNH_FULL, wrongDocumentMessage_CRLV, wrongDocumentMessage_RNE_FRONT, wrongDocumentMessage_RNE_BACK from setMessageSettings.
Changed to FULL_HD and ULTRA_HD options in the Resolution.
Removed setDetectionSettings from DocumentDetectorSdk.Builder.
Removed setQualitySettings from DocumentDetectorSdk.Builder.
Removed setColorTheme from DocumentDetectorSdk.Builder. The main color can now be set with the primaryColor parameter in setLayout method.
Renamed scannedLabel to label in DocumentDetectorResult -> captures -> Capture.
Changed minimum iOS deployment target from 11.0 to 12.0.

Android

Removed method setAudioSettings from DocumentDetector.Builder.
Removed methods setStepAudio and getStepAudio from DocumentDetectorStep.
Removed method setAutoDetection from DocumentDetector.Builder.
Removed methos setWrongDocumentMessage_RG_FRONT, setWrongDocumentMessage_RG_BACK, setWrongDocumentMessage_RG_FULL, setWrongDocumentMessage_CNH_FRONT, setWrongDocumentMessage_CNH_BACK, setWrongDocumentMessage_CNH_FULL, setWrongDocumentMessage_CRLV, setWrongDocumentMessage_RNE_FRONT, setWrongDocumentMessage_RNE_BACK from MessageSettings.
Removed HD option from Resolution.
Removed DetectionSettings and QualitySettings from CaptureStages.
Removed method enableSwitchCameraButton from DocumentDetector.Builder.
Changed CaptureStage parameters order.
Use the new default template for the setLayout and setStyle methods.

April 18th, 2024

We are thrilled to unveil our latest React Native library, featuring integration with the Document Detector SDK. With this release, effortlessly incorporate document detection capabilities into your React Native applications, offering comprehensive support for both Android and iOS platforms.

Features

startDocumentDetector: Initialize the Document Detector SDK effortlessly.
useDocumentDetector: This hook simplifies listening to SDK events, transmitting them to React Native, and managing SDK configurations.
DocumentDetectorSettings
- documentSteps: Configure the document capture flow to suit your application's requirements.
- personId: Utilize user identification for fraud profile identification and streamline analytics logs identification for debugging purposes.
- cafStage: Configure the SDK environment.
- previewSettings: Enables users to configure the visualization of the captured content, prompting them to confirm before proceeding.
DocumentDetectorUploadSettings: Enable or disable document uploading.
DocumentDetectorMessageSettings: Personalize messages displayed during document capture.

Android

The SDK has some blocks that may prevent its execution in certain contexts. To disable them, you can use the settings below:

DocumentDetectorSecuritySettings: Manage SDK security settings.

Getting Started

Last updated 1 month ago

Release Notes

January 10th, 2025

`@caf.io/[email protected]`

Fixes

Android

Change namespace from org.caf.documentdetector to io.caf.documentdetector

December 11th, 2024

`@caf.io/[email protected]`

Highlights

Android

Added style themes for android by styles.xml and colors.xml.

iOS

Added uploadBackgroundColor for change color in upload screen.
Added previewBackgroundColor for change color in preview screen.

Breaking changes

Android

Removed style propertie for Android

December 04th, 2024

`@caf.io/[email protected]`

Fixes

Upload flow issue resolved on iOS

November 18th, 2024

`@caf.io/[email protected]`

Highlights

Removed the requirement for the READ_MEDIA_IMAGES permission.
Correction of the internal dependency that was causing the duplicate class problem.
Removed data binding to improve build time.
Crashlytics Integration
Analytics Integration

Breaking changes

Android

Updated Kotlin version from 1.5.32 to 1.9.10.
Updated Gradle from 6.9.1 to 8.4.
Updated Android Gradle Plugin from 7.4.2 to 8.3.2.
Updated compile and taget SDK from 33 to 34.
Updated minimum SDK from 21 to 26.
Removed useEmulator from DocumentDetectorSecuritySettings.
Removed useRoot from DocumentDetectorSecuritySettings

October 17th, 2024

`@caf.io/[email protected]`

Fixes

Resolved nested navigation issue resolved on iOS

October 09th, 2024

`@caf.io/[email protected]`

Fixes

Resolved compatibility issues with Xcode versions

July 02nd, 2024

`@caf.io/[email protected]`

Highlights

We have replaced the Kotlin Serialization library with our own custom compiler and processor. This allows us to generate classes during compile time more efficiently and tailored to our specific needs.
A significant portion of the main bridge code has been decoupled and moved into an AAR (Android Archive). This enhances modularity and simplifies code maintenance and updates.

Breaking changes

The personId attribute has been removed from DocumentDetectorSettings.
The method startDocumentDetector now requires a new parameter personId.\

June 13th, 2024

`@caf.io/[email protected]`

Highlights

New AI for smart capture, based on analyzing the framing of documents.
Similarity between what is being shown on the screen camera and the captured/analyzed photo.
New design and capture experience.

News

Added TensorFlowLite library dependency.
Added method showStepLabel to DocumentDetectorstep.
Added parameters predictorScanDocumentMessage, predictorGetCloserMessage, predictorCentralizeMessage, predictorMoveAwayMessage, predictorAlignDocumentMessage, predictorTurnDocumentMessage, predictorCapturedMessage,wrongDocumentMessage in the setMessageSettings.
Changed default resolution to FULL_HD.
Changed default values used to compress pictures.
Removed audio playback at the beginning of the capture.
New UI/UX.

Features

Added method analyticsSettings
Added method popupSettings
Added method networkSettings
Added method sensorSettings
Added method proxySettings
Added method previewSettings
Added method compressSettings
Added method imageUrlExpireTime
Added method currentStepDoneDelay
Added method resolutionSettings
Added method allowedPassportList
Added method style

iOS

Added method captureStages
Added method enableGoogleServices

Android

Added method manualCaptureSettings
Added method enableMultiLanguage

Breaking changes

Removed methods setMask from DocumentDetectorStep and DocumentDetectorSdk.Builder.
Removed OTHERS from Document. Use ANY to capture any type of document.

iOS

Removed method enableSound from DocumentDetectorSdkSdk.Builder.
Removed methos wrongDocumentMessage_RG_FRONT, wrongDocumentMessage_RG_BACK, wrongDocumentMessage_RG_FULL, wrongDocumentMessage_CNH_FRONT, wrongDocumentMessage_CNH_BACK, wrongDocumentMessage_CNH_FULL, wrongDocumentMessage_CRLV, wrongDocumentMessage_RNE_FRONT, wrongDocumentMessage_RNE_BACK from setMessageSettings.
Changed to FULL_HD and ULTRA_HD options in the Resolution.
Removed setDetectionSettings from DocumentDetectorSdk.Builder.
Removed setQualitySettings from DocumentDetectorSdk.Builder.
Removed setColorTheme from DocumentDetectorSdk.Builder. The main color can now be set with the primaryColor parameter in setLayout method.
Renamed scannedLabel to label in DocumentDetectorResult -> captures -> Capture.
Changed minimum iOS deployment target from 11.0 to 12.0.

Android

Removed method setAudioSettings from DocumentDetector.Builder.
Removed methods setStepAudio and getStepAudio from DocumentDetectorStep.
Removed method setAutoDetection from DocumentDetector.Builder.
Removed methos setWrongDocumentMessage_RG_FRONT, setWrongDocumentMessage_RG_BACK, setWrongDocumentMessage_RG_FULL, setWrongDocumentMessage_CNH_FRONT, setWrongDocumentMessage_CNH_BACK, setWrongDocumentMessage_CNH_FULL, setWrongDocumentMessage_CRLV, setWrongDocumentMessage_RNE_FRONT, setWrongDocumentMessage_RNE_BACK from MessageSettings.
Removed HD option from Resolution.
Removed DetectionSettings and QualitySettings from CaptureStages.
Removed method enableSwitchCameraButton from DocumentDetector.Builder.
Changed CaptureStage parameters order.
Use the new default template for the setLayout and setStyle methods.

April 18th, 2024

`@caf.io/[email protected]`

First Release

Features

startDocumentDetector: Initialize the Document Detector SDK effortlessly.
useDocumentDetector: This hook simplifies listening to SDK events, transmitting them to React Native, and managing SDK configurations.
DocumentDetectorSettings
- documentSteps: Configure the document capture flow to suit your application's requirements.
- personId: Utilize user identification for fraud profile identification and streamline analytics logs identification for debugging purposes.
- cafStage: Configure the SDK environment.
- previewSettings: Enables users to configure the visualization of the captured content, prompting them to confirm before proceeding.
DocumentDetectorUploadSettings: Enable or disable document uploading.
DocumentDetectorMessageSettings: Personalize messages displayed during document capture.

Android

The SDK has some blocks that may prevent its execution in certain contexts. To disable them, you can use the settings below:

DocumentDetectorSecuritySettings: Manage SDK security settings.

Getting Started

Explore our to understand how to implement the Document Detector in React Native. We provide clear instructions and practical examples to facilitate your implementation.

Last updated 1 month ago