@regulaforensics/face-sdk 8.3.1100-rc → 8.3.1107-rc

package/www/capacitor/index.js

@@ -7,7 +7,6 @@ import { CustomizationImages } from './customization/customization_images'
 import { Customization } from './customization/customization'
 import { Font } from './customization/font'
 import { ScreenOrientation } from './customization/screen_orientation'
-
 export { CameraPosition, CustomizationColors, CustomizationFonts, CustomizationImages, Customization, Font, ScreenOrientation }
 
 import { FaceSDKVersion } from './init/face_sdk_version'
@@ -16,7 +15,6 @@ import { InitException } from './init/init_exception'
 import { InitErrorCode } from './init/init_exception'
 import { LicenseException } from './init/license_exception'
 import { LicensingResultCode } from './init/license_exception'
-
 export { FaceSDKVersion, InitConfig, InitException, InitErrorCode, LicenseException, LicensingResultCode }
 
 import { DetectFaceResult } from './detect_faces/detect_face_result'
@@ -28,14 +26,12 @@ import { DetectFacesException, DetectFacesErrorCode } from './detect_faces/detec
 import { DetectFacesRequest } from './detect_faces/detect_faces_request'
 import { DetectFacesResponse } from './detect_faces/detect_faces_response'
 import { DetectFacesScenario } from './detect_faces/detect_faces_scenario'
-
 export { DetectFaceResult, DetectFacesAttributeResult, DetectFacesAttribute, DetectFacesBackendException, DetectFacesBackendErrorCode, DetectFacesConfig, DetectFacesException, DetectFacesErrorCode, DetectFacesRequest, DetectFacesResponse, DetectFacesScenario }
 
 import { FaceCaptureConfig } from './face_capture/face_capture_config'
 import { FaceCaptureException, FaceCaptureErrorCode } from './face_capture/face_capture_exception'
 import { FaceCaptureImage, ImageType } from './face_capture/face_capture_image'
 import { FaceCaptureResponse } from './face_capture/face_capture_response'
-
 export { FaceCaptureConfig, FaceCaptureException, FaceCaptureErrorCode, FaceCaptureImage, ImageType, FaceCaptureResponse }
 
 import { OutputImageCrop, OutputImageCropAspectRatio } from './image_params/output_image_crop'
@@ -43,7 +39,6 @@ import { OutputImageParams } from './image_params/output_image_params'
 import { Point } from './image_params/point'
 import { Rect } from './image_params/rect'
 import { Size } from './image_params/size'
-
 export { OutputImageCrop, OutputImageCropAspectRatio, OutputImageParams, Point, Rect, Size }
 
 import { ImageQualityCharacteristicName } from './image_quality/image_quality_characteristic_name'
@@ -51,16 +46,21 @@ import { ImageQualityCharacteristic } from './image_quality/image_quality_charac
 import { ImageQualityGroup } from './image_quality/image_quality_group'
 import { ImageQualityRange } from './image_quality/image_quality_range'
 import { ImageQualityResult, ImageQualityGroupName, ImageQualityResultStatus } from './image_quality/image_quality_result'
-
 export { ImageQualityCharacteristicName, ImageQualityCharacteristic, ImageQualityGroup, ImageQualityRange, ImageQualityResult, ImageQualityGroupName, ImageQualityResultStatus }
 
-import { LivenessBackendException, LivenessBackendErrorCode } from './liveness/liveness_backend_exception'
 import { LivenessConfig, RecordingProcess, LivenessType, LivenessSkipStep } from './liveness/liveness_config'
+import { EnrollmentConfig } from './liveness/enrollment_config'
+import { EnrollmentRequest } from './liveness/enrollment_request'
+import { VerificationConfig } from './liveness/verification_config'
+import { LivenessBackendException, LivenessBackendErrorCode } from './liveness/liveness_backend_exception'
 import { LivenessException, LivenessErrorCode } from './liveness/liveness_exception'
-import { LivenessNotification, LivenessProcessStatus } from './liveness/liveness_notification'
 import { LivenessResponse, LivenessStatus } from './liveness/liveness_response'
