@regulaforensics/face-sdk 6.3.3-beta

package/www/react-native/image_quality/image_quality_group.js

@@ -0,0 +1,332 @@
+import { ImageQualityCharacteristic } from './image_quality_characteristic'
+import { ImageQualityRange } from './image_quality_range'
+
+export class _Image {
+    imageWidth(range) {
+        return ImageQualityCharacteristic._create(
+            ImageQualityCharacteristicName.IMAGE_WIDTH,
+            { recommended: range }
+        )
+    }
+
+    imageHeight(range) {
+        return ImageQualityCharacteristic._create(
+            ImageQualityCharacteristicName.IMAGE_HEIGHT,
+            { recommended: range }
+        )
+    }
+
+    imageWidthToHeight(range) {
+        return ImageQualityCharacteristic._create(
+            ImageQualityCharacteristicName.IMAGE_WIDTH_TO_HEIGHT,
+            { recommended: range }
+        )
+    }
+
+    imageChannelsNumber(channelsNumber) {
+        return ImageQualityCharacteristic._create(
+            ImageQualityCharacteristicName.IMAGE_CHANNELS_NUMBER,
+            { recommended: ImageQualityRange.withValue(channelsNumber) }
+        )
+    }
+
+    paddingRatio(range) {
+        return ImageQualityCharacteristic._create(
+            ImageQualityCharacteristicName.PADDING_RATIO,
+            { recommended: range }
+        )
+    }
+
+    artFace() {
+        return ImageQualityCharacteristic._create(
+            ImageQualityCharacteristicName.ART_FACE,
+        )
+    }
+
+    allRecommended() {
+        return [this.artFace()]
+    }
+}
+
+export class _HeadSizeAndPosition {
+    faceMidPointHorizontalPosition() {
+        return ImageQualityCharacteristic._create(ImageQualityCharacteristicName.FACE_MID_POINT_HORIZONTAL_POSITION)
+    }
+
+    faceMidPointVerticalPosition() {
+        return ImageQualityCharacteristic._create(ImageQualityCharacteristicName.FACE_MID_POINT_VERTICAL_POSITION)
+    }
+
+    headWidthRatio() {
+        return ImageQualityCharacteristic._create(ImageQualityCharacteristicName.HEAD_WIDTH_RATIO)
+    }
+
+    headHeightRatio() {
+        return ImageQualityCharacteristic._create(ImageQualityCharacteristicName.HEAD_HEIGHT_RATIO)
+    }
+
+    eyesDistance() {
+        return ImageQualityCharacteristic._create(ImageQualityCharacteristicName.EYES_DISTANCE)
+    }
+
+    yaw() {
+        return ImageQualityCharacteristic._create(ImageQualityCharacteristicName.YAW)
+    }
+
+    pitch() {
+        return ImageQualityCharacteristic._create(ImageQualityCharacteristicName.PITCH)
+    }
+
+    roll() {
+        return ImageQualityCharacteristic._create(ImageQualityCharacteristicName.ROLL)
+    }
+
+    allRecommended() {
+        return [
+            this.faceMidPointHorizontalPosition(),
+            this.faceMidPointVerticalPosition(),
+            this.headHeightRatio(),
+            this.headWidthRatio(),
+            this.eyesDistance(),
+            this.yaw(),
+            this.pitch(),
+            this.roll(),
+        ]
+    }
+}
+
+export class _FaceImage {
+    blurLevel() {
+        return ImageQualityCharacteristic._create(ImageQualityCharacteristicName.BLUR_LEVEL)
+    }
+
+    noiseLevel() {
+        return ImageQualityCharacteristic._create(ImageQualityCharacteristicName.NOISE_LEVEL)
+    }
+
+    unnaturalSkinTone() {
+        return ImageQualityCharacteristic._create(ImageQualityCharacteristicName.UNNATURAL_SKIN_TONE)
+    }
+
+    faceDynamicRange() {
+        return ImageQualityCharacteristic._create(ImageQualityCharacteristicName.FACE_DYNAMIC_RANGE)
+    }
+
+    allRecommended() {
+        return [
+            this.blurLevel(),
+            this.noiseLevel(),
+            this.unnaturalSkinTone(),
+            this.faceDynamicRange(),
+        ]
+    }
+}
+
+export class _Eyes {
+    eyeRightClosed() {
+        return ImageQualityCharacteristic._create(ImageQualityCharacteristicName.EYE_RIGHT_CLOSED)
+    }
+
+    eyeLeftClosed() {
+        return ImageQualityCharacteristic._create(ImageQualityCharacteristicName.EYE_LEFT_CLOSED)
+    }
+
+    eyeRightOccluded() {
+        return ImageQualityCharacteristic._create(ImageQualityCharacteristicName.EYE_RIGHT_OCCLUDED)
+    }
+
+    eyeLeftOccluded() {
+        return ImageQualityCharacteristic._create(ImageQualityCharacteristicName.EYE_LEFT_OCCLUDED)
+    }
+
+    eyesRed() {
+        return ImageQualityCharacteristic._create(ImageQualityCharacteristicName.EYES_RED)
+    }
+
+    eyeRightCoveredWithHair() {
+        return ImageQualityCharacteristic._create(ImageQualityCharacteristicName.EYE_RIGHT_COVERED_WITH_HAIR)
+    }
+
+    eyeLeftCoveredWithHair() {
+        return ImageQualityCharacteristic._create(ImageQualityCharacteristicName.EYE_LEFT_COVERED_WITH_HAIR)
+    }
+
+    offGaze() {
+        return ImageQualityCharacteristic._create(ImageQualityCharacteristicName.OFF_GAZE)
+    }
+
+    allRecommended() {
+        return [
+            this.eyeRightClosed(),
+            this.eyeLeftClosed(),
+            this.eyeRightOccluded(),
+            this.eyeLeftOccluded(),
+            this.eyesRed(),
+            this.eyeRightCoveredWithHair(),
+            this.eyeLeftCoveredWithHair(),
+            this.offGaze(),
+        ]
+    }
+}
+
+export class _ShadowsAndLightning {
+    tooDark() {
+        return ImageQualityCharacteristic._create(ImageQualityCharacteristicName.TOO_DARK)
+    }
+
+    tooLight() {
+        return ImageQualityCharacteristic._create(ImageQualityCharacteristicName.TOO_LIGHT)
+    }
+
+    faceGlare() {
+        return ImageQualityCharacteristic._create(ImageQualityCharacteristicName.FACE_GLARE)
+    }
+
+    shadowsOnFace() {
+        return ImageQualityCharacteristic._create(ImageQualityCharacteristicName.SHADOWS_ON_FACE)
+    }
+
+    allRecommended() {
+        return [
+            this.tooDark(),
+            this.tooLight(),
+            this.faceGlare(),
+            this.shadowsOnFace(),
+        ]
+    }
+}
+
+export class _PoseAndExpression {
+    shouldersPose() {
+        return ImageQualityCharacteristic._create(ImageQualityCharacteristicName.SHOULDERS_POSE)
+    }
+
+    expressionLevel() {
+        return ImageQualityCharacteristic._create(ImageQualityCharacteristicName.EXPRESSION_LEVEL)
+    }
+
+    mouthOpen() {
+        return ImageQualityCharacteristic._create(ImageQualityCharacteristicName.MOUTH_OPEN)
+    }
+
+    smile() {
+        return ImageQualityCharacteristic._create(ImageQualityCharacteristicName.SMILE)
+    }
+
+    allRecommended() {
+        return [
+            this.shouldersPose(),
+            this.expressionLevel(),
+            this.mouthOpen(),
+            this.smile(),
+        ]
+    }
+}
+
+export class _HeadOcclusion {
+    darkGlasses() {
+        return ImageQualityCharacteristic._create(ImageQualityCharacteristicName.DARK_GLASSES)
+    }
+
+    reflectionOnGlasses() {
+        return ImageQualityCharacteristic._create(ImageQualityCharacteristicName.REFLECTION_ON_GLASSES)
+    }
+
+    framesTooHeavy() {
+        return ImageQualityCharacteristic._create(ImageQualityCharacteristicName.FRAMES_TOO_HEAVY)
+    }
+
+    faceOccluded() {
+        return ImageQualityCharacteristic._create(ImageQualityCharacteristicName.FACE_OCCLUDED)
+    }
+
+    headCovering() {
+        return ImageQualityCharacteristic._create(ImageQualityCharacteristicName.HEAD_COVERING)
+    }
+
+    foreheadCovering() {
+        return ImageQualityCharacteristic._create(ImageQualityCharacteristicName.FOREHEAD_COVERING)
+    }
+
+    strongMakeup() {
+        return ImageQualityCharacteristic._create(ImageQualityCharacteristicName.STRONG_MAKEUP)
+    }
+
+    headphones() {
+        return ImageQualityCharacteristic._create(ImageQualityCharacteristicName.HEAD_PHONES)
+    }
+
+    medicalMask() {
+        return ImageQualityCharacteristic._create(ImageQualityCharacteristicName.MEDICAL_MASK)
+    }
+
+    allRecommended() {
+        return [
+            this.darkGlasses(),
+            this.reflectionOnGlasses(),
+            this.framesTooHeavy(),
+            this.faceOccluded(),
+            this.headCovering(),
+            this.foreheadCovering(),
+            this.strongMakeup(),
+            this.headphones(),
+            this.medicalMask(),
+        ]
+    }
+}
+
+export class _Background {
+    backgroundUniformity() {
+        return ImageQualityCharacteristic._create(ImageQualityCharacteristicName.BACKGROUND_UNIFORMITY)
+    }
+
+    shadowsOnBackground() {
+        return ImageQualityCharacteristic._create(ImageQualityCharacteristicName.SHADOWS_ON_BACKGROUND)
+    }
+
+    otherFaces() {
+        return ImageQualityCharacteristic._create(ImageQualityCharacteristicName.OTHER_FACES)
+    }
+
+    backgroundColorMatch(params) {
+        return ImageQualityCharacteristic._create(
+            ImageQualityCharacteristicName.BACKGROUND_COLOR_MATCH,
+            { color: params?.color }
+        )
+    }
+
+    allRecommended() {
+        return [
+            this.backgroundUniformity(),
+            this.shadowsOnBackground(),
+            this.otherFaces(),
+            this.backgroundColorMatch(),
+        ]
+    }
+}
+
+export class ImageQualityGroup {
+    static get image() { return ImageQualityGroup._image }
+    static _image = new _Image()
+
+    static get headSizeAndPosition() { return ImageQualityGroup._headSizeAndPosition }
+    static _headSizeAndPosition = new _HeadSizeAndPosition()
+
+    static get faceImage() { return ImageQualityGroup._faceImage }
+    static _faceImage = new _FaceImage()
+
+    static get eyes() { return ImageQualityGroup._eyes }
+    static _eyes = new _Eyes()
+
+    static get shadowsAndLightning() { return ImageQualityGroup._shadowsAndLightning }
+    static _shadowsAndLightning = new _ShadowsAndLightning()
+
+    static get poseAndExpression() { return ImageQualityGroup._poseAndExpression }
+    static _poseAndExpression = new _PoseAndExpression()
+
+    static get headOcclusion() { return ImageQualityGroup._headOcclusion }
+    static _headOcclusion = new _HeadOcclusion()
+
+    static get background() { return ImageQualityGroup._background }
+    static _background = new _Background()
+}

