@regulaforensics/face-sdk 8.3.1174-rc → 8.3.1177-rc

package/www/react-native/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/react-native/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/react-native/liveness/liveness_config.js

@@ -19,23 +19,23 @@ export class LivenessConfig {
     skipStep
     metadata
 
-    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
+    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.cameraPositionIOS = options?.cameraPositionIOS ?? CameraPosition.FRONT
+        this.cameraPositionAndroid = options?.cameraPositionAndroid
+        this.screenOrientation = options?.screenOrientation ?? [ScreenOrientation.PORTRAIT]
+        this.locationTrackingEnabled = options?.locationTrackingEnabled ?? true
+        this.preventScreenRecording = options?.preventScreenRecording ?? false
+        this.attemptsCount = options?.attemptsCount ?? 0
+        this.recordingProcess = options?.recordingProcess ?? RecordingProcess.ASYNCHRONOUS_UPLOAD
+        this.livenessType = options?.livenessType ?? LivenessType.ACTIVE
+        this.tag = options?.tag
+        this.skipStep = options?.skipStep ?? []
+        this.metadata = options?.metadata
     }
 
     static fromJson(jsonObject) {
@@ -93,6 +93,7 @@ export const RecordingProcess = {
 export const LivenessType = {
     ACTIVE: 0,
     PASSIVE: 1,
+    PASSIVE_WITH_BLINK: 2,
 }
 
 export const LivenessSkipStep = {

package/www/react-native/liveness/liveness_exception.js

@@ -35,9 +35,11 @@ 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,
+    BAD_FACE_QUALITY: 9,
+    BAD_FRAME_SIZE: 10,
+    CAMERA_NOT_AVAILABLE: 11,
     CAMERA_NO_PERMISSION: 12,
-    CAMERA_NOT_AVAILABLE: 13,
-}
+    CONTEXT_IS_NULL: 13,
+    IN_PROGRESS_ALREADY: 14,
+    ZOOM_NOT_SUPPORTED: 15,
+}

package/www/react-native/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/react-native/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(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.cameraPositionIOS = options?.cameraPositionIOS ?? CameraPosition.FRONT
+        this.cameraPositionAndroid = options?.cameraPositionAndroid
+        this.screenOrientation = options?.screenOrientation ?? [ScreenOrientation.PORTRAIT]
+        this.locationTrackingEnabled = options?.locationTrackingEnabled ?? true
+        this.preventScreenRecording = options?.preventScreenRecording ?? false
+        this.attemptsCount = options?.attemptsCount ?? 0
+        this.recordingProcess = options?.recordingProcess ?? RecordingProcess.ASYNCHRONOUS_UPLOAD
+        this.livenessType = options?.livenessType ?? LivenessType.ACTIVE
+        this.tag = options?.tag
+        this.skipStep = options?.skipStep ?? []
+        this.metadata = options?.metadata
+        this.personId = options?.personId
+        this.groupId = options?.groupId
+        this.threshold = options?.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/react-native/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/react-native/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,
+        }
+    }
+}

package/www/react-native/match_faces/match_faces_config.js

