@regulaforensics/face-sdk 6.5.67-beta → 6.5.70-beta

package/www/capacitor/detect_faces/detect_faces_attribute_result.js

@@ -0,0 +1,20 @@
+import { ImageQualityRange } from '../image_quality/image_quality_range'
+
+export class DetectFacesAttributeResult {
+    attribute
+    value
+    range
+    confidence
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+        const result = new DetectFacesAttributeResult()
+
+        result.attribute = jsonObject["attribute"]
+        result.value = jsonObject["value"]
+        result.range = ImageQualityRange.fromJson(jsonObject["range"])
+        result.confidence = jsonObject["confidence"]
+
+        return result
+    }
+}

package/www/capacitor/detect_faces/detect_faces_backend_exception.js

@@ -0,0 +1,23 @@
+export class DetectFacesBackendException {
+    code
+    message
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+        const result = new DetectFacesBackendException()
+
+        result.code = jsonObject["code"]
+        result.message = jsonObject["message"] ?? ""
+
+        return result
+    }
+}
+
+export const DetectFacesBackendErrorCode = {
+    FR_FACE_NOT_DETECTED: 2,
+    FACER_NO_LICENSE: 200,
+    FACER_IS_NOT_INITIALIZED: 201,
+    FACER_COMMAND_IS_NOT_SUPPORTED: 202,
+    FACER_COMMAND_PARAMS_READ_ERROR: 203,
+    UNDEFINED: -1,
+}

package/www/capacitor/detect_faces/detect_faces_config.js

@@ -0,0 +1,14 @@
+export class DetectFacesConfig {
+    attributes
+    customQuality
+    outputImageParams
+    onlyCentralFace
+
+    constructor(params) {
+        this.onlyCentralFace = false
+        this.attributes = params?.attributes
+        this.customQuality = params?.customQuality
+        this.outputImageParams = params?.outputImageParams
+        this.onlyCentralFace = params?.onlyCentralFace ?? this.onlyCentralFace
+    }
+}

package/www/capacitor/detect_faces/detect_faces_exception.js

@@ -0,0 +1,30 @@
+import { DetectFacesBackendException } from "./detect_faces_backend_exception"
+
+export class DetectFacesException {
+    code
+    message
+    underlyingError
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+        const result = new DetectFacesException()
+
+        result.code = jsonObject["code"]
+        result.message = jsonObject["message"] ?? ""
+        result.underlyingError = DetectFacesBackendException.fromJson(jsonObject["underlyingError"])
+
+        return result
+    }
+}
+
+export const DetectFacesErrorCode = {
+    IMAGE_EMPTY: 0,
+    FR_FACE_NOT_DETECTED: 1,
+    FACER_NO_LICENSE: 2,
+    FACER_IS_NOT_INITIALIZED: 3,
+    FACER_COMMAND_IS_NOT_SUPPORTED: 4,
+    FACER_COMMAND_PARAMS_READ_ERROR: 5,
+    PROCESSING_FAILED: 6,
+    REQUEST_FAILED: 7,
+    API_CALL_FAILED: 8,
+}

package/www/capacitor/detect_faces/detect_faces_request.js