package/www/react-native/image_quality/image_quality_range.js

@@ -0,0 +1,26 @@
+export class ImageQualityRange {
+    min
+    max
+
+    constructor(min, max) {
+        this.min = min
+        this.max = max
+    }
+
+    static withValue(value) {
+        var result = new ImageQualityRange()
+        result.min = value
+        result.max = value
+        return result
+    }
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+        const result = new ImageQualityRange()
+
+        result.min = jsonObject["min"]
+        result.max = jsonObject["max"]
+
+        return result
+    }
+}

package/www/react-native/image_quality/image_quality_result.js

@@ -0,0 +1,40 @@
+import { ImageQualityRange } from './image_quality_range'
+
+export class ImageQualityResult {
+    group
+    name
+    status
+    value
+    range
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+        const result = new ImageQualityResult()
+
+        result.name = jsonObject["name"]
+        result.group = jsonObject["group"]
+        result.status = jsonObject["status"]
+        result.range = ImageQualityRange.fromJson(jsonObject["range"])
+        result.value = jsonObject["value"]
+
+        return result
+    }
+}
+
+export const ImageQualityGroupName = {
+    IMAGE_CHARACTERISTICS: 1,
+    HEAD_SIZE_AND_POSITION: 2,
+    FACE_QUALITY: 3,
+    EYES_CHARACTERISTICS: 4,
+    SHADOWS_AND_LIGHTNING: 5,
+    POSE_AND_EXPRESSION: 6,
+    HEAD_OCCLUSION: 7,
+    BACKGROUND: 8,
+    UNKNOWN: 9,
+}
+
+export const ImageQualityResultStatus = {
+    FALSE: 0,
+    TRUE: 1,
+    UNDETERMINED: 2,
+}