-
-export { LivenessBackendException, LivenessBackendErrorCode, LivenessConfig, RecordingProcess, LivenessType, LivenessSkipStep, LivenessException, LivenessErrorCode, LivenessNotification, LivenessProcessStatus, LivenessResponse, LivenessStatus }
+import { LivenessNotification, LivenessProcessStatus } from './liveness/liveness_notification'
+import { ErrorResponse } from './liveness/error_response'
+import { EnrollmentResponse } from './liveness/enrollment_response'
+import { VerifyMatchResponse } from './liveness/verify_match_response'
+import { VerificationResponse } from './liveness/verification_response'
+export { LivenessBackendException, LivenessBackendErrorCode, LivenessConfig, RecordingProcess, LivenessType, LivenessSkipStep, LivenessException, LivenessErrorCode, LivenessNotification, LivenessProcessStatus, LivenessResponse, LivenessStatus, EnrollmentConfig, EnrollmentRequest, VerificationConfig, ErrorResponse, EnrollmentResponse, VerifyMatchResponse, VerificationResponse }
 
 import { ComparedFace } from './match_faces/compared_face'
 import { ComparedFacesPair } from './match_faces/compared_faces_pair'
@@ -73,7 +73,6 @@ import { MatchFacesException, MatchFacesErrorCode } from './match_faces/match_fa
 import { MatchFacesImage } from './match_faces/match_faces_image'
 import { MatchFacesRequest } from './match_faces/match_faces_request'
 import { MatchFacesResponse } from './match_faces/match_faces_response'
-
 export { ComparedFace, ComparedFacesPair, ComparedFacesSplit, MatchFacesBackendException, MatchFacesConfig, ProcessingMode, MatchFacesDetectionFace, MatchFacesDetection, MatchFacesException, MatchFacesErrorCode, MatchFacesImage, MatchFacesRequest, MatchFacesResponse }
 
 import { EditGroupPersonsRequest } from './person_database/edit_group_persons_request'
@@ -87,7 +86,6 @@ import { SearchPersonDetection } from './person_database/search_person_detection
 import { SearchPersonImage } from './person_database/search_person_image'
 import { SearchPersonRequest } from './person_database/search_person_request'
 import { SearchPerson } from './person_database/search_person'
-
 export { EditGroupPersonsRequest, ImageUpload, PageableItemList, PersonDatabase, PersonGroup, PersonImage, Person, SearchPersonDetection, SearchPersonImage, SearchPersonRequest, SearchPerson }
 
 
@@ -195,6 +193,29 @@ export class FaceSDK {
         return LivenessResponse.fromJson(JSON.parse(response))
     }
 
+    async startEnrollment(params) {
+        _setCameraSwitchCallback(params?.cameraSwitchCallback)
+        _setLivenessNotificationCompletion(params?.notificationCompletion)
+        var response = JSON.parse(await exec("startEnrollment", [params.config]))
+        var lr = LivenessResponse.fromJson(response["livenessResponse"]);
+        var er = EnrollmentResponse.fromJson(response["enrollmentResponse"]);
+        return [lr, er];
+    }
+
+    async startVerification(params) {
+        _setCameraSwitchCallback(params?.cameraSwitchCallback)
+        _setLivenessNotificationCompletion(params?.notificationCompletion)
+        var response = JSON.parse(await exec("startVerification", [params.config]))
+        var lr = LivenessResponse.fromJson(response["livenessResponse"]);
+        var er = VerificationResponse.fromJson(response["verificationResponse"]);
+        return [lr, er];
+    }
+
+    async enrollWithTrustedPhoto(request) {
+        var response = await exec("enrollWithTrustedPhoto", [request])
+        return EnrollmentResponse.fromJson(JSON.parse(response));
+    }
+
     stopLiveness() {
         exec("stopLiveness", [])
     }

package/www/capacitor/liveness/enrollment_config.js

