@regulaforensics/face-sdk 6.3.3-beta

package/www/capacitor/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/capacitor/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/capacitor/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/capacitor/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/capacitor/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/capacitor/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,
+}

package/www/capacitor/init/license_exception.js

@@ -0,0 +1,29 @@
+export class LicenseException {
+    code
+    message
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+        const result = new LicenseException()
+
+        result.code = jsonObject["code"]
+        result.message = jsonObject["message"] ?? ""
+
+        return result
+    }
+}
+
+export const LicensingResultCode = {
+    OK: 0,
+    LICENSE_CORRUPTED: 1,
+    INVALID_DATE: 2,
+    INVALID_VERSION: 3,
+    INVALID_DEVICE_ID: 4,
+    INVALID_SYSTEM_OR_APP_ID: 5,
+    NO_CAPABILITIES: 6,
+    NO_AUTHENTICITY: 7,
+    LICENSE_ABSENT: 8,
+    NO_INTERNET: 9,
+    NO_DATABASE: 10,
+    DATABASE_INCORRECT: 11,
+}

package/www/capacitor/internal/bridge.js

@@ -0,0 +1,39 @@
+import { LivenessNotification } from '../liveness/liveness_notification'
+
+import { NativeModules, NativeEventEmitter } from './cordova'
+const { RNFaceSDK } = NativeModules
+var eventManager = new NativeEventEmitter(RNFaceSDK)
+
+export async function exec(name, params) {
+    return RNFaceSDK.exec(name, params)
+}
+
+function _setEvent(id, completion) {
+    eventManager.removeAllListeners(id)
+    if (completion != null)
+        eventManager.addListener(id, completion)
+}
+
+export function _setCustomButtonTappedCompletion(completion) {
+    _setEvent("onCustomButtonTappedEvent", completion)
+}
+
+export function _setVideoEncoderCompletion(completion) {
+    _setEvent("video_encoder_completion", (json) => {
+        var jsonObject = JSON.parse(json)
+        var transactionId = jsonObject["transactionId"]
+        var success = jsonObject["success"]
+        completion(transactionId, success)
+    })
+}
+
+export function _setLivenessNotificationCompletion(completion) {
+    _setEvent("livenessNotificationEvent", (json) => {
+        var livenessNotification = LivenessNotification.fromJson(JSON.parse(json))
+        completion(livenessNotification)
+    })
+}
+
+export function _setCameraSwitchCallback(completion) {
+    _setEvent("cameraSwitchEvent", completion)
+}

package/www/capacitor/internal/cordova.js

@@ -0,0 +1,17 @@
+var _exec = (completion, params) => cordova.exec(completion, null, "FaceSDK", "exec", params)
+
+export const NativeModules = {
+    RNFaceSDK: {
+        exec: async (name, params) => new Promise((resolve, _) => _exec(data => resolve(data), [name, ...params]))
+    }
+}
+
+export class NativeEventEmitter {
+    addListener(id, completion) {
+        _exec(completion, ["setEvent", id])
+    }
+
+    removeAllListeners(id) {
+        _exec(null, ["setEvent", id])
+    }
+}

package/www/capacitor/internal/webpack.config.js

@@ -0,0 +1,11 @@
+module.exports = {
+    entry: './src/index.js',
+    output: {
+        filename: 'index.js',
+        library: {
+            type: 'commonjs'
+        }
+    },
+    mode: 'development',
+    devtool: false
+};

package/www/capacitor/liveness/liveness_backend_exception.js

@@ -0,0 +1,38 @@
+export class LivenessBackendException {
+    code
+    message
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+        const result = new LivenessBackendException()
+
+        result.code = jsonObject["code"]
+        result.message = jsonObject["message"] ?? ""
+
+        return result
+    }
+}
+
+export const LivenessBackendErrorCode = {
+    UNDEFINED: -1,
+    NO_LICENSE: 200,
+    LOW_QUALITY: 231,
+    TRACK_BREAK: 246,
+    CLOSED_EYES_DETECTED: 230,
+    HIGH_ASYMMETRY: 232,
+    FACE_OVER_EMOTIONAL: 233,
+    SUNGLASSES_DETECTED: 234,
+    SMALL_AGE: 235,
+    HEADDRESS_DETECTED: 236,
+    MEDICINE_MASK_DETECTED: 239,
+    OCCLUSION_DETECTED: 240,
+    FOREHEAD_GLASSES_DETECTED: 242,
+    MOUTH_OPENED: 243,
+    ART_MASK_DETECTED: 244,
+    NOT_MATCHED: 237,
+    IMAGES_COUNT_LIMIT_EXCEEDED: 238,
+    ELECTRONIC_DEVICE_DETECTED: 245,
+    WRONG_GEO: 247,
+    WRONG_OF: 248,
+    WRONG_VIEW: 249,
+}

package/www/capacitor/liveness/liveness_config.js