@@ -0,0 +1,67 @@
+export class DetectFacesRequest {
+    image
+    configuration
+    tag
+
+    constructor(image, configuration, params) {
+        this.image = image
+        this.configuration = configuration
+        this.tag = params?.tag
+    }
+
+    static qualityFull(image) {
+        const result = new DetectFacesRequest()
+        result.image = image
+        result.scenario = DetectFacesScenario.QUALITY_FULL
+        return result
+    }
+
+    static qualityICAO(image) {
+        const result = new DetectFacesRequest()
+        result.image = image
+        result.scenario = DetectFacesScenario.QUALITY_ICAO
+        return result
+    }
+
+    static qualityVisaSchengen(image) {
+        const result = new DetectFacesRequest()
+        result.image = image
+        result.scenario = DetectFacesScenario.QUALITY_VISA_SCHENGEN
+        return result
+    }
+
+    static qualityVisaUSA(image) {
+        const result = new DetectFacesRequest()
+        result.image = image
+        result.scenario = DetectFacesScenario.QUALITY_VISA_USA
+        return result
+    }
+
+    static cropCentralFace(image) {
+        const result = new DetectFacesRequest()
+        result.image = image
+        result.scenario = DetectFacesScenario.CROP_CENTRAL_FACE
+        return result
+    }
+
+    static cropAllFaces(image) {
+        const result = new DetectFacesRequest()
+        result.image = image
+        result.scenario = DetectFacesScenario.CROP_ALL_FACES
+        return result
+    }
+
+    static thumbnail(image) {
+        const result = new DetectFacesRequest()
+        result.image = image
+        result.scenario = DetectFacesScenario.THUMBNAIL
+        return result
+    }
+
+    static allAttributes(image) {
+        const result = new DetectFacesRequest()
+        result.image = image
+        result.scenario = DetectFacesScenario.ATTRIBUTES_ALL
+        return result
+    }
+}

package/www/capacitor/detect_faces/detect_faces_response.js

@@ -0,0 +1,24 @@
+import { DetectFaceResult } from './detect_face_result'
+import { DetectFacesException } from './detect_faces_exception'
+
+export class DetectFacesResponse {
+    detection
+    scenario
+    error
+    allDetections
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+        const result = new DetectFacesResponse()
+
+        result.detection = DetectFaceResult.fromJson(jsonObject["detection"])
+        result.scenario = jsonObject["scenario"]
+        result.error = DetectFacesException.fromJson(jsonObject["error"])
+        result.allDetections = []
+        if (jsonObject["allDetections"] != null)
+            for (const item of jsonObject["allDetections"])
+                result.allDetections.push(DetectFaceResult.fromJson(item))
+
+        return result
+    }
+}

package/www/capacitor/detect_faces/detect_faces_scenario.js

@@ -0,0 +1,10 @@
+export const DetectFacesScenario = {
+    CROP_CENTRAL_FACE: "CropCentralFace",
+    CROP_ALL_FACES: "CropAllFaces",
+    THUMBNAIL: "Thumbnail",
+    ATTRIBUTES_ALL: "AttributesAll",
+    QUALITY_FULL: "QualityFull",
+    QUALITY_ICAO: "QualityICAO",
+    QUALITY_VISA_SCHENGEN: "QualityVisaSchengen",
+    QUALITY_VISA_USA: "QualityVisaUSA",
+}

package/www/capacitor/face_capture/face_capture_config.js

@@ -0,0 +1,28 @@
+import { CameraPosition } from '../customization/camera_position'
+import { ScreenOrientation } from '../customization/screen_orientation'
+
+export class FaceCaptureConfig {
+    copyright
+    cameraSwitchEnabled
+    closeButtonEnabled
+    torchButtonEnabled
+    vibrateOnSteps
+    cameraPositionIOS
+    screenOrientation
+    cameraPositionAndroid
+    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.cameraPositionIOS = params?.cameraPositionIOS ?? CameraPosition.FRONT
+        this.screenOrientation = params?.screenOrientation ?? [ScreenOrientation.PORTRAIT]
+        this.cameraPositionAndroid = params?.cameraPositionAndroid
+        this.timeout = params?.timeout
+        this.holdStillDuration = params?.holdStillDuration
+    }
+}

package/www/capacitor/face_capture/face_capture_exception.js

@@ -0,0 +1,25 @@
+export class FaceCaptureException {
+    code
+    message
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+        const result = new FaceCaptureException()
+
+        result.code = jsonObject["code"]
+        result.message = jsonObject["message"] ?? ""
+
+        return result
+    }
+}
+
+export const FaceCaptureErrorCode = {
+    CANCEL: 0,
+    TIMEOUT: 1,
+    NOT_INITIALIZED: 2,
+    SESSION_START_FAILED: 3,
+    CAMERA_NOT_AVAILABLE: 4,
+    CAMERA_NO_PERMISSION: 5,
+    IN_PROGRESS_ALREADY: 6,
+    CONTEXT_IS_NULL: 7,
+}

