@regulaforensics/face-sdk 6.3.3-beta

package/README.md

@@ -0,0 +1,23 @@
+# Regula Face SDK plugin
+Face SDK is a framework that is used for face matching, recognition and liveness detection.
+This plugin makes possible to use it with react-native, cordova and ionic applications.
+
+# Contents
+* [Demo applications](#demo-applications)
+* [Documentation](#documentation)
+* [Additional information](#additional-information)
+
+## Demo applications
+In the [examples](examples/) folder you can find demo 4 applications:
+* [React-native](examples/react-native)
+* [Cordova](examples/cordova)
+* [Ionic(ionic app with cordova, typescript)](examples/ionic)
+* [Capacitor(ionic app with capacitor, react)](examples/capacitor)
+
+Each demo app has its own readme file with instructions on building and installation.
+
+## Documentation
+You can find documentation on API [here](https://docs.regulaforensics.com/develop/face-sdk/mobile).
+
+## Additional information
+If you have any technical questions, feel free to [contact](mailto:support@regulaforensics.com) us or create issues [here](https://github.com/regulaforensics/cordova-plugin-face-api/issues).

package/RNFaceSDK.podspec

@@ -0,0 +1,21 @@
+require 'json'
+
+package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
+source = File.join(__dir__, 'ios')
+
+Pod::Spec.new do |s|
+  s.name         = 'RNFaceSDK'
+  s.version      = package['version']
+  s.summary      = package['description']
+  s.license      = package['license']
+
+  s.authors      = { 'RegulaForensics' => 'support@regulaforensics.com' }
+  s.homepage     = 'https://regulaforensics.com'
+
+  s.source       = { http: "file:#{source}" }
+  s.ios.deployment_target = '11.0'
+  s.source_files = 'ios/**/*.{h,m}'
+  s.exclude_files = [ 'ios/CVDFaceSDK.h', 'ios/CVDFaceSDK.m' ]
+  s.dependency 'FaceSDK', '6.2.2024'
+  s.dependency 'React'
+end

package/android/CVDFaceSDK.kt

@@ -0,0 +1,34 @@
+package com.regula.plugin.facesdk
+
+import org.apache.cordova.CallbackContext
+import org.apache.cordova.CordovaPlugin
+import org.apache.cordova.CordovaWebView
+import org.apache.cordova.PluginResult
+import org.json.JSONArray
+
+lateinit var args: JSONArray
+lateinit var eventSender: CordovaWebView
+val eventCallbackIds = mutableMapOf<String, String>()
+
+fun sendEvent(callbackId: String, data: Any? = "") {
+    val pluginResult = PluginResult(PluginResult.Status.OK, data.toSendable() as String?)
+    pluginResult.keepCallback = true
+    eventSender.sendPluginResult(pluginResult, eventCallbackIds[callbackId] ?: callbackId)
+}
+
+@Suppress("UNCHECKED_CAST")
+fun <T> argsNullable(index: Int): T? = if (args.get(index).toString() != "null") {
+    args.get(index) as T
+} else null
+
+class CVDFaceSDK : CordovaPlugin() {
+    override fun execute(action: String, arguments: JSONArray, callbackContext: CallbackContext): Boolean {
+        activity = cordova.activity
+        eventSender = webView
+        args = arguments
+        val method = args.remove(0) as String
+        if (method == "setEvent") eventCallbackIds[args(0)] = callbackContext.callbackId
+        methodCall(method) { data: Any? -> sendEvent(callbackContext.callbackId, data) }
+        return true
+    }
+}

package/android/build.gradle

@@ -0,0 +1,48 @@
+buildscript {
+    repositories {
+        google()
+        mavenCentral()
+    }
+
+    dependencies {
+        classpath "com.android.tools.build:gradle:8.1.4"
+        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.23"
+    }
+}
+
+apply plugin: 'com.android.library'
+apply plugin: 'kotlin-android'
+
+android {
+    // Conditional for compatibility with AGP <4.2.
+    if (project.android.hasProperty("namespace")) {
+        namespace 'com.regula.plugin.facesdk'
+    }
+
+    compileSdk 34
+
+    defaultConfig {
+        minSdkVersion 21
+        targetSdk 34
+        versionCode 1
+        versionName "1.0"
+    }
+}
+
+rootProject.allprojects {
+    repositories {
+        maven {
+            url "https://maven.regulaforensics.com/RegulaDocumentReader"
+        }
+    }
+}
+
+dependencies {
+    //noinspection GradleDynamicVersion
+    implementation 'com.facebook.react:react-native:+'
+    //noinspection GradleDependency
+    implementation('com.regula.face:api:6.2.3281'){
+        transitive = true
+    }
+}
+  

package/android/cordova.gradle

@@ -0,0 +1,18 @@
+android {
+    aaptOptions {
+        noCompress "Regula/faceSdkResource.dat"
+    }
+}
+
+repositories {
+    maven {
+        url "https://maven.regulaforensics.com/RegulaDocumentReader"
+    }
+}
+
+dependencies {
+    //noinspection GradleDependency
+    implementation('com.regula.face:api:6.2.3281'){
+        transitive = true
+    }
+}

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1 @@
+<manifest package="com.regula.plugin.facesdk" />

package/android/src/main/java/com/regula/plugin/facesdk/Config.kt

@@ -0,0 +1,165 @@
+package com.regula.plugin.facesdk
+
+import com.regula.facesdk.configuration.Customization
+import com.regula.facesdk.configuration.FaceCaptureConfiguration
+import com.regula.facesdk.configuration.LivenessConfiguration
+import com.regula.facesdk.configuration.MatchFacesConfiguration
+import com.regula.facesdk.detection.request.ImageQualityCharacteristic
+import com.regula.facesdk.detection.request.ImageQualityGroup
+import com.regula.facesdk.detection.request.ImageQualityRange
+import com.regula.facesdk.enums.LivenessType
+import com.regula.facesdk.enums.ProcessingMode
+import com.regula.facesdk.enums.RecordingProcess
+import org.json.JSONArray
+import org.json.JSONObject
+
+fun setFaceCaptureConfig(builder: FaceCaptureConfiguration.Builder, config: JSONObject) = config.forEach { k, v ->
+    when (k) {
+        "copyright" -> builder.setCopyright(v as Boolean)
+        "cameraSwitchEnabled" -> builder.setCameraSwitchEnabled(v as Boolean)
+        "closeButtonEnabled" -> builder.setCloseButtonEnabled(v as Boolean)
+        "torchButtonEnabled" -> builder.setTorchButtonEnabled(v as Boolean)
+        "vibrateOnSteps" -> builder.setVibrateOnStep(v as Boolean)
+        "cameraPositionAndroid" -> builder.setCameraId(v.toInt())
+        "screenOrientation" -> builder.setScreenOrientation(*screenOrientationArrayFromJSON(v as JSONArray))
+        "timeout" -> builder.setTimeout(v.toFloat())
+        "holdStillDuration" -> builder.setHoldStillDuration(v.toFloat())
+    }
+}
+
+fun getFaceCaptureConfig(input: FaceCaptureConfiguration) = mapOf(
+    "copyright" to input.hasCopyright(),
+    "cameraSwitchEnabled" to input.isCameraSwitchEnabled,
+    "closeButtonEnabled" to input.isCloseButtonEnabled,
+    "torchButtonEnabled" to input.isTorchButtonEnabled,
+    "vibrateOnSteps" to input.isVibrateOnSteps,
+    "cameraPositionAndroid" to input.cameraId,
+    "screenOrientation" to generateScreenOrientationArray(input.screenOrientation),
+    "timeout" to input.timeout,
+    "holdStillDuration" to input.holdStillDuration,
+).toJson()
+
+fun setLivenessConfig(builder: LivenessConfiguration.Builder, config: JSONObject) = config.forEach { k, v ->
+    when (k) {
+        "copyright" -> builder.setCopyright(v as Boolean)
+        "cameraSwitchEnabled" -> builder.setCameraSwitchEnabled(v as Boolean)
+        "closeButtonEnabled" -> builder.setCloseButtonEnabled(v as Boolean)
+        "torchButtonEnabled" -> builder.setTorchButtonEnabled(v as Boolean)
+        "vibrateOnSteps" -> builder.setVibrateOnStep(v as Boolean)
+        "cameraPositionAndroid" -> builder.setCameraId(v.toInt())
+        "screenOrientation" -> builder.setScreenOrientation(*screenOrientationArrayFromJSON(v as JSONArray))
+        "locationTrackingEnabled" -> builder.setLocationTrackingEnabled(v as Boolean)
+        "attemptsCount" -> builder.setAttemptsCount(v.toInt())
+        "recordingProcess" -> builder.setRecordingProcess(RecordingProcess.values()[v.toInt()])
+        "livenessType" -> builder.setType(LivenessType.values()[v.toInt()])
+        "tag" -> builder.setTag(v as String)
+        "skipStep" -> builder.setSkipStep(*livenessSkipStepArrayFromJSON(v as JSONArray))
+        "metadata" -> builder.setMetadata(v as JSONObject)
+    }
+}
+
+fun getLivenessConfig(input: LivenessConfiguration) = mapOf(
+    "copyright" to input.hasCopyright(),
+    "cameraSwitchEnabled" to input.isCameraSwitchEnabled,
+    "closeButtonEnabled" to input.isCloseButtonEnabled,
+    "torchButtonEnabled" to input.isTorchButtonEnabled,
+    "vibrateOnSteps" to input.isVibrateOnSteps,
+    "cameraPositionAndroid" to input.cameraId,
+    "screenOrientation" to generateScreenOrientationArray(input.screenOrientation),
+    "locationTrackingEnabled" to input.isLocationTrackingEnabled,
+    "attemptsCount" to input.attemptsCount,
+    "recordingProcess" to input.recordingProcess.ordinal,
+    "livenessType" to input.type.ordinal,
+    "tag" to input.tag,
+    "skipStep" to generateLivenessSkipStepArray(input.skipStep),
+    "metadata" to input.metadata,
+).toJson()
+
+fun setMatchFacesConfig(builder: MatchFacesConfiguration.Builder, config: JSONObject) = config.forEach { k, v ->
+    when (k) {
+        "processingMode" -> builder.setProcessingMode(ProcessingMode.values()[v.toInt()])
+    }
+}
+
+fun getMatchFacesConfig(input: MatchFacesConfiguration) = mapOf(
+    "processingMode" to input.processingMode.ordinal
+).toJson()
+
+fun setCustomization(input: Customization, config: JSONObject) = config.forEach { key, value ->
+    when (key) {
+        "colors" -> (value as JSONObject).forEach { k, v -> k.setColor(input, v) }
+        "fonts" -> (value as JSONObject).forEach { k, v -> k.setFont(input, v) }
+        "images" -> (value as JSONObject).forEach { k, v -> k.setImage(input, v) }
+        "uiCustomizationLayer" -> input.setUiCustomizationLayer(value as JSONObject)
+    }
+}
+
+fun getImageQualityCharacteristic(
+    name: String,
+    recommendedRange: ImageQualityRange?,
+    customRange: ImageQualityRange?,
+    color: Long?
+): ImageQualityCharacteristic {
+    val min = recommendedRange?.min ?: 0.0
+    val max = recommendedRange?.max ?: 0.0
+    val result = when (name) {
+        "ImageWidth" -> ImageQualityGroup.ImageCharacteristic.imageWidthWithRange(min, max)
+        "ImageHeight" -> ImageQualityGroup.ImageCharacteristic.imageHeightWithRange(min, max)
+        "ImageWidthToHeight" -> ImageQualityGroup.ImageCharacteristic.imageWidthToHeightWithRange(min, max)
+        "ImageChannelsNumber" -> ImageQualityGroup.ImageCharacteristic.imageChannelsNumberWithValue(min)
+        "PaddingRatio" -> ImageQualityGroup.ImageCharacteristic.paddingRatio(min, max)
+        "ArtFace" -> ImageQualityGroup.ImageCharacteristic.artFace()
+
+        "FaceMidPointHorizontalPosition" -> ImageQualityGroup.HeadSizeAndPosition.faceMidPointHorizontalPosition()
+        "FaceMidPointVerticalPosition" -> ImageQualityGroup.HeadSizeAndPosition.faceMidPointVerticalPosition()
+        "HeadWidthRatio" -> ImageQualityGroup.HeadSizeAndPosition.headWidthRatio()
+        "HeadHeightRatio" -> ImageQualityGroup.HeadSizeAndPosition.headHeightRatio()
+        "EyesDistance" -> ImageQualityGroup.HeadSizeAndPosition.eyesDistance()
+        "Yaw" -> ImageQualityGroup.HeadSizeAndPosition.yaw()
+        "Pitch" -> ImageQualityGroup.HeadSizeAndPosition.pitch()
+        "Roll" -> ImageQualityGroup.HeadSizeAndPosition.roll()
+
+        "BlurLevel" -> ImageQualityGroup.FaceImageQuality.blurLevel()
+        "NoiseLevel" -> ImageQualityGroup.FaceImageQuality.noiseLevel()
+        "UnnaturalSkinTone" -> ImageQualityGroup.FaceImageQuality.unnaturalSkinTone()
+        "FaceDynamicRange" -> ImageQualityGroup.FaceImageQuality.faceDynamicRange()
+
+        "EyeRightClosed" -> ImageQualityGroup.EyesCharacteristics.eyeRightClosed()
+        "EyeLeftClosed" -> ImageQualityGroup.EyesCharacteristics.eyeLeftClosed()
+        "EyeRightOccluded" -> ImageQualityGroup.EyesCharacteristics.eyeRightOccluded()
+        "EyeLeftOccluded" -> ImageQualityGroup.EyesCharacteristics.eyeLeftOccluded()
+        "EyesRed" -> ImageQualityGroup.EyesCharacteristics.eyesRed()
+        "EyeRightCoveredWithHair" -> ImageQualityGroup.EyesCharacteristics.eyeRightCoveredWithHair()
+        "EyeLeftCoveredWithHair" -> ImageQualityGroup.EyesCharacteristics.eyeLeftCoveredWithHair()
+        "OffGaze" -> ImageQualityGroup.EyesCharacteristics.offGaze()
+
+        "TooDark" -> ImageQualityGroup.ShadowsAndLightning.tooDark()
+        "TooLight" -> ImageQualityGroup.ShadowsAndLightning.tooLight()
+        "FaceGlare" -> ImageQualityGroup.ShadowsAndLightning.faceGlare()
+        "ShadowsOnFace" -> ImageQualityGroup.ShadowsAndLightning.shadowsOnFace()
+
+        "ShouldersPose" -> ImageQualityGroup.PoseAndExpression.shouldersPose()
+        "ExpressionLevel" -> ImageQualityGroup.PoseAndExpression.expressionLevel()
+        "MouthOpen" -> ImageQualityGroup.PoseAndExpression.mouthOpen()
+        "Smile" -> ImageQualityGroup.PoseAndExpression.smile()
+
+        "DarkGlasses" -> ImageQualityGroup.HeadOcclusion.darkGlasses()
+        "ReflectionOnGlasses" -> ImageQualityGroup.HeadOcclusion.reflectionOnGlasses()
+        "FramesTooHeavy" -> ImageQualityGroup.HeadOcclusion.framesTooHeavy()
+        "FaceOccluded" -> ImageQualityGroup.HeadOcclusion.faceOccluded()
+        "HeadCovering" -> ImageQualityGroup.HeadOcclusion.headCovering()
+        "ForeheadCovering" -> ImageQualityGroup.HeadOcclusion.foreheadCovering()
+        "StrongMakeup" -> ImageQualityGroup.HeadOcclusion.strongMakeup()
+        "Headphones" -> ImageQualityGroup.HeadOcclusion.headphones()
+        "MedicalMask" -> ImageQualityGroup.HeadOcclusion.medicalMask()
+
+        "BackgroundUniformity" -> ImageQualityGroup.QualityBackground.backgroundUniformity()
+        "ShadowsOnBackground" -> ImageQualityGroup.QualityBackground.shadowsOnBackground()
+        "OtherFaces" -> ImageQualityGroup.QualityBackground.otherFaces()
+        "BackgroundColorMatch" -> color?.let { ImageQualityGroup.QualityBackground.backgroundColorMatchWithColor(it) }
+            ?: ImageQualityGroup.QualityBackground.backgroundColorMatch()
+
+        else -> throw Exception("ImageQualityCharacteristicName not found")
+    }
+    return customRange?.let { result.withCustomRange(it.min, it.max) } ?: result
+}