@@ -0,0 +1,102 @@
+import { CameraPosition } from '../customization/camera_position'
+import { ScreenOrientation } from '../customization/screen_orientation'
+import { RecordingProcess, LivenessType, LivenessSkipStep } from './liveness_config'
+
+export class EnrollmentConfig {
+    copyright
+    cameraSwitchEnabled
+    closeButtonEnabled
+    torchButtonEnabled
+    vibrateOnSteps
+    cameraPositionIOS
+    cameraPositionAndroid
+    screenOrientation
+    locationTrackingEnabled
+    preventScreenRecording
+    attemptsCount
+    recordingProcess
+    livenessType
+    tag
+    skipStep
+    metadata
+    externalId
+    groupId
+    checkDuplicatesEnabled
+    duplicatesThreshold
+
+    constructor(params) {
+        this.copyright = params?.copyright ?? true
+        this.cameraSwitchEnabled = params?.cameraSwitchEnabled ?? false
+        this.closeButtonEnabled = params?.closeButtonEnabled ?? true
+        this.torchButtonEnabled = params?.torchButtonEnabled ?? true
+        this.vibrateOnSteps = params?.vibrateOnSteps ?? true
+        this.cameraPositionIOS = params?.cameraPositionIOS ?? CameraPosition.FRONT
+        this.cameraPositionAndroid = params?.cameraPositionAndroid
+        this.screenOrientation = params?.screenOrientation ?? [ScreenOrientation.PORTRAIT]
+        this.locationTrackingEnabled = params?.locationTrackingEnabled ?? true
+        this.preventScreenRecording = params?.preventScreenRecording ?? false
+        this.attemptsCount = params?.attemptsCount ?? 0
+        this.recordingProcess = params?.recordingProcess ?? RecordingProcess.ASYNCHRONOUS_UPLOAD
+        this.livenessType = params?.livenessType ?? LivenessType.ACTIVE
+        this.tag = params?.tag
+        this.skipStep = params?.skipStep ?? []
+        this.metadata = params?.metadata
+        this.externalId = params?.externalId
+        this.groupId = params?.groupId
+        this.checkDuplicatesEnabled = params?.checkDuplicatesEnabled
+        this.duplicatesThreshold = params?.duplicatesThreshold
+    }
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+        const result = new EnrollmentConfig()
+
+        result.copyright = jsonObject["copyright"]
+        result.cameraSwitchEnabled = jsonObject["cameraSwitchEnabled"]
+        result.closeButtonEnabled = jsonObject["closeButtonEnabled"]
+        result.torchButtonEnabled = jsonObject["torchButtonEnabled"]
+        result.vibrateOnSteps = jsonObject["vibrateOnSteps"]
+        result.cameraPositionAndroid = jsonObject["cameraPositionAndroid"]
+        result.cameraPositionIOS = jsonObject["cameraPositionIOS"]
+        result.screenOrientation = jsonObject["screenOrientation"]
+        result.locationTrackingEnabled = jsonObject["locationTrackingEnabled"]
+        result.preventScreenRecording = jsonObject["preventScreenRecording"]
+        result.attemptsCount = jsonObject["attemptsCount"]
+        result.recordingProcess = jsonObject["recordingProcess"]
+        result.livenessType = jsonObject["livenessType"]
+        result.tag = jsonObject["tag"]
+        result.skipStep = jsonObject["skipStep"]
+        result.metadata = jsonObject["metadata"]
+        result.externalId = jsonObject["externalId"]
+        result.groupId = jsonObject["groupId"]
+        result.checkDuplicatesEnabled = jsonObject["checkDuplicatesEnabled"]
+        result.duplicatesThreshold = jsonObject["duplicatesThreshold"]
+
+        return result
+    }
+
+    toJson() {
+        return {
+            "copyright": this.copyright,
+            "cameraSwitchEnabled": this.cameraSwitchEnabled,
+            "closeButtonEnabled": this.closeButtonEnabled,
+            "torchButtonEnabled": this.torchButtonEnabled,
+            "vibrateOnSteps": this.vibrateOnSteps,
+            "cameraPositionAndroid": this.cameraPositionAndroid,
+            "cameraPositionIOS": this.cameraPositionIOS,
+            "screenOrientation": this.screenOrientation,
+            "locationTrackingEnabled": this.locationTrackingEnabled,
+            "preventScreenRecording": this.preventScreenRecording,
+            "attemptsCount": this.attemptsCount,
+            "recordingProcess": this.recordingProcess,
+            "livenessType": this.livenessType,
+            "tag": this.tag,
+            "skipStep": this.skipStep,
+            "metadata": this.metadata,
+            "externalId": this.externalId,
+            "groupId": this.groupId,
+            "checkDuplicatesEnabled": this.checkDuplicatesEnabled,
+            "duplicatesThreshold": this.duplicatesThreshold,
+        }
+    }
+}

package/www/capacitor/liveness/enrollment_request.js