package/www/capacitor/face_capture/face_capture_image.js

@@ -0,0 +1,26 @@
+export class FaceCaptureImage {
+    imageType
+    image
+    tag
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+        const result = new FaceCaptureImage()
+
+        result.imageType = jsonObject["imageType"]
+        result.image = jsonObject["image"]
+        result.tag = jsonObject["tag"]
+
+        return result
+    }
+}
+
+export const ImageType = {
+    PRINTED: 1,
+    RFID: 2,
+    LIVE: 3,
+    DOCUMENT_WITH_LIVE: 4,
+    EXTERNAL: 5,
+    GHOST_PORTRAIT: 6,
+    BARCODE: 7,
+}

package/www/capacitor/face_capture/face_capture_response.js

@@ -0,0 +1,17 @@
+import { FaceCaptureImage } from './face_capture_image'
+import { FaceCaptureException } from './face_capture_exception'
+
+export class FaceCaptureResponse {
+    error
+    image
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+        const result = new FaceCaptureResponse()
+
+        result.error = FaceCaptureException.fromJson(jsonObject["error"])
+        result.image = FaceCaptureImage.fromJson(jsonObject["image"])
+
+        return result
+    }
+}

package/www/capacitor/image_params/output_image_crop.js

@@ -0,0 +1,21 @@
+export class OutputImageCrop {
+    type
+    size
+    padColor
+    returnOriginalRect
+
+    constructor(type, params) {
+        this.type = type
+        this.size = params?.size
+        this.padColor = params?.padColor
+        this.returnOriginalRect = params?.returnOriginalRect ?? false
+    }
+}
+
+export const OutputImageCropAspectRatio = {
+    RATIO_3X4: 0,
+    RATIO_4X5: 1,
+    RATIO_2X3: 2,
+    RATIO_1X1: 3,
+    RATIO_7X9: 4,
+}

package/www/capacitor/image_params/output_image_params.js

@@ -0,0 +1,9 @@
+export class OutputImageParams {
+    crop
+    backgroundColor
+
+    constructor(params) {
+        this.crop = params?.crop
+        this.backgroundColor = params?.backgroundColor
+    }
+}

package/www/capacitor/image_params/point.js

@@ -0,0 +1,14 @@
+export class Point {
+    x
+    y
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+        const result = new Point()
+
+        result.x = jsonObject["x"]
+        result.y = jsonObject["y"]
+
+        return result
+    }
+}

package/www/capacitor/image_params/rect.js

@@ -0,0 +1,18 @@
+export class Rect {
+    bottom
+    top
+    left
+    right
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+        const result = new Rect()
+
+        result.bottom = jsonObject["bottom"]
+        result.top = jsonObject["top"]
+        result.left = jsonObject["left"]
+        result.right = jsonObject["right"]
+
+        return result
+    }
+}

package/www/capacitor/image_params/size.js

@@ -0,0 +1,9 @@
+export class Size {
+    width
+    height
+
+    constructor(width, height) {
+        this.width = width
+        this.height = height
+    }
+}

package/www/capacitor/image_quality/image_quality_characteristic.js

@@ -0,0 +1,24 @@
+export class ImageQualityCharacteristic {
+    characteristicName
+    recommendedRange
+    customRange
+    color
+
+    static _create(name, params) {
+        var result = new ImageQualityCharacteristic()
+        result.characteristicName = name
+        result.recommendedRange = params?.recommended
+        result.customRange = params?.custom
+        result.color = params?.color
+        return result
+    }
+
+    withCustomRange(min, max) {
+        this.customRange = new ImageQualityRange(min, max)
+        return this
+    }
+    withCustomValue(value) {
+        this.customRange = ImageQualityRange.withValue(value)
+        return this
+    }
+}

package/www/capacitor/image_quality/image_quality_characteristic_name.js

