uqudosdk-web 3.5.0 → 3.6.1

package/CHANGELOG.md

@@ -1,9 +1,21 @@
+## 3.6.1
+
+- Enhanced SDK initialization to ensure that any resources from a previous SDK instance, such as the camera stream, are properly released. Additionally, a new method, `dispose()`, has been added to the `UqudoSdk` class, allowing you to forcibly release any resources related to the SDK.
+- Added support for a new document type: UAE_PASSPORT_DIGITAL, representing the digital version of the UAE passport. To accept this type, configure it as a separate document in your Enrollment Builder Configuration. For manual upload, we support the original 6-page PDF version and automatically extract the document from the third page.
+
+## 3.6.0
+
+- Introduced support for Qatar Vehicle License.
+- Enhanced the facial recognition step to provide a smoother experience for end users.
+- Fixed an issue where the selfie output in facial recognition appeared squeezed on some devices.
+- Introduced support for the Analytics functionality. For more details, visit <https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/web/analytics>.
+
 ## 3.5.0
 
-- Updated the facial recognition layout for desktop to address the issue on Windows where the default zoom is set to 150%. We've added and updated some styles: for a complete list, please refer to the style configuration documentation https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/web/ui-customisation/styles-configuration.
+- Updated the facial recognition layout for desktop to address the issue on Windows where the default zoom is set to 150%. We've added and updated some styles: for a complete list, please refer to the style configuration documentation <https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/web/ui-customisation/styles-configuration>.
 - Enhanced the facial recognition layout for mobile and tablet. Fixed the oval's position, which sometimes misled users into placing their faces incorrectly.
 - Changed the image format to JPEG for the document photo-taking step.
-- Added virtual camera detection. If a virtual camera is detected, the SDK terminates the session with the error code MEDIA_VIRTUAL_CAMERA_DETECTED. For more details, see the operation error documentation https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/web/operation-error.
+- Added virtual camera detection. If a virtual camera is detected, the SDK terminates the session with the error code MEDIA_VIRTUAL_CAMERA_DETECTED. For more details, see the operation error documentation <https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/web/operation-error>.
 
 ## 3.4.2
 

package/index.d.ts

@@ -23,6 +23,7 @@ export declare class UqudoSdk {
   faceSession(
     configProcess: IFaceSessionConfig
   ): Promise<ReturnFaceSessionType>;
+  dispose(): Promise<void>;
 }
 
 declare class UqudoSdkFactory {
@@ -99,8 +100,8 @@ export enum DocumentType {
   SEN_ID = "SEN_ID",
   DZA_ID = "DZA_ID",
   TUR_ID = "TUR_ID",
-  COD_DL = "COD_DL",
   GBR_ID = "GBR_ID",
+  COD_DL = "COD_DL",
   COD_VOTER_ID = "COD_VOTER_ID",
   OMN_VL = "OMN_VL",
   OMN_DL = "OMN_DL",
@@ -115,6 +116,8 @@ export enum DocumentType {
   IRQ_ID = "IRQ_ID",
   MRZ = "MRZ",
   UAE_ID_DIGITAL = "UAE_ID_DIGITAL",
+  QAT_VL = "QAT_VL",
+  UAE_PASSPORT_DIGITAL = "UAE_PASSPORT_DIGITAL",
 }
 
 export enum BackgroundCheckType {
@@ -222,6 +225,7 @@ export type IObservableFunctionsType<R = IResultInfo, E = OperationError> = {
   onSuccess?: (result: R) => void;
   onError?: (error: E) => void;
   onFinally?: () => void;
+  onTrace?: (trace: ITrace) => void;
 };
 
 export type IResource = {
@@ -236,6 +240,7 @@ export type IConfigProcess = IResource & {
 // ---------- uqudo sdk type --------- //
 
 export type IUqudoSdkConfig = IResource & {
+  debug?: boolean;
   baseURL?: string;
   accessToken: string;
   nonce?: string;
@@ -298,3 +303,64 @@ export type IAccountRecoveryConfig = IConfigProcess &
     maxAttempts?: number;
     minimumMatchLevel?: number;
   };
+
+// ---------- Tracing mechanism type --------- //
+
+export enum TraceCategory {
+  ENROLLMENT = "ENROLLMENT",
+  FACE_SESSION = "FACE_SESSION",
+}
+
+export enum TracePage {
+  SCAN = "SCAN",
+  FACE = "FACE",
+  BACKGROUND_CHECK = "BACKGROUND_CHECK",
+}
+
+export enum TraceEvent {
+  VIEW = "VIEW",
+  START = "START",
+  IN_PROGRESS = "IN_PROGRESS",
+  SKIP = "SKIP",
+  COMPLETE = "COMPLETE",
+  FINISH = "FINISH",
+}
+
+export enum TraceStatus {
+  SUCCESS = "SUCCESS",
+  FAILURE = "FAILURE",
+}
+
+export enum TraceStatusCode {
+  USER_CANCEL = "USER_CANCEL",
+  SESSION_EXPIRED = "SESSION_EXPIRED",
+  UNEXPECTED_ERROR = "UNEXPECTED_ERROR",
+  CAMERA_NOT_AVAILABLE = "CAMERA_NOT_AVAILABLE",
+  CAMERA_PERMISSION_NOT_GRANTED = "CAMERA_PERMISSION_NOT_GRANTED",
+  SCAN_DOCUMENT_FRONT_PROCESSED = "SCAN_DOCUMENT_FRONT_PROCESSED",
+  SCAN_DOCUMENT_BACK_PROCESSED = "SCAN_DOCUMENT_BACK_PROCESSED",
+  SCAN_DOCUMENT_FRONT_BACK_MISMATCH = "SCAN_DOCUMENT_FRONT_BACK_MISMATCH",
+  SCAN_DOCUMENT_NOT_RECOGNIZED = "SCAN_DOCUMENT_NOT_RECOGNIZED",
+  SCAN_DOCUMENT_EXPIRED = "SCAN_DOCUMENT_EXPIRED",
+  SCAN_DOCUMENT_AGE_VERIFICATION_FAILED = "SCAN_DOCUMENT_AGE_VERIFICATION_FAILED",
+  FACE_LIVENESS_FAILED = "FACE_LIVENESS_FAILED",
+  FACE_NO_MATCH = "FACE_NO_MATCH",
+  FACE_TIMEOUT = "FACE_TIMEOUT",
+  FACE_RECOGNITION_TOO_MANY_ATTEMPTS = "FACE_RECOGNITION_TOO_MANY_ATTEMPTS",
+  FACE_INCORRECT_POSITION_DETECTED = "FACE_INCORRECT_POSITION_DETECTED",
+  FACE_INCORRECT_DISTANCE_DETECTED = "FACE_INCORRECT_DISTANCE_DETECTED",
+  FACE_EYES_CLOSED_DETECTED = "FACE_EYES_CLOSED_DETECTED",
+  MEDIA_VIRTUAL_CAMERA_DETECTED = "MEDIA_VIRTUAL_CAMERA_DETECTED",
+}
+
+export type ITrace = {
+  sessionId: string;
+  category: TraceCategory;
+  event: TraceEvent;
+  status: TraceStatus;
+  page?: TracePage;
+  statusCode?: TraceStatusCode;
+  statusMessage?: string;
+  documentType?: string;
+  timestamp: Date;
+};