@@ -0,0 +1,34 @@
+export class EnrollmentRequest {
+    externalId
+    groupId
+    trustedImage
+    trustedImageUrl
+
+    constructor(params) {
+        this.externalId = params?.externalId
+        this.groupId = params?.groupId
+        this.trustedImage = params?.trustedImage
+        this.trustedImageUrl = params?.trustedImageUrl
+    }
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+        const result = new EnrollmentRequest()
+
+        result.externalId = jsonObject["externalId"]
+        result.groupId = jsonObject["groupId"]
+        result.trustedImage = jsonObject["trustedImage"]
+        result.trustedImageUrl = jsonObject["trustedImageUrl"]
+
+        return result
+    }
+
+    toJson() {
+        return {
+            "externalId": this.externalId,
+            "groupId": this.groupId,
+            "trustedImage": this.trustedImage,
+            "trustedImageUrl": this.trustedImageUrl,
+        }
+    }
+}

package/www/capacitor/liveness/enrollment_response.js

@@ -0,0 +1,26 @@
+import { ErrorResponse } from './error_response'
+
+export class EnrollmentResponse {
+    personId
+    externalId
+    error
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+        const result = new EnrollmentResponse()
+
+        result.personId = jsonObject["personId"]
+        result.externalId = jsonObject["externalId"]
+        result.error = ErrorResponse.fromJson(jsonObject["error"])
+
+        return result
+    }
+
+    toJson() {
+        return {
+            "personId": this.personId,
+            "externalId": this.externalId,
+            "error": this.error?.toJson(),
+        }
+    }
+}

package/www/capacitor/liveness/error_response.js

@@ -0,0 +1,21 @@
+export class ErrorResponse {
+    code
+    message
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+        const result = new ErrorResponse()
+
+        result.code = jsonObject["code"]
+        result.message = jsonObject["message"]
+
+        return result
+    }
+
+    toJson() {
+        return {
+            "code": this.code,
+            "message": this.message,
+        }
+    }
+}

package/www/capacitor/liveness/liveness_config.js