@@ -0,0 +1,54 @@
+import { CameraPosition } from '../customization/camera_position'
+import { ScreenOrientation } from '../customization/screen_orientation'
+
+export class LivenessConfig {
+    copyright
+    cameraSwitchEnabled
+    closeButtonEnabled
+    torchButtonEnabled
+    vibrateOnSteps
+    cameraPositionIOS
+    screenOrientation
+    cameraPositionAndroid
+    locationTrackingEnabled
+    attemptsCount
+    recordingProcess
+    livenessType
+    tag
+    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.screenOrientation = params?.screenOrientation ?? [ScreenOrientation.PORTRAIT]
+        this.locationTrackingEnabled = params?.locationTrackingEnabled ?? true
+        this.attemptsCount = params?.attemptsCount ?? 0
+        this.recordingProcess = params?.recordingProcess ?? RecordingProcess.ASYNCHRONOUS_UPLOAD
+        this.livenessType = params?.livenessType ?? LivenessType.ACTIVE
+        this.skipStep = params?.skipStep ?? []
+        this.cameraPositionAndroid = params?.cameraPositionAndroid
+        this.tag = params?.tag
+        this.metadata = params?.metadata
+    }
+}
+
+export const RecordingProcess = {
+    ASYNCHRONOUS_UPLOAD: 0,
+    SYNCHRONOUS_UPLOAD: 1,
+    NOT_UPLOAD: 2,
+}
+
+export const LivenessType = {
+    ACTIVE: 0,
+    PASSIVE: 1,
+}
+
+export const LivenessSkipStep = {
+    ONBOARDING_STEP: 0,
+    SUCCESS_STEP: 1,
+}

package/www/capacitor/liveness/liveness_exception.js

@@ -0,0 +1,35 @@
+import { LivenessBackendException } from "./liveness_backend_exception"
+
+export class LivenessException {
+    code
+    message
+    underlyingError
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+        const result = new LivenessException()
+
+        result.code = jsonObject["code"]
+        result.message = jsonObject["message"] ?? ""
+        result.underlyingError = LivenessBackendException.fromJson(jsonObject["underlyingError"])
+
+        return result
+    }
+}
+
+export const LivenessErrorCode = {
+    NOT_INITIALIZED: 0,
+    NO_LICENSE: 1,
+    API_CALL_FAILED: 2,
+    SESSION_START_FAILED: 3,
+    CANCELLED: 4,
+    PROCESSING_TIMEOUT: 5,
+    PROCESSING_FAILED: 6,
+    PROCESSING_FRAME_FAILED: 7,
+    APPLICATION_INACTIVE: 8,
+    CONTEXT_IS_NULL: 9,
+    IN_PROGRESS_ALREADY: 10,
+    ZOOM_NOT_SUPPORTED: 11,
+    CAMERA_NO_PERMISSION: 12,
+    CAMERA_NOT_AVAILABLE: 13,
+}

package/www/capacitor/liveness/liveness_notification.js

@@ -0,0 +1,34 @@
+import { LivenessResponse } from './liveness_response'
+
+export class LivenessNotification {
+    status
+    response
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+        const result = new LivenessNotification()
+
+        result.status = jsonObject["status"]
+        result.response = LivenessResponse.fromJson(jsonObject["response"])
+
+        return result
+    }
+}
+
+export const LivenessProcessStatus = {
+    START: 0,
+    PREPARING: 1,
+    NEW_SESSION: 2,
+    NEXT_STAGE: 3,
+    SECTOR_CHANGED: 4,
+    PROGRESS: 5,
+    LOW_BRIGHTNESS: 6,
+    FIT_FACE: 7,
+    MOVE_AWAY: 8,
+    MOVE_CLOSER: 9,
+    TURN_HEAD: 10,
+    PROCESSING: 11,
+    FAILED: 12,
+    RETRY: 13,
+    SUCCESS: 14,
+}

package/www/capacitor/liveness/liveness_response.js

@@ -0,0 +1,30 @@
+
+import { LivenessException } from './liveness_exception'
+
+export class LivenessResponse {
+    image
+    liveness
+    tag
+    transactionId
+    estimatedAge
+    error
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+        const result = new LivenessResponse()
+
+        result.image = jsonObject["image"]
+        result.liveness = jsonObject["liveness"]
+        result.tag = jsonObject["tag"]
+        result.transactionId = jsonObject["transactionId"]
+        result.estimatedAge = jsonObject["estimatedAge"]
+        result.error = LivenessException.fromJson(jsonObject["error"])
+
+        return result
+    }
+}
+
+export const LivenessStatus = {
+    PASSED: 0,
+    UNKNOWN: 1,
+}

package/www/capacitor/match_faces/compared_face.js

@@ -0,0 +1,21 @@
+import { MatchFacesImage } from './match_faces_image'
+import { MatchFacesDetectionFace } from './match_faces_detection_face'
+
+export class ComparedFace {
+    imageIndex
+    image
+    faceIndex
+    face
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+        const result = new ComparedFace()
+
+        result.imageIndex = jsonObject["imageIndex"]
+        result.image = MatchFacesImage.fromJson(jsonObject["image"])
+        result.faceIndex = jsonObject["faceIndex"]
+        result.face = MatchFacesDetectionFace.fromJson(jsonObject["face"])
+
+        return result
+    }
+}