@regulaforensics/face-sdk 8.3.1174-rc → 8.3.1176-nightly

package/test/test.tsx

@@ -1,61 +1,184 @@
 import { compare } from './utils'
-import { ComparedFace, ComparedFacesPair, ComparedFacesSplit, Customization, DetectFaceResult, DetectFacesAttributeResult, DetectFacesBackendException, DetectFacesConfig, DetectFacesException, DetectFacesRequest, DetectFacesResponse, EditGroupPersonsRequest, FaceCaptureConfig, FaceCaptureException, FaceCaptureImage, FaceCaptureResponse, FaceSDKVersion, ImageQualityCharacteristic, ImageQualityRange, ImageQualityResult, ImageUpload, InitConfig, InitException, LicenseException, LivenessBackendException, LivenessConfig, LivenessException, LivenessNotification, LivenessResponse, MatchFacesBackendException, MatchFacesConfig, MatchFacesDetection, MatchFacesDetectionFace, MatchFacesException, MatchFacesImage, MatchFacesRequest, MatchFacesResponse, OutputImageCrop, OutputImageParams, Person, PersonGroup, PersonImage, Point, Rect, SearchPerson, SearchPersonDetection, SearchPersonImage, SearchPersonRequest, Size } from '@regulaforensics/face-sdk/www/capacitor'
-import { comparedFace, comparedFacesPair, comparedFacesSplit, customization, detectFaceResult, detectFacesAttributeResult, detectFacesBackendException, detectFacesConfig, detectFacesException, detectFacesRequest, detectFacesResponse, editGroupPersonsRequest, faceCaptureConfig, faceCaptureException, faceCaptureImage, faceCaptureResponse, faceSDKVersion, imageQualityCharacteristic, imageQualityRange, imageQualityResult, imageUpload, initConfig, initException, licenseException, livenessBackendException, livenessConfig, livenessException, livenessNotification, livenessResponse, matchFacesBackendException, matchFacesConfig, matchFacesDetection, matchFacesDetectionFace, matchFacesException, matchFacesImage, matchFacesRequest, matchFacesResponse, outputImageCrop, outputImageParams, person, personGroup, personImage, point, rect, searchPerson, searchPersonDetection, searchPersonImage, searchPersonRequest, size } from './json'
-
-compare('customization', customization, Customization.fromJson)
-
-compare('point', point, Point.fromJson)
-compare('rect', rect, Rect.fromJson)
-compare('size', size, Size.fromJson)
-compare('outputImageCrop', outputImageCrop, OutputImageCrop.fromJson)
-compare('outputImageParams', outputImageParams, OutputImageParams.fromJson)
-
-compare('imageQualityRange', imageQualityRange, ImageQualityRange.fromJson)
-compare('imageQualityResult', imageQualityResult, ImageQualityResult.fromJson)
-compare('imageQualityCharacteristic', imageQualityCharacteristic, ImageQualityCharacteristic.fromJson)
-
-compare('faceSDKVersion', faceSDKVersion, FaceSDKVersion.fromJson)
-compare('initConfig', initConfig, InitConfig.fromJson)
-compare('licenseException', licenseException, LicenseException.fromJson)
-compare('initException', initException, InitException.fromJson)
-
-compare('detectFacesAttributeResult', detectFacesAttributeResult, DetectFacesAttributeResult.fromJson)
-compare('detectFaceResult', detectFaceResult, DetectFaceResult.fromJson)
-compare('detectFacesConfig', detectFacesConfig, DetectFacesConfig.fromJson)
-compare('detectFacesRequest', detectFacesRequest, DetectFacesRequest.fromJson)
-compare('detectFacesBackendException', detectFacesBackendException, DetectFacesBackendException.fromJson)
-compare('detectFacesException', detectFacesException, DetectFacesException.fromJson)
-compare('detectFacesResponse', detectFacesResponse, DetectFacesResponse.fromJson)
-
-compare('faceCaptureConfig', faceCaptureConfig, FaceCaptureConfig.fromJson)
-compare('faceCaptureImage', faceCaptureImage, FaceCaptureImage.fromJson)
-compare('faceCaptureException', faceCaptureException, FaceCaptureException.fromJson)
-compare('faceCaptureResponse', faceCaptureResponse, FaceCaptureResponse.fromJson)
-
-compare('livenessConfig', livenessConfig, LivenessConfig.fromJson)
-compare('livenessBackendException', livenessBackendException, LivenessBackendException.fromJson)
-compare('livenessException', livenessException, LivenessException.fromJson)
-compare('livenessResponse', livenessResponse, LivenessResponse.fromJson)
-compare('livenessNotification', livenessNotification, LivenessNotification.fromJson)
-
-compare('matchFacesConfig', matchFacesConfig, MatchFacesConfig.fromJson)
-compare('matchFacesImage', matchFacesImage, MatchFacesImage.fromJson)
-compare('matchFacesRequest', matchFacesRequest, MatchFacesRequest.fromJson)
-compare('matchFacesDetectionFace', matchFacesDetectionFace, MatchFacesDetectionFace.fromJson)
-compare('matchFacesBackendException', matchFacesBackendException, MatchFacesBackendException.fromJson)
-compare('matchFacesException', matchFacesException, MatchFacesException.fromJson)
-compare('matchFacesDetection', matchFacesDetection, MatchFacesDetection.fromJson)
-compare('comparedFace', comparedFace, ComparedFace.fromJson)
-compare('comparedFacesPair', comparedFacesPair, ComparedFacesPair.fromJson)
-compare('matchFacesResponse', matchFacesResponse, MatchFacesResponse.fromJson)
-compare('comparedFacesSplit', comparedFacesSplit, ComparedFacesSplit.fromJson)
-
-compare('editGroupPersonsRequest', editGroupPersonsRequest, EditGroupPersonsRequest.fromJson)
-compare('imageUpload', imageUpload, ImageUpload.fromJson)
-compare('person', person, Person.fromJson)
-compare('personGroup', personGroup, PersonGroup.fromJson)
-compare('personImage', personImage, PersonImage.fromJson)
-compare('searchPersonDetection', searchPersonDetection, SearchPersonDetection.fromJson)
-compare('searchPersonImage', searchPersonImage, SearchPersonImage.fromJson)
-compare('searchPerson', searchPerson, SearchPerson.fromJson)
-compare('searchPersonRequest', searchPersonRequest, SearchPersonRequest.fromJson)
+import {
+    ComparedFace,
+    ComparedFacesPair,
+    ComparedFacesSplit,
+    Customization,
+    DetectFaceResult,
+    DetectFacesAttributeResult,
+    DetectFacesBackendException,
+    DetectFacesConfig,
+    DetectFacesException,
+    DetectFacesRequest,
+    DetectFacesResponse,
+    EditGroupPersonsRequest,
+    FaceCaptureConfig,
+    FaceCaptureException,
+    FaceCaptureImage,
+    FaceCaptureResponse,
+    FaceSDKVersion,
+    ImageQualityCharacteristic,
+    ImageQualityRange,
+    ImageQualityResult,
+    ImageUpload,
+    InitConfig,
+    InitException,
+    LicenseException,
+    LivenessBackendException,
+    LivenessConfig,
+    LivenessException,
+    LivenessNotification,
+    LivenessResponse,
+    MatchFacesBackendException,
+    MatchFacesConfig,
+    MatchFacesDetection,
+    MatchFacesDetectionFace,
+    MatchFacesException,
+    MatchFacesImage,
+    MatchFacesRequest,
+    MatchFacesResponse,
+    OutputImageCrop,
+    OutputImageParams,
+    Person,
+    PersonGroup,
+    PersonImage,
+    Point,
+    Rect,
+    SearchPerson,
+    SearchPersonDetection,
+    SearchPersonImage,
+    SearchPersonRequest,
+    Size,
+    // EnrollmentConfig,
+    // VerificationConfig,
+    // EnrollmentRequest,
+    // ErrorResponse,
+    // EnrollmentResponse,
+    // VerifyMatchResponse,
+    // VerificationResponse,
+} from '@regulaforensics/face-sdk/www/capacitor'
+import {
+    comparedFace,
+    comparedFacesPair,
+    comparedFacesSplit,
+    customization,
+    detectFaceResult,
+    detectFacesAttributeResult,
+    detectFacesBackendException,
+    detectFacesConfig,
+    detectFacesException,
+    detectFacesRequest,
+    detectFacesResponse,
+    editGroupPersonsRequest,
+    faceCaptureConfig,
+    faceCaptureException,
+    faceCaptureImage,
+    faceCaptureResponse,
+    faceSDKVersion,
+    imageQualityCharacteristic,
+    imageQualityRange,
+    imageQualityResult,
+    imageUpload,
+    initConfig,
+    initException,
+    licenseException,
+    livenessBackendException,
+    livenessConfig,
+    livenessException,
+    livenessNotification,
+    livenessResponse,
+    matchFacesBackendException,
+    matchFacesConfig,
+    matchFacesDetection,
+    matchFacesDetectionFace,
+    matchFacesException,
+    matchFacesImage,
+    matchFacesRequest,
+    matchFacesResponse,
+    outputImageCrop,
+    outputImageParams,
+    person,
+    personGroup,
+    personImage,
+    point,
+    rect,
+    searchPerson,
+    searchPersonDetection,
+    searchPersonImage,
+    searchPersonRequest,
+    size,
+    enrollmentConfig,
+    verificationConfig,
+    enrollmentRequest,
+    enrollmentRequest2,
+    errorResponse,
+    enrollmentResponse,
+    verifyMatchResponse,
+    verificationResponse,
+} from './json'
+
+compare('customization', customization, Customization.fromJson);
+
+compare('point', point, Point.fromJson);
+compare('rect', rect, Rect.fromJson);
+compare('size', size, Size.fromJson);
+compare('outputImageCrop', outputImageCrop, OutputImageCrop.fromJson);
+compare('outputImageParams', outputImageParams, OutputImageParams.fromJson);
+
+compare('imageQualityRange', imageQualityRange, ImageQualityRange.fromJson);
+compare('imageQualityResult', imageQualityResult, ImageQualityResult.fromJson);
+compare('imageQualityCharacteristic', imageQualityCharacteristic, ImageQualityCharacteristic.fromJson);
+
+compare('faceSDKVersion', faceSDKVersion, FaceSDKVersion.fromJson);
+compare('initConfig', initConfig, InitConfig.fromJson);
+compare('licenseException', licenseException, LicenseException.fromJson);
+compare('initException', initException, InitException.fromJson);
+
+compare('detectFacesAttributeResult', detectFacesAttributeResult, DetectFacesAttributeResult.fromJson);
+compare('detectFaceResult', detectFaceResult, DetectFaceResult.fromJson);
+compare('detectFacesConfig', detectFacesConfig, DetectFacesConfig.fromJson);
+compare('detectFacesRequest', detectFacesRequest, DetectFacesRequest.fromJson);
+compare('detectFacesBackendException', detectFacesBackendException, DetectFacesBackendException.fromJson);
+compare('detectFacesException', detectFacesException, DetectFacesException.fromJson);
+compare('detectFacesResponse', detectFacesResponse, DetectFacesResponse.fromJson);
+
+compare('faceCaptureConfig', faceCaptureConfig, FaceCaptureConfig.fromJson);
+compare('faceCaptureImage', faceCaptureImage, FaceCaptureImage.fromJson);
+compare('faceCaptureException', faceCaptureException, FaceCaptureException.fromJson);
+compare('faceCaptureResponse', faceCaptureResponse, FaceCaptureResponse.fromJson);
+
+compare('livenessConfig', livenessConfig, LivenessConfig.fromJson);
+// compare('enrollmentConfig', enrollmentConfig, EnrollmentConfig.fromJson);
+// compare('verificationConfig', verificationConfig, VerificationConfig.fromJson);
+// compare('enrollmentRequest', enrollmentRequest, EnrollmentRequest.fromJson);
+// compare('enrollmentRequest2', enrollmentRequest2, EnrollmentRequest.fromJson);
+compare('livenessBackendException', livenessBackendException, LivenessBackendException.fromJson);
+compare('livenessException', livenessException, LivenessException.fromJson);
+compare('livenessResponse', livenessResponse, LivenessResponse.fromJson);
+compare('livenessNotification', livenessNotification, LivenessNotification.fromJson);
+// compare('errorResponse', errorResponse, ErrorResponse.fromJson);
+// compare('enrollmentResponse', enrollmentResponse, EnrollmentResponse.fromJson);
+// compare('verifyMatchResponse', verifyMatchResponse, VerifyMatchResponse.fromJson);
+// compare('verificationResponse', verificationResponse, VerificationResponse.fromJson);
+
+compare('matchFacesConfig', matchFacesConfig, MatchFacesConfig.fromJson);
+compare('matchFacesImage', matchFacesImage, MatchFacesImage.fromJson);
+compare('matchFacesRequest', matchFacesRequest, MatchFacesRequest.fromJson);
+compare('matchFacesDetectionFace', matchFacesDetectionFace, MatchFacesDetectionFace.fromJson);
+compare('matchFacesBackendException', matchFacesBackendException, MatchFacesBackendException.fromJson);
+compare('matchFacesException', matchFacesException, MatchFacesException.fromJson);
+compare('matchFacesDetection', matchFacesDetection, MatchFacesDetection.fromJson);
+compare('comparedFace', comparedFace, ComparedFace.fromJson);
+compare('comparedFacesPair', comparedFacesPair, ComparedFacesPair.fromJson);
+compare('matchFacesResponse', matchFacesResponse, MatchFacesResponse.fromJson);
+compare('comparedFacesSplit', comparedFacesSplit, ComparedFacesSplit.fromJson);
+
+compare('editGroupPersonsRequest', editGroupPersonsRequest, EditGroupPersonsRequest.fromJson);
+compare('imageUpload', imageUpload, ImageUpload.fromJson);
+compare('person', person, Person.fromJson);
+compare('personGroup', personGroup, PersonGroup.fromJson);
+compare('personImage', personImage, PersonImage.fromJson);
+compare('searchPersonDetection', searchPersonDetection, SearchPersonDetection.fromJson);
+compare('searchPersonImage', searchPersonImage, SearchPersonImage.fromJson);
+compare('searchPerson', searchPerson, SearchPerson.fromJson);
+compare('searchPersonRequest', searchPersonRequest, SearchPersonRequest.fromJson);

