uqudosdk-web 3.6.2 → 4.0.1

package/CHANGELOG.md

@@ -55,7 +55,7 @@
 ## 3.3.0
 
 - In this latest release, we've revamped the facial recognition step. We've eliminated the nodding step, transforming facial recognition into a straightforward process easy as capturing a selfie. Under the hood, numerous enhancements have been implemented to ensure speed, simplicity, and enhanced accuracy. There are no changes in terms of business logic for your integration process.
-To accomplish the aforementioned outcome, we integrated AI capabilities directly into the Web SDK, resulting in a substantial increase in the SDK's size. To ensure the utmost efficiency with our latest SDK version, it's recommended to follow performance best practices. Enhance performance by reducing imports and incorporating techniques like lazy loading, code splitting, and memoization (specifically for React). To implement these strategies, consult the documentation of the framework you are utilizing.
+  To accomplish the aforementioned outcome, we integrated AI capabilities directly into the Web SDK, resulting in a substantial increase in the SDK's size. To ensure the utmost efficiency with our latest SDK version, it's recommended to follow performance best practices. Enhance performance by reducing imports and incorporating techniques like lazy loading, code splitting, and memoization (specifically for React). To implement these strategies, consult the documentation of the framework you are utilizing.
 - Added support for Lebanon ID and Driving License
 
 ## 3.2.3

package/index.d.ts

@@ -9,21 +9,14 @@ export declare class OperationError extends Error {
   public data: IResultInfo | undefined;
 }
 
