On this page
[3.6.0] - 2025-05-15
Fixed
Improved error handling mechanism for better client-side error reporting
Fixed issues with error response format returned to client applications
Enhanced error details to provide more actionable information for troubleshooting
[3.5.4] - 2025-04-24
Added
New events added to provide more specific feedback:
DATE_NOT_FOUND
: Event triggered when a required date is not found in the document
TEXT_NOT_VERIFIED
: Event triggered when text verification fails
[3.5.2] - 2025-04-15
Fixed
Fixed issue with RESULT event not being properly received in frontend components due to premature connection closure
Improved event handling to ensure subscribers have time to process events before cleanup
Ensured proper event propagation from OcrId package to consuming applications
[3.5.1] - 2025-04-04
Added
Additional translation keys in the TranslationKeys
interface:
cameraUnavailable
: Text shown when the camera cannot be accessed
preparingCamera
: Text shown while the camera is initializing
noCameraAvailable
: Text shown when no camera is detected on the device
[3.5.0] - 2025-04-04
Added
Support for custom translations via the configuration object:
Added translations
property to IBaseConfiguration
interface that allows defining custom text for UI elements
Interface TranslationKeys
to strongly type translation keys that can be customized
Support for custom language codes beyond the predefined Language type
Changed
Translations are now loaded from the configuration object passed to the constructor
Improved flexibility by allowing any string as language code, not limited to predefined Language values
[3.4.3] - 2025-04-03
Fixed
Fixed multipageProcessing api parameter typo
[3.4.2] - 2025-04-03
Added
Pass multipageProcessing
parameter to backend to handle multi-page documents
[3.4.1] - 2025-04-02
Fixed
Fixed issue where OCR would capture images too quickly without performing proper image quality validations
[3.4.0] - 2025-04-02
Added
New configuration parameters:
typeStatusMandatory
: Boolean parameter to enforce type status requirements
multipageProcessing
: Boolean parameter for handling multi-page documents
skipDocumentAnalysis
: Boolean parameter to bypass component-level document analysis
Performance optimization when using skipDocumentAnalysis=true
, allowing analysis to be performed exclusively via API
Changed
Improved document capture performance when component-level analysis is skipped
Enhanced API integration for document processing workflows
Fixed
Resolved performance bottlenecks in document capture process
[3.3.1] - 2025-03-25
Code Cleanup
Removal of unnecessary logs
Code refactoring to improve readability
[3.3.0] - 2025-03-24
Added
New event PRESS_RETRY_BUTTON that indicates an error occurred and the user is attempting to retry
New event CAMERA_PERMISSION_DENIED for notifying when camera access is denied
New optional parameter forceShutdown
in the close()
method for explicit shutdown control
Improved error handling for camera permission issues
Changed
Significantly improved document detection performance
Modified the ITransport
interface to include the new parameter in close()
Fixed
Fixed critical bug where the close()
method would automatically call shutdown()
, causing the service to terminate prematurely and preventing reuse
Resolved the issue of service termination after the first attempt
[3.2.0] - 2025-03-21
Added
New BAD_IMAGE_QUALITY
event in EventTypeUserFeedback
that provides specific feedback when document scanning fails due to image quality issues (focus problems, poor lighting, glare, improper framing)
Enhanced error detection to distinguish between document type errors and image quality problems
Changed
Improved error handling to provide more precise user feedback during document processing
Updated internal event processing to handle specific image quality notifications from backend
Fixed
Better error classification for failed scans that previously showed generic errors
[3.1.4] - 2024-12-10
Changed
Improved the error message displayed when a document analysis error occurs, providing clearer feedback to the user.
Renamed the error PROCESS_RESTARTED_DUE_ANALYSIS_ERROR
to PROCESS_FAILED_DUE_ANALYSIS_ERROR
for better consistency and accuracy.
[3.1.3] - 2024-12-09
Added
Updated documentation to reflect the latest changes and enhancements.
New environments added to the Envs
enum.
Changed
Codebase cleanup performed to remove deprecated functions and improve maintainability.
[3.1.2] - 2024-11-26
Added
Real-time guidance messages and animations to assist the user in properly rotating and positioning the document during the scanning process.
Enhanced document capture speed for improved user experience.
Optimized for low-bandwidth environments by sending only one image per process for analysis.
Document detection and cropping now performed directly in the browser, reducing processing time.
The scanning process waits until a document is detected before sending the image to the backend for analysis.
Changed
Improved the feedback loop for analysis failures:
If the backend fails to analyze the document, the user is prompted to restart the process with clear instructions.
Updated USER_FEEDBACK
events to include animations and messages for better user guidance during the scanning process.
Fixed
Fixed issues causing delays in document detection and capture in certain browser environments.
Resolved performance bottlenecks during the scanning process on devices with limited processing power or bandwidth.
Removed
Deprecated support for the openCamera
method. Use startStream
instead for a unified API.