uqudosdk-web 4.0.1 → 4.0.3

package/CHANGELOG.md

@@ -1,3 +1,43 @@
+## 4.0.2
+
+- Added support for Indonesian ID and Iraqi Resident ID documents.
+- A retry mechanism was implemented for loading the WASM module in case the initial attempt fails. If the retry also fails, the SDK terminates the session using the specific error code WASM_LOAD_FAILED, which is also used in the trace event.
+- Minor improvements
+
+## 4.0.1
+
+- Document Scanning
+  Added support for Moroccan ID (MAR_ID) scanning.
+  Added support for the latest Bahrain ID version.
+- New Document Types
+  Introduced QAT_ID_NATIONAL, QAT_ID_RESIDENT, KWT_ID_NATIONAL and KWT_ID_RESIDENT.
+  Note: Previous SDK versions reported types such as OMN_ID_NATIONAL simply as OMN_ID in the result object. From this release onward, the exact selected document type will be returned.
+- Tracing Enhancements (Analytics)
+  Added a new deviceIdentifier field (a UUID) to the tracing object. This value uniquely identifies multiple sessions from a given device (persisting until browser local storage is cleared). You may still use more specific identifiers, such as phone number or email, if you already know the user.
+  A new status code, VIDEO_PLAYS_INLINE_DISABLED, has been added. It’s returned when HTML5 videos default to the native full-screen player instead of playing inline, something that only occurs when the SDK is embedded in an iOS WebView with allowsInlineMediaPlayback set to false. This status code helps you identify and correct your WebView settings. For details on WebView integration, see https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/web/webview-usage.
+- Bug fixes
+  An issue has been resolved that was preventing the SDK from initializing properly when the DOM Storage API was disabled. This can occur on Android if the SDK is running inside a WebView without DOM storage explicitly enabled. For details on WebView integration, see https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/web/webview-usage.
+- Miscellaneous
+  Minor improvements.
+
+## 4.0.0
+
+- Implemented document auto-scanning with a streamlined process: the shutter button has been removed, and a full-screen camera view now automatically detects document types, performs quality checks, and ensures a seamless onboarding experience for end users with minimal friction. The SDK prioritizes selecting the optimal camera from the browser API's list but also allows users to manually switch cameras if focus issues arise.
+- The facial recognition module has been redesigned to deliver faster, more accurate face detection, providing a significantly smoother experience for the end user.
+- Document auto-scanning and facial recognition are powered by WASM technology. See some important details here https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/web/sdk-installation
+- We have added a new operation error code, WASM_NOT_SUPPORTED. The SDK will terminate the session and trigger this error code if the browser lacks the essential features required to run a WASM module. However, this scenario is expected to be rare, as WASM is widely supported across modern browsers.
+- We have added new status codes for tracing in the document scanning and the facial recognition step. See the details here https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/web/analytics.
+- The frontImageId and backImageId fields in the scan object now reference the cropped document images. Additionally, two new fields, frontFrameImageId and backFrameImageId, have been introduced to store the complete frame images of the document. These full-frame images provide valuable context for troubleshooting and help fulfill regulatory requirements that necessitate documenting the scanning environment.
+- The base SDK size has been reduced to ~700 KB uncompressed, ~230 KB compressed, with the WASM module loaded via a CDN. Using a CDN offers several advantages:
+  Geographical proximity
+  Caching
+  Load distribution
+- The WASM module is available in two encodings: GZIP and Brotli. Brotli, which is widely supported by modern browsers, offers the best compression ratio. The current size of the WASM module is 3.7MB.
+- Enhanced Quality Check: Introduced a new verification step during document scanning to notify users if their fingers are obstructing the document.
+- Added support for landscape mode in the facial recognition step for tablets. This is to accommodate tablets that have the selfie camera in landscape configuration mode.
+- We've updated the names of some CSS classes. If you've overridden any CSS, please review the new list available here: https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/web/ui-customisation/styles-configuration.
+- Expanded Document Support: Added compatibility for new document types, including SAU_ID (Premium Resident Version), SOM_ID (Somali ID), BHR_VL (Bahrain Vehicle License), JOR_VL (Jordan Vehicle License), and SAU_VL (Saudi Vehicle License).
+
 ## 3.6.2
 
 - show popup error when the user upload document larger than 5mb

package/index.d.ts

@@ -39,6 +39,7 @@ export enum ErrorCode {
   INVALID_CONFIG = "INVALID_CONFIG",
   SESSION_INVALIDATED_FACE_RECOGNITION_TOO_MANY_ATTEMPTS = "SESSION_INVALIDATED_FACE_RECOGNITION_TOO_MANY_ATTEMPTS",
   WASM_NOT_SUPPORTED = "WASM_NOT_SUPPORTED",
+  WASM_LOAD_FAILED = "WASM_LOAD_FAILED",
 }
 
 // ---------- enum --------- //
@@ -126,6 +127,9 @@ export enum DocumentType {
   SAU_ID_RESIDENT = "SAU_ID_RESIDENT",
   QAT_ID_NATIONAL = "QAT_ID_NATIONAL",
   QAT_ID_RESIDENT = "QAT_ID_RESIDENT",
+  IRQ_ID_NATIONAL = "IRQ_ID_NATIONAL",
+  IRQ_ID_RESIDENT = "IRQ_ID_RESIDENT",
+  IDN_ID = "IDN_ID",
 }
 
 export enum BackgroundCheckType {
@@ -405,6 +409,7 @@ export enum TraceStatusCode {
   FACE_RECOGNITION_TOO_MANY_ATTEMPTS = "FACE_RECOGNITION_TOO_MANY_ATTEMPTS",
   MEDIA_VIRTUAL_CAMERA_DETECTED = "MEDIA_VIRTUAL_CAMERA_DETECTED",
   WASM_NOT_SUPPORTED = "WASM_NOT_SUPPORTED",
+  WASM_LOAD_FAILED = "WASM_LOAD_FAILED",
   VIDEO_PLAYS_INLINE_DISABLED = "VIDEO_PLAYS_INLINE_DISABLED",
   // scan
   SCAN_DOCUMENT_DARK_ENVIRONMENT_DETECTED = "SCAN_DOCUMENT_DARK_ENVIRONMENT_DETECTED",