-export declare const isOperationError: (
-  error: unknown
-) => error is OperationError;
+export declare const isOperationError: (error: unknown) => error is OperationError;
 
 // ---------- uqudo sdk --------- //
 
 export declare class UqudoSdk {
   enrollment(configProcess: IEnrollmentConfig): Promise<ReturnEnrollmentType>;
-  accountRecovery(
-    configProcess: IAccountRecoveryConfig
-  ): Promise<ReturnAccountRecoveryType>;
-  faceSession(
-    configProcess: IFaceSessionConfig
-  ): Promise<ReturnFaceSessionType>;
-  dispose(): Promise<void>;
+  faceSession(configProcess: IFaceSessionConfig): Promise<ReturnFaceSessionType>;
+  dispose(): void;
 }
 
 declare class UqudoSdkFactory {
@@ -44,7 +37,8 @@ export enum ErrorCode {
   MEDIA_UNKNOWN_ERROR = "MEDIA_UNKNOWN_ERROR",
   USER_CANCEL = "USER_CANCEL",
   INVALID_CONFIG = "INVALID_CONFIG",
-  SESSION_INVALIDATED_TOO_MANY_ATTEMPTS = "SESSION_INVALIDATED_TOO_MANY_ATTEMPTS",
+  SESSION_INVALIDATED_FACE_RECOGNITION_TOO_MANY_ATTEMPTS = "SESSION_INVALIDATED_FACE_RECOGNITION_TOO_MANY_ATTEMPTS",
+  WASM_NOT_SUPPORTED = "WASM_NOT_SUPPORTED",
 }
 
 // ---------- enum --------- //
@@ -58,6 +52,7 @@ export enum ErrorDisplayCode {
   PAYLOAD_TOO_LARGE = "PAYLOAD_TOO_LARGE",
   SCAN_DOCUMENT_AGE_VERIFICATION_FAILED = "SCAN_DOCUMENT_AGE_VERIFICATION_FAILED",
   UNEXPECTED_ERROR = "UNEXPECTED_ERROR",
+  UNSUPPORTED_DOCUMENT_TYPE = "UNSUPPORTED_DOCUMENT_TYPE",
 }
 
 // document type
@@ -83,7 +78,6 @@ export enum DocumentType {
   NGA_DL = "NGA_DL",
   NGA_VOTER_ID = "NGA_VOTER_ID",
   NGA_NIN = "NGA_NIN",
-  UAE_VL_PDF = "UAE_VL_PDF",
   GBR_DL = "GBR_DL",
   SAU_DL = "SAU_DL",
   ZAF_ID = "ZAF_ID",
@@ -118,21 +112,53 @@ export enum DocumentType {
   UAE_ID_DIGITAL = "UAE_ID_DIGITAL",
   QAT_VL = "QAT_VL",
   UAE_PASSPORT_DIGITAL = "UAE_PASSPORT_DIGITAL",
+  TUN_ID = "TUN_ID",
+  SOM_ID = "SOM_ID",
+  BHR_VL = "BHR_VL",
+  JOR_VL = "JOR_VL",
+  SAU_VL = "SAU_VL",
+  MAR_ID = "MAR_ID",
+  KWT_ID_NATIONAL = "KWT_ID_NATIONAL",
+  KWT_ID_RESIDENT = "KWT_ID_RESIDENT",
+  OMN_ID_NATIONAL = "OMN_ID_NATIONAL",
+  OMN_ID_RESIDENT = "OMN_ID_RESIDENT",
+  SAU_ID_NATIONAL = "SAU_ID_NATIONAL",
+  SAU_ID_RESIDENT = "SAU_ID_RESIDENT",
+  QAT_ID_NATIONAL = "QAT_ID_NATIONAL",
+  QAT_ID_RESIDENT = "QAT_ID_RESIDENT",
 }
 
 export enum BackgroundCheckType {
   RDC = "RDC",
 }
 
-export enum LivenessDetectionMessageCode {
+export enum FaceMessageCode {
   OK = "OK",
+  MULTIPLE_PERSON_DETECTED = "MULTIPLE_PERSON_DETECTED",
   MOVE_CLOSER = "MOVE_CLOSER",
   GO_BACK = "GO_BACK",
-  LOOK_STRAIGHT = "LOOK_STRAIGHT",
+  MOVE_TO_CENTER = "MOVE_TO_CENTER",
+  DARK_ENVIRONMENT_DETECTED = "DARK_ENVIRONMENT_DETECTED",
+  BLUR_DETECTED = "BLUR_DETECTED",
+  MOUTH_COVER_DETECTED = "MOUTH_COVER_DETECTED",
   EYE_CLOSED = "EYE_CLOSED",
+  EYE_COVER = "EYE_COVER",
+  SPOTLIGHT_DETECTED = "SPOTLIGHT_DETECTED",
+  SHADOW_DETECTED = "SHADOW_DETECTED",
+  ERROR = "ERROR",
+}
+
+export enum ScanMessageCode {
+  OK = "OK",
+  LOW_LIGHT = "LOW_LIGHT",
+  MOVE_CLOSER = "MOVE_CLOSER",
+  UNCLEAR_IMAGE = "UNCLEAR_IMAGE",
+  WRONG_DOCUMENT_TYPE = "WRONG_DOCUMENT_TYPE",
+  WRONG_DOCUMENT_SIDE = "WRONG_DOCUMENT_SIDE",
+  AVOID_GLARE = "AVOID_GLARE",
+  REMOVE_FINGER = "REMOVE_FINGER",
+  BAD_QUALITY = "BAD_QUALITY",
   MOVE_TO_CENTER = "MOVE_TO_CENTER",
-  NO_PERSON_DETECTED = "NO_PERSON_DETECTED",
-  MULTIPLE_PERSON_DETECTED = "MULTIPLE_PERSON_DETECTED",
   ERROR = "ERROR",
 }
 
@@ -185,17 +211,28 @@ export interface ITextsArg {
   facialRecognition?: {
     title?: string;
     description?: string;
-    livenessDetectionMessages?: Record<LivenessDetectionMessageCode, string>;
+    livenessDetectionMessages?: Record<FaceMessageCode, string>;
   };
   scan?: CanBeArray<{
+    titlePhotoPage?: string;
     titleFrontSide?: string;
     titleBackSide?: string;
+    frontLabel?: string;
+    backLabel?: string;
+    photoPageLabel?: string;
+
     rescanButtonText?: string;
     continueButtonText?: string;
     turnDocumentDescription?: string;
     tipDescription?: string;
     tipDescription2?: string;
     description?: string;
+    messages?: Record<ScanMessageCode, string>;
+    cameraSelection?: {
+      title?: string;
+      description?: string;
+      button?: string;
+    };
   }>;
   documentTypes?: Record<string | DocumentType, string>;
   errors?: Record<string | ErrorDisplayCode, ITextErrorDisplay>;
@@ -206,15 +243,17 @@ export interface ITextsArg {
 export interface IAssetsArg {
   logo?: string;
   logoWhite?: string;
-  turnOverImage?: string;
+  turnOverImageUrl?: string;
   closeSessionIcon?: string;
+  closeSessionIconCameraMode?: string;
   addFileIcon?: string;
   hintIcon?: string;
   recordIcon?: string;
-  takePictureIcon?: string;
   spinnerIcon?: string;
   removeIcon?: string;
   updateIcon?: string;
+  okImageUrl?: string;
+  cameraIcon?: string;
 }
 
 // ---------- common type --------- //
@@ -264,7 +303,6 @@ export type IEnrollmentConfig = IConfigProcess &
     scan: IScanConfig | IScanConfig[];
     face?: {
       enableFacialRecognition?: boolean;
-      enrollFace?: boolean;
       maxAttempts?: number;
       minimumMatchLevel?: number;
       enableOneToNVerification?: boolean;
@@ -293,17 +331,6 @@ export type IFaceSessionConfig = IConfigProcess &
     minimumMatchLevel?: number;
   };
 
-// ---------- Account Recovery type --------- //
-
-export type ReturnAccountRecoveryType = IResultInfo;
-
-export type IAccountRecoveryConfig = IConfigProcess &
-  IObservableFunctionsType<ReturnAccountRecoveryType> & {
-    enrollmentIdentifier: string;
-    maxAttempts?: number;
-    minimumMatchLevel?: number;
-  };
-
 // ---------- Tracing mechanism type --------- //
 
 export enum TraceCategory {
@@ -331,6 +358,36 @@ export enum TraceStatus {
   FAILURE = "FAILURE",
 }
 
+export enum SCAN_DOCUMENT_STATUS_CODE {
+  OK = "OK",
+  SCAN_DOCUMENT_DARK_ENVIRONMENT_DETECTED = "SCAN_DOCUMENT_DARK_ENVIRONMENT_DETECTED",
+  SCAN_DOCUMENT_INCORRECT_DISTANCE_DETECTED = "SCAN_DOCUMENT_INCORRECT_DISTANCE_DETECTED",
+  SCAN_DOCUMENT_BLUR_DETECTED = "SCAN_DOCUMENT_BLUR_DETECTED",
+  SCAN_DOCUMENT_INCORRECT_TYPE_DETECTED = "SCAN_DOCUMENT_INCORRECT_TYPE_DETECTED",
+  SCAN_DOCUMENT_INCORRECT_SIDE_DETECTED = "SCAN_DOCUMENT_INCORRECT_SIDE_DETECTED",
+  SCAN_DOCUMENT_GLARE_DETECTED = "SCAN_DOCUMENT_GLARE_DETECTED",
+  SCAN_DOCUMENT_FINGER_DETECTED = "SCAN_DOCUMENT_FINGER_DETECTED",
+  SCAN_DOCUMENT_ID_PHOTO_BAD_QUALITY_DETECTED = "SCAN_DOCUMENT_ID_PHOTO_BAD_QUALITY_DETECTED",
+  SCAN_DOCUMENT_INCORRECT_POSITION_DETECTED = "SCAN_DOCUMENT_INCORRECT_POSITION_DETECTED",
+}
+
+export enum FACE_STATUS_CODE {
+  OK = "OK",
+  FACE_MULTIPLE_FACES_DETECTED = "FACE_MULTIPLE_FACES_DETECTED",
+  FACE_INCORRECT_DISTANCE_DETECTED_TOO_FAR = "FACE_INCORRECT_DISTANCE_DETECTED_TOO_FAR",
+  FACE_INCORRECT_DISTANCE_DETECTED_TOO_CLOSE = "FACE_INCORRECT_DISTANCE_DETECTED_TOO_CLOSE",
+  FACE_INCORRECT_POSITION_DETECTED = "FACE_INCORRECT_POSITION_DETECTED",
+  FACE_INCORRECT_DISTANCE_DETECTED = "FACE_INCORRECT_DISTANCE_DETECTED",
+  FACE_DARK_ENVIRONMENT_DETECTED = "FACE_DARK_ENVIRONMENT_DETECTED",
+  FACE_BLUR_DETECTED = "FACE_BLUR_DETECTED",
+  FACE_MOUTH_COVER_DETECTED = "FACE_MOUTH_COVER_DETECTED",
+  FACE_EYES_COVER_DETECTED = "FACE_EYES_COVER_DETECTED",
+  FACE_EYES_CLOSED_DETECTED = "FACE_EYES_CLOSED_DETECTED",
+  FACE_SPOTLIGHT_DETECTED = "FACE_SPOTLIGHT_DETECTED",
+  FACE_SHADOW_DETECTED = "FACE_SHADOW_DETECTED",
+  FACE_EYES_SHADOW_DETECTED = "FACE_EYES_SHADOW_DETECTED",
+}
+
 export enum TraceStatusCode {
   USER_CANCEL = "USER_CANCEL",
   SESSION_EXPIRED = "SESSION_EXPIRED",
@@ -345,15 +402,35 @@ export enum TraceStatusCode {
   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",
+  MEDIA_VIRTUAL_CAMERA_DETECTED = "MEDIA_VIRTUAL_CAMERA_DETECTED",
+  WASM_NOT_SUPPORTED = "WASM_NOT_SUPPORTED",
+  VIDEO_PLAYS_INLINE_DISABLED = "VIDEO_PLAYS_INLINE_DISABLED",
+  // scan
+  SCAN_DOCUMENT_DARK_ENVIRONMENT_DETECTED = "SCAN_DOCUMENT_DARK_ENVIRONMENT_DETECTED",
+  SCAN_DOCUMENT_INCORRECT_DISTANCE_DETECTED = "SCAN_DOCUMENT_INCORRECT_DISTANCE_DETECTED",
+  SCAN_DOCUMENT_BLUR_DETECTED = "SCAN_DOCUMENT_BLUR_DETECTED",
+  SCAN_DOCUMENT_INCORRECT_TYPE_DETECTED = "SCAN_DOCUMENT_INCORRECT_TYPE_DETECTED",
+  SCAN_DOCUMENT_INCORRECT_SIDE_DETECTED = "SCAN_DOCUMENT_INCORRECT_SIDE_DETECTED",
+  SCAN_DOCUMENT_GLARE_DETECTED = "SCAN_DOCUMENT_GLARE_DETECTED",
+  SCAN_DOCUMENT_FINGER_DETECTED = "SCAN_DOCUMENT_FINGER_DETECTED",
+  SCAN_DOCUMENT_ID_PHOTO_BAD_QUALITY_DETECTED = "SCAN_DOCUMENT_ID_PHOTO_BAD_QUALITY_DETECTED",
+  SCAN_DOCUMENT_INCORRECT_POSITION_DETECTED = "SCAN_DOCUMENT_INCORRECT_POSITION_DETECTED",
+  // face
+  FACE_MULTIPLE_FACES_DETECTED = "FACE_MULTIPLE_FACES_DETECTED",
   FACE_INCORRECT_POSITION_DETECTED = "FACE_INCORRECT_POSITION_DETECTED",
-  FACE_INCORRECT_DISTANCE_DETECTED = "FACE_INCORRECT_DISTANCE_DETECTED",
+  FACE_DARK_ENVIRONMENT_DETECTED = "FACE_DARK_ENVIRONMENT_DETECTED",
+  FACE_BLUR_DETECTED = "FACE_BLUR_DETECTED",
+  FACE_MOUTH_COVER_DETECTED = "FACE_MOUTH_COVER_DETECTED",
+  FACE_EYES_COVER_DETECTED = "FACE_EYES_COVER_DETECTED",
   FACE_EYES_CLOSED_DETECTED = "FACE_EYES_CLOSED_DETECTED",
-  MEDIA_VIRTUAL_CAMERA_DETECTED = "MEDIA_VIRTUAL_CAMERA_DETECTED",
+  FACE_SPOTLIGHT_DETECTED = "FACE_SPOTLIGHT_DETECTED",
+  FACE_SHADOW_DETECTED = "FACE_SHADOW_DETECTED",
+  FACE_EYES_SHADOW_DETECTED = "FACE_EYES_SHADOW_DETECTED",
 }
 
 export type ITrace = {
+  deviceIdentifier: string;
   sessionId: string;
   category: TraceCategory;
   event: TraceEvent;