package/www/react-native/index.js

@@ -0,0 +1,219 @@
+import { exec, _setVideoEncoderCompletion, _setLivenessNotificationCompletion, _setCameraSwitchCallback } from './internal/bridge'
+
+import { CameraPosition } from './customization/camera_position'
+import { CustomizationColors } from './customization/customization_colors'
+import { CustomizationFonts } from './customization/customization_fonts'
+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'
+import { InitConfig } from './init/init_config'
+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'
+import { DetectFacesAttributeResult } from './detect_faces/detect_faces_attribute_result'
+import { DetectFacesAttribute } from './detect_faces/detect_faces_attribute'
+import { DetectFacesBackendException, DetectFacesBackendErrorCode } from './detect_faces/detect_faces_backend_exception'
+import { DetectFacesConfig } from './detect_faces/detect_faces_config'
+import { DetectFacesException, DetectFacesErrorCode } from './detect_faces/detect_faces_exception'
+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'
+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'
+import { ImageQualityCharacteristic } from './image_quality/image_quality_characteristic'
+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 { 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 { ComparedFace } from './match_faces/compared_face'
+import { ComparedFacesPair } from './match_faces/compared_faces_pair'
+import { ComparedFacesSplit } from './match_faces/compared_faces_split'
+import { MatchFacesBackendException } from './match_faces/match_faces_backend_exception'
+import { MatchFacesConfig, ProcessingMode } from './match_faces/match_faces_config'
+import { MatchFacesDetectionFace } from './match_faces/match_faces_detection_face'
+import { MatchFacesDetection } from './match_faces/match_faces_detection'
+import { MatchFacesException, MatchFacesErrorCode } from './match_faces/match_faces_exception'
+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'
+import { ImageUpload } from './person_database/image_upload'
+import { PageableItemList } from './person_database/pageable_item_list'
+import { PersonDatabase } from './person_database/person_database'
+import { PersonGroup } from './person_database/person_group'
+import { PersonImage } from './person_database/person_image'
+import { Person } from './person_database/person'
+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 }
+
+
+export class FaceSDK {
+    static get instance() { return FaceSDK._instance }
+    static _instance = new FaceSDK()
+
+    get version() { return this._version }
+    _version
+
+    get serviceUrl() { return this._serviceUrl }
+    _serviceUrl
+    set serviceUrl(val) {
+        this._serviceUrl = val
+        this._setServiceUrl(val)
+    }
+
+    get localizationDictionary() { return this._localizationDictionary }
+    _localizationDictionary
+    set localizationDictionary(val) {
+        var temp = Object.assign({}, val);
+        Object.freeze(temp);
+        this._localizationDictionary = temp
+        this._setLocalizationDictionary(val)
+    }
+
+    get requestHeaders() { return this._requestHeaders }
+    _requestHeaders
+    set requestHeaders(val) {
+        var temp = Object.assign({}, val);
+        Object.freeze(temp);
+        this._requestHeaders = temp
+        this._setRequestHeaders(val)
+    }
+
+    get customization() { return this._customization }
+    _customization = new Customization()
+    set customization(val) {
+        this._customization = val
+        this._customization._apply()
+    }
+
+    set videoEncoderCompletion(completion) {
+        _setVideoEncoderCompletion(completion)
+    }
+
+    get personDatabase() { return this._personDatabase }
+    _personDatabase = new PersonDatabase()
+
+    async isInitialized() {
+        return await exec("isInitialized", [])
+    }
+
+    async initialize(params) {
+        var response = await exec("initialize", [params?.config])
+        await this._onInit()
+
+        var jsonObject = JSON.parse(response)
+        var success = jsonObject["success"]
+        var error = jsonObject["error"]
+        return [success, InitException.fromJson(error)]
+    }
+
+    deinitialize() {
+        exec("deinitialize", [])
+    }
+
+    async startFaceCapture(params) {
+        _setCameraSwitchCallback(params?.cameraSwitchCallback)
+        var response = await exec("startFaceCapture", [params?.config])
+        return FaceCaptureResponse.fromJson(JSON.parse(response))
+    }
+
+    stopFaceCapture() {
+        exec("stopFaceCapture", [])
+    }
+
+    async startLiveness(params) {
+        _setCameraSwitchCallback(params?.cameraSwitchCallback)
+        _setLivenessNotificationCompletion(params?.notificationCompletion)
+        var response = await exec("startLiveness", [params?.config])
+        return LivenessResponse.fromJson(JSON.parse(response))
+    }
+
+    stopLiveness() {
+        exec("stopLiveness", [])
+    }
+
+    async matchFaces(request, params) {
+        var response = await exec("matchFaces", [request, params?.config])
+        return MatchFacesResponse.fromJson(JSON.parse(response))
+    }
+
+    async splitComparedFaces(facesPairs, similarityThreshold) {
+        var response = await exec("splitComparedFaces", [facesPairs, similarityThreshold])
+        return ComparedFacesSplit.fromJson(JSON.parse(response))
+    }
+
+    async detectFaces(request) {
+        var response = await exec("detectFaces", [request])
+        return DetectFacesResponse.fromJson(JSON.parse(response))
+    }
+
+    async _onInit() {
+        this._version = await this._getVersion()
+        this._serviceUrl = await this._getServiceUrl()
+    }
+
+    async _getVersion() {
+        var response = await exec("getVersion", [])
+        return FaceSDKVersion.fromJson(JSON.parse(response))
+    }
+
+    async _getServiceUrl() {
+        return await exec("getServiceUrl", [])
+    }
+
+    _setServiceUrl(url) {
+        exec("setServiceUrl", [url])
+    }
+
+    _setLocalizationDictionary(dictionary) {
+        exec("setLocalizationDictionary", [dictionary])
+    }
+
+    _setRequestHeaders(dictionary) {
+        exec("setRequestHeaders", [dictionary])
+    }
+}