package/www/capacitor/customization/customization_images.js

@@ -73,6 +73,42 @@ export class CustomizationImages {
         this._set({ "retryScreenHintGeo": val })
     }
 
+    _retryScreenHintBadSelfieQuality
+    set retryScreenHintBadSelfieQuality(val) {
+        this._retryScreenHintBadSelfieQuality = val
+        this._set({ "retryScreenHintBadSelfieQuality": val })
+    }
+
+    _retryScreenHintCleanLens
+    set retryScreenHintCleanLens(val) {
+        this._retryScreenHintCleanLens = val
+        this._set({ "retryScreenHintCleanLens": val })
+    }
+
+    _retryScreenHintAddIllumination
+    set retryScreenHintAddIllumination(val) {
+        this._retryScreenHintAddIllumination = val
+        this._set({ "retryScreenHintAddIllumination": val })
+    }
+
+    _retryScreenHintChangeBackground
+    set retryScreenHintChangeBackground(val) {
+        this._retryScreenHintChangeBackground = val
+        this._set({ "retryScreenHintChangeBackground": val })
+    }
+
+    _retryScreenHintFaceOcclusions
+    set retryScreenHintFaceOcclusions(val) {
+        this._retryScreenHintFaceOcclusions = val
+        this._set({ "retryScreenHintFaceOcclusions": val })
+    }
+
+    _retryScreenHintCovering
+    set retryScreenHintCovering(val) {
+        this._retryScreenHintCovering = val
+        this._set({ "retryScreenHintCovering": val })
+    }
+
     _processingScreenCloseButton
     set processingScreenCloseButton(val) {
         this._processingScreenCloseButton = val
@@ -100,6 +136,12 @@ export class CustomizationImages {
         result._retryScreenHintEnvironment = jsonObject["retryScreenHintEnvironment"]
         result._retryScreenHintSubject = jsonObject["retryScreenHintSubject"]
         result._retryScreenHintGeo = jsonObject["retryScreenHintGeo"]
+        result._retryScreenHintBadSelfieQuality = jsonObject["retryScreenHintBadSelfieQuality"]
+        result._retryScreenHintCleanLens = jsonObject["retryScreenHintCleanLens"]
+        result._retryScreenHintAddIllumination = jsonObject["retryScreenHintAddIllumination"]
+        result._retryScreenHintChangeBackground = jsonObject["retryScreenHintChangeBackground"]
+        result._retryScreenHintFaceOcclusions = jsonObject["retryScreenHintFaceOcclusions"]
+        result._retryScreenHintCovering = jsonObject["retryScreenHintCovering"]
         result._processingScreenCloseButton = jsonObject["processingScreenCloseButton"]
         result._successScreenImage = jsonObject["successScreenImage"]
 
@@ -120,6 +162,12 @@ export class CustomizationImages {
             "retryScreenHintEnvironment": this._retryScreenHintEnvironment,
             "retryScreenHintSubject": this._retryScreenHintSubject,
             "retryScreenHintGeo": this._retryScreenHintGeo,
+            "retryScreenHintBadSelfieQuality": this._retryScreenHintBadSelfieQuality,
+            "retryScreenHintCleanLens": this._retryScreenHintCleanLens,
+            "retryScreenHintAddIllumination": this._retryScreenHintAddIllumination,
+            "retryScreenHintChangeBackground": this._retryScreenHintChangeBackground,
+            "retryScreenHintFaceOcclusions": this._retryScreenHintFaceOcclusions,
+            "retryScreenHintCovering": this._retryScreenHintCovering,
             "processingScreenCloseButton": this._processingScreenCloseButton,
             "successScreenImage": this._successScreenImage,
         }

package/www/capacitor/customization/font.js

@@ -3,10 +3,10 @@ export class Font {
     size
     style
 
-    constructor(name, params) {
+    constructor(name, options) {
         this.name = name
-        this.size = params?.size
-        this.style = params?.style
+        this.size = options?.size
+        this.style = options?.style
     }
 
     static fromJson(jsonObject) {

package/www/capacitor/detect_faces/detect_faces_config.js

@@ -7,12 +7,12 @@ export class DetectFacesConfig {
     outputImageParams
     onlyCentralFace
 
-    constructor(params) {
+    constructor(options) {
         this.onlyCentralFace = false
-        this.attributes = params?.attributes
-        this.customQuality = params?.customQuality
-        this.outputImageParams = params?.outputImageParams
-        this.onlyCentralFace = params?.onlyCentralFace ?? this.onlyCentralFace
+        this.attributes = options?.attributes
+        this.customQuality = options?.customQuality
+        this.outputImageParams = options?.outputImageParams
+        this.onlyCentralFace = options?.onlyCentralFace ?? this.onlyCentralFace
     }
 
     static fromJson(jsonObject) {

package/www/capacitor/detect_faces/detect_faces_request.js

@@ -6,10 +6,10 @@ export class DetectFacesRequest {
     configuration
     tag
 
-    constructor(image, configuration, params) {
+    constructor(image, configuration, options) {
         this.image = image
         this.configuration = configuration
-        this.tag = params?.tag
+        this.tag = options?.tag
     }
 
     static qualityFull(image) {

package/www/capacitor/face_capture/face_capture_config.js

@@ -16,20 +16,20 @@ export class FaceCaptureConfig {
     timeout
     holdStillDuration
 
-    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.detectOcclusion = params?.detectOcclusion ?? true
-        this.showFaceAnimation = params?.showFaceAnimation ?? true
-        this.preventScreenRecording = params?.preventScreenRecording ?? false
-        this.cameraPositionIOS = params?.cameraPositionIOS ?? CameraPosition.FRONT
-        this.cameraPositionAndroid = params?.cameraPositionAndroid
-        this.screenOrientation = params?.screenOrientation ?? [ScreenOrientation.PORTRAIT]
-        this.timeout = params?.timeout
-        this.holdStillDuration = params?.holdStillDuration
+    constructor(options) {
+        this.copyright = options?.copyright ?? true
+        this.cameraSwitchEnabled = options?.cameraSwitchEnabled ?? false
+        this.closeButtonEnabled = options?.closeButtonEnabled ?? true
+        this.torchButtonEnabled = options?.torchButtonEnabled ?? true
+        this.vibrateOnSteps = options?.vibrateOnSteps ?? true
+        this.detectOcclusion = options?.detectOcclusion ?? true
+        this.showFaceAnimation = options?.showFaceAnimation ?? true
+        this.preventScreenRecording = options?.preventScreenRecording ?? false
+        this.cameraPositionIOS = options?.cameraPositionIOS ?? CameraPosition.FRONT
+        this.cameraPositionAndroid = options?.cameraPositionAndroid
+        this.screenOrientation = options?.screenOrientation ?? [ScreenOrientation.PORTRAIT]
+        this.timeout = options?.timeout
+        this.holdStillDuration = options?.holdStillDuration
     }
 
     static fromJson(jsonObject) {

package/www/capacitor/image_params/output_image_crop.js

@@ -6,11 +6,11 @@ export class OutputImageCrop {
     padColor
     returnOriginalRect
 
-    constructor(type, params) {
+    constructor(type, options) {
         this.type = type
-        this.size = params?.size
-        this.padColor = params?.padColor
-        this.returnOriginalRect = params?.returnOriginalRect ?? false
+        this.size = options?.size
+        this.padColor = options?.padColor
+        this.returnOriginalRect = options?.returnOriginalRect ?? false
     }
 
     static fromJson(jsonObject) {

package/www/capacitor/image_params/output_image_params.js

@@ -4,9 +4,9 @@ export class OutputImageParams {
     crop
     backgroundColor
 
-    constructor(params) {
-        this.crop = params?.crop
-        this.backgroundColor = params?.backgroundColor
+    constructor(options) {
+        this.crop = options?.crop
+        this.backgroundColor = options?.backgroundColor
     }
 
     static fromJson(jsonObject) {

package/www/capacitor/image_quality/image_quality_characteristic.js

@@ -6,12 +6,12 @@ export class ImageQualityCharacteristic {
     customRange
     color
 
-    static _create(name, params) {
+    static _create(name, options) {
         var result = new ImageQualityCharacteristic()
         result.characteristicName = name
-        result.recommendedRange = params?.recommended
-        result.customRange = params?.custom
-        result.color = params?.color
+        result.recommendedRange = options?.recommended
+        result.customRange = options?.custom
+        result.color = options?.color
         return result
     }
 

package/www/capacitor/image_quality/image_quality_group.js

@@ -289,10 +289,10 @@ export class _Background {
         return ImageQualityCharacteristic._create(ImageQualityCharacteristicName.OTHER_FACES)
     }
 
-    backgroundColorMatch(params) {
+    backgroundColorMatch(options) {
         return ImageQualityCharacteristic._create(
             ImageQualityCharacteristicName.BACKGROUND_COLOR_MATCH,
-            { color: params?.color }
+            { color: options?.color }
         )
     }