@@ -2,9 +2,9 @@ export class MatchFacesConfig {
     processingMode
     locationTrackingEnabled
 
-    constructor(params) {
-        this.processingMode = params?.processingMode ?? ProcessingMode.ONLINE
-        this.locationTrackingEnabled = params?.locationTrackingEnabled ?? true
+    constructor(options) {
+        this.processingMode = options?.processingMode ?? ProcessingMode.ONLINE
+        this.locationTrackingEnabled = options?.locationTrackingEnabled ?? true
     }
 
     static fromJson(jsonObject) {

package/www/react-native/match_faces/match_faces_image.js

@@ -4,10 +4,10 @@ export class MatchFacesImage {
     detectAll
     identifier
 
-    constructor(image, imageType, params) {
+    constructor(image, imageType, options) {
         this.image = image
         this.imageType = imageType
-        this.detectAll = params?.detectAll ?? false
+        this.detectAll = options?.detectAll ?? false
         this.identifier = ""
     }
 

package/www/react-native/match_faces/match_faces_request.js

@@ -7,11 +7,11 @@ export class MatchFacesRequest {
     tag
     metadata
 
-    constructor(images, params) {
+    constructor(images, options) {
         this.images = images
-        this.outputImageParams = params?.outputImageParams
-        this.tag = params?.tag
-        this.metadata = params?.metadata
+        this.outputImageParams = options?.outputImageParams
+        this.tag = options?.tag
+        this.metadata = options?.metadata
     }
 
     static fromJson(jsonObject) {

package/www/react-native/person_database/edit_group_persons_request.js

@@ -2,9 +2,9 @@ export class EditGroupPersonsRequest {
     personIdsToAdd
     personIdsToRemove
 
-    constructor(params) {
-        this.personIdsToAdd = params?.personIdsToAdd
-        this.personIdsToRemove = params?.personIdsToRemove
+    constructor(options) {
+        this.personIdsToAdd = options?.personIdsToAdd
+        this.personIdsToRemove = options?.personIdsToRemove
     }
 
     static fromJson(jsonObject) {

package/www/react-native/person_database/person_database.js

@@ -6,8 +6,8 @@ import { PersonGroup } from './person_group'
 import { SearchPerson } from './search_person'
 
 export class PersonDatabase {
-    async createPerson(name, params) {
-        var response = await exec("createPerson", [name, params?.groupIds, params?.metadata])
+    async createPerson(name, options) {
+        var response = await exec("createPerson", [name, options?.groupIds, options?.metadata])
         return this._itemResponseFromJson(response, Person.fromJson)
     }
 
@@ -51,8 +51,8 @@ export class PersonDatabase {
         return this._listResponseFromJson(response, PersonImage.fromJson)
     }
 
-    async createGroup(name, params) {
-        var response = await exec("createGroup", [name, params?.metadata])
+    async createGroup(name, options) {
+        var response = await exec("createGroup", [name, options?.metadata])
         return this._itemResponseFromJson(response, PersonGroup.fromJson)
     }
 

package/www/react-native/person_database/search_person_request.js

@@ -10,14 +10,14 @@ export class SearchPersonRequest {
     detectAll
     outputImageParams
 
-    constructor(image, params) {
+    constructor(image, options) {
         this.imageUpload = image
-        this.groupIdsForSearch = params?.groupIdsForSearch
-        this.threshold = params?.threshold
-        this.limit = params?.limit
-        this.tag = params?.tag
-        this.detectAll = params?.detectAll ?? false
-        this.outputImageParams = params?.outputImageParams
+        this.groupIdsForSearch = options?.groupIdsForSearch
+        this.threshold = options?.threshold
+        this.limit = options?.limit
+        this.tag = options?.tag
+        this.detectAll = options?.detectAll ?? false
+        this.outputImageParams = options?.outputImageParams
     }
 
     static fromJson(jsonObject) {

package/www/types/customization/customization_images.d.ts

@@ -11,6 +11,12 @@ export class CustomizationImages {
     set retryScreenHintEnvironment(val: string)
     set retryScreenHintSubject(val: string)
     set retryScreenHintGeo(val: string)
+    set retryScreenHintBadSelfieQuality(val: string)
+    set retryScreenHintCleanLens(val: string)
+    set retryScreenHintAddIllumination(val: string)
+    set retryScreenHintChangeBackground(val: string)
+    set retryScreenHintFaceOcclusions(val: string)
+    set retryScreenHintCovering(val: string)
     set processingScreenCloseButton(val: string)
     set successScreenImage(val: string)
 

package/www/types/customization/font.d.ts

@@ -21,7 +21,7 @@ export class Font {
 
     constructor(
         name: string,
-        params?: {
+        options?: {
             size?: number,
             style?: FontStyle
         }

package/www/types/detect_faces/detect_faces_config.d.ts

@@ -27,7 +27,7 @@ export class DetectFacesConfig {
     onlyCentralFace: boolean
 
     constructor(
-        params?: {
+        options?: {
             attributes?: Array<DetectFacesAttribute>,
             customQuality?: Array<ImageQualityCharacteristic>,
             outputImageParams?: OutputImageParams,

package/www/types/detect_faces/detect_faces_request.d.ts

@@ -17,7 +17,7 @@ export class DetectFacesRequest {
     constructor(
         image: string,
         config: DetectFacesConfig,
-        params?: {
+        options?: {
             tag?: string,
         }
     )

package/www/types/face_capture/face_capture_config.d.ts

@@ -32,7 +32,7 @@ export class FaceCaptureConfig {
     holdStillDuration?: number
 
     constructor(
-        params?: {
+        options?: {
             copyright?: boolean
             cameraSwitchEnabled?: boolean
             closeButtonEnabled?: boolean

package/www/types/image_params/output_image_crop.d.ts

@@ -29,7 +29,7 @@ export class OutputImageCrop {
 
     constructor(
         type: OutputImageCropAspectRatio,
-        params?: {
+        options?: {
             size?: Size,
             padColor?: number,
             returnOriginalRect?: boolean,

package/www/types/image_params/output_image_params.d.ts

@@ -20,7 +20,7 @@ export class OutputImageParams {
     get backgroundColor(): number | null
 
     constructor(
-        params?: {
+        options?: {
             crop?: OutputImageCrop,
             backgroundColor?: number,
         }

package/www/types/image_quality/image_quality_group.d.ts

@@ -406,7 +406,7 @@ export class _Background {
      * Default color is white (RGB(255,255,255) or hex #FFFFFF)
      * The range is from 0 to 1 where 1 is full background color match.
      */
-    backgroundColorMatch(params?: { color?: number }): ImageQualityCharacteristic
+    backgroundColorMatch(options?: { color?: number }): ImageQualityCharacteristic
 
     /**
      * Whether the background color matches the required color.