package/www/react-native/init/face_sdk_version.js

@@ -0,0 +1,16 @@
+export class FaceSDKVersion {
+    api
+    core
+    coreMode
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+        const result = new FaceSDKVersion()
+
+        result.api = jsonObject["api"]
+        result.core = jsonObject["core"]
+        result.coreMode = jsonObject["coreMode"]
+
+        return result
+    }
+}

package/www/react-native/init/init_config.js

@@ -0,0 +1,9 @@
+export class InitConfig {
+    license
+    licenseUpdate
+
+    constructor(license, params) {
+        this.license = license
+        this.licenseUpdate = params?.licenseUpdate
+    }
+}

package/www/react-native/init/init_exception.js

@@ -0,0 +1,29 @@
+import { LicenseException } from "./license_exception"
+
+export class InitException {
+    code
+    message
+    underlyingError
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+        const result = new InitException()
+
+        result.code = jsonObject["code"]
+        result.message = jsonObject["message"] ?? ""
+        result.underlyingError = LicenseException.fromJson(jsonObject["underlyingError"])
+
+        return result
+    }
+}
+
+export const InitErrorCode = {
+    IN_PROGRESS_ALREADY: 0,
+    MISSING_CORE: 1,
+    INTERNAL_CORE_ERROR: 2,
+    BAD_LICENSE: 3,
+    UNAVAILABLE: 4,
+    CONTEXT_IS_NULL: 100,
+    RESOURCE_DAT_ABSENT: 101,
+    LICENSE_IS_NULL: 102,
+}