@@ -0,0 +1,58 @@
+export const ImageQualityCharacteristicName = {
+    IMAGE_WIDTH: "ImageWidth",
+    IMAGE_HEIGHT: "ImageHeight",
+    IMAGE_WIDTH_TO_HEIGHT: "ImageWidthToHeight",
+    IMAGE_CHANNELS_NUMBER: "ImageChannelsNumber",
+    ART_FACE: "ArtFace",
+    PADDING_RATIO: "PaddingRatio",
+    FACE_MID_POINT_HORIZONTAL_POSITION: "FaceMidPointHorizontalPosition",
+    FACE_MID_POINT_VERTICAL_POSITION: "FaceMidPointVerticalPosition",
+    HEAD_WIDTH_RATIO: "HeadWidthRatio",
+    HEAD_HEIGHT_RATIO: "HeadHeightRatio",
+    EYES_DISTANCE: "EyesDistance",
+    YAW: "Yaw",
+    PITCH: "Pitch",
+    ROLL: "Roll",
+    BLUR_LEVEL: "BlurLevel",
+    NOISE_LEVEL: "NoiseLevel",
+    UNNATURAL_SKIN_TONE: "UnnaturalSkinTone",
+    FACE_DYNAMIC_RANGE: "FaceDynamicRange",
+    EYE_RIGHT_CLOSED: "EyeRightClosed",
+    EYE_LEFT_CLOSED: "EyeLeftClosed",
+    EYE_RIGHT_OCCLUDED: "EyeRightOccluded",
+    EYE_LEFT_OCCLUDED: "EyeLeftOccluded",
+    EYES_RED: "EyesRed",
+    EYE_RIGHT_COVERED_WITH_HAIR: "EyeRightCoveredWithHair",
+    EYE_LEFT_COVERED_WITH_HAIR: "EyeLeftCoveredWithHair",
+    OFF_GAZE: "OffGaze",
+    TOO_DARK: "TooDark",
+    TOO_LIGHT: "TooLight",
+    FACE_GLARE: "FaceGlare",
+    SHADOWS_ON_FACE: "ShadowsOnFace",
+    SHOULDERS_POSE: "ShouldersPose",
+    EXPRESSION_LEVEL: "ExpressionLevel",
+    MOUTH_OPEN: "MouthOpen",
+    SMILE: "Smile",
+    DARK_GLASSES: "DarkGlasses",
+    REFLECTION_ON_GLASSES: "ReflectionOnGlasses",
+    FRAMES_TOO_HEAVY: "FramesTooHeavy",
+    FACE_OCCLUDED: "FaceOccluded",
+    HEAD_COVERING: "HeadCovering",
+    FOREHEAD_COVERING: "ForeheadCovering",
+    STRONG_MAKEUP: "StrongMakeup",
+    HEAD_PHONES: "Headphones",
+    MEDICAL_MASK: "MedicalMask",
+    BACKGROUND_UNIFORMITY: "BackgroundUniformity",
+    SHADOWS_ON_BACKGROUND: "ShadowsOnBackground",
+    OTHER_FACES: "OtherFaces",
+    BACKGROUND_COLOR_MATCH: "BackgroundColorMatch",
+    UNKNOWN: "Unknown",
+    IMAGE_CHARACTERISTIC_ALL_RECOMMENDED: "ImageCharacteristic",
+    HEAD_SIZE_AND_POSITION_ALL_RECOMMENDED: "HeadSizeAndPosition",
+    FACE_IMAGE_QUALITY_ALL_RECOMMENDED: "FaceImageQuality",
+    EYES_CHARACTERISTICS_ALL_RECOMMENDED: "EyesCharacteristics",
+    SHADOW_AND_LIGHTING_ALL_RECOMMENDED: "ShadowsAndLightning",
+    POSE_AND_EXPRESSION_ALL_RECOMMENDED: "PoseAndExpression",
+    HEAD_OCCLUSION_ALL_RECOMMENDED: "HeadOcclusion",
+    QUALITY_BACKGROUND_ALL_RECOMMENDED: "QualityBackground",
+}