@@ -93,6 +93,7 @@ export const RecordingProcess = {
 export const LivenessType = {
     ACTIVE: 0,
     PASSIVE: 1,
+    PASSIVE_WITH_BLINK: 2,
 }
 
 export const LivenessSkipStep = {

package/www/capacitor/liveness/liveness_exception.js

@@ -35,9 +35,10 @@ export const LivenessErrorCode = {
     PROCESSING_FAILED: 6,
     PROCESSING_FRAME_FAILED: 7,
     APPLICATION_INACTIVE: 8,
-    CONTEXT_IS_NULL: 9,
-    IN_PROGRESS_ALREADY: 10,
-    ZOOM_NOT_SUPPORTED: 11,
-    CAMERA_NO_PERMISSION: 12,
-    CAMERA_NOT_AVAILABLE: 13,
+    BAD_FACE_QUALITY: 9,
+    CONTEXT_IS_NULL: 10,
+    IN_PROGRESS_ALREADY: 11,
+    ZOOM_NOT_SUPPORTED: 12,
+    CAMERA_NO_PERMISSION: 13,
+    CAMERA_NOT_AVAILABLE: 14,
 }

package/www/capacitor/liveness/liveness_notification.js

@@ -38,4 +38,6 @@ export const LivenessProcessStatus = {
     FAILED: 12,
     RETRY: 13,
     SUCCESS: 14,
+    BLINK: 15,
+    BAD_FACE_QUALITY: 16,
 }

package/www/capacitor/liveness/verification_config.js

@@ -0,0 +1,98 @@
+import { CameraPosition } from '../customization/camera_position'
+import { ScreenOrientation } from '../customization/screen_orientation'
+import { RecordingProcess, LivenessType, LivenessSkipStep } from './liveness_config'
+
+export class VerificationConfig {
+    copyright
+    cameraSwitchEnabled
+    closeButtonEnabled
+    torchButtonEnabled
+    vibrateOnSteps
+    cameraPositionIOS
+    cameraPositionAndroid
+    screenOrientation
+    locationTrackingEnabled
+    preventScreenRecording
+    attemptsCount
+    recordingProcess
+    livenessType
+    tag
+    skipStep
+    metadata
+    personId
+    groupId
+    threshold
+
+    constructor(params) {
+        this.copyright = params?.copyright ?? true
+        this.cameraSwitchEnabled = params?.cameraSwitchEnabled ?? false
+        this.closeButtonEnabled = params?.closeButtonEnabled ?? true
+        this.torchButtonEnabled = params?.torchButtonEnabled ?? true
+        this.vibrateOnSteps = params?.vibrateOnSteps ?? true
+        this.cameraPositionIOS = params?.cameraPositionIOS ?? CameraPosition.FRONT
+        this.cameraPositionAndroid = params?.cameraPositionAndroid
+        this.screenOrientation = params?.screenOrientation ?? [ScreenOrientation.PORTRAIT]
+        this.locationTrackingEnabled = params?.locationTrackingEnabled ?? true
+        this.preventScreenRecording = params?.preventScreenRecording ?? false
+        this.attemptsCount = params?.attemptsCount ?? 0
+        this.recordingProcess = params?.recordingProcess ?? RecordingProcess.ASYNCHRONOUS_UPLOAD
+        this.livenessType = params?.livenessType ?? LivenessType.ACTIVE
+        this.tag = params?.tag
+        this.skipStep = params?.skipStep ?? []
+        this.metadata = params?.metadata
+        this.personId = params?.personId
+        this.groupId = params?.groupId
+        this.threshold = params?.threshold
+    }
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+        const result = new VerificationConfig()
+
+        result.copyright = jsonObject["copyright"]
+        result.cameraSwitchEnabled = jsonObject["cameraSwitchEnabled"]
+        result.closeButtonEnabled = jsonObject["closeButtonEnabled"]
+        result.torchButtonEnabled = jsonObject["torchButtonEnabled"]
+        result.vibrateOnSteps = jsonObject["vibrateOnSteps"]
+        result.cameraPositionAndroid = jsonObject["cameraPositionAndroid"]
+        result.cameraPositionIOS = jsonObject["cameraPositionIOS"]
+        result.screenOrientation = jsonObject["screenOrientation"]
+        result.locationTrackingEnabled = jsonObject["locationTrackingEnabled"]
+        result.preventScreenRecording = jsonObject["preventScreenRecording"]
+        result.attemptsCount = jsonObject["attemptsCount"]
+        result.recordingProcess = jsonObject["recordingProcess"]
+        result.livenessType = jsonObject["livenessType"]
+        result.tag = jsonObject["tag"]
+        result.skipStep = jsonObject["skipStep"]
+        result.metadata = jsonObject["metadata"]
+        result.personId = jsonObject["personId"]
+        result.groupId = jsonObject["groupId"]
+        result.threshold = jsonObject["threshold"]
+
+        return result
+    }
+
+    toJson() {
+        return {
+            "copyright": this.copyright,
+            "cameraSwitchEnabled": this.cameraSwitchEnabled,
+            "closeButtonEnabled": this.closeButtonEnabled,
+            "torchButtonEnabled": this.torchButtonEnabled,
+            "vibrateOnSteps": this.vibrateOnSteps,
+            "cameraPositionAndroid": this.cameraPositionAndroid,
+            "cameraPositionIOS": this.cameraPositionIOS,
+            "screenOrientation": this.screenOrientation,
+            "locationTrackingEnabled": this.locationTrackingEnabled,
+            "preventScreenRecording": this.preventScreenRecording,
+            "attemptsCount": this.attemptsCount,
+            "recordingProcess": this.recordingProcess,
+            "livenessType": this.livenessType,
+            "tag": this.tag,
+            "skipStep": this.skipStep,
+            "metadata": this.metadata,
+            "personId": this.personId,
+            "groupId": this.groupId,
+            "threshold": this.threshold,
+        }
+    }
+}

package/www/capacitor/liveness/verification_response.js

@@ -0,0 +1,27 @@
+import { VerifyMatchResponse } from './verify_match_response'
+import { ErrorResponse } from './error_response'
+
+export class VerificationResponse {
+    passed
+    match
+    error
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+        const result = new VerificationResponse()
+
+        result.passed = jsonObject["passed"]
+        result.match = VerifyMatchResponse.fromJson(jsonObject["match"])
+        result.error = ErrorResponse.fromJson(jsonObject["error"])
+
+        return result
+    }
+
+    toJson() {
+        return {
+            "passed": this.passed,
+            "match": this.match?.toJson(),
+            "error": this.error?.toJson(),
+        }
+    }
+}

package/www/capacitor/liveness/verify_match_response.js

@@ -0,0 +1,21 @@
+export class VerifyMatchResponse {
+    passed
+    similarity
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+        const result = new VerifyMatchResponse()
+
+        result.passed = jsonObject["passed"]
+        result.similarity = jsonObject["similarity"]
+
+        return result
+    }
+
+    toJson() {
+        return {
+            "passed": this.passed,
+            "similarity": this.similarity,
+        }
+    }
+}