@regulaforensics/face-sdk 6.3.3-beta

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

@@ -0,0 +1,145 @@
+import { exec } from '../internal/bridge'
+import { Person } from './person'
+import { PersonImage } from './person_image'
+import { PageableItemList } from './pageable_item_list'
+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])
+        return this._itemResponseFromJson(response, Person.fromJson)
+    }
+
+    async updatePerson(person) {
+        var response = await exec("updatePerson", [person])
+        return this._successResponseFromJson(response)
+    }
+
+    async deletePerson(personId) {
+        var response = await exec("deletePerson", [personId])
+        return this._successResponseFromJson(response)
+    }
+
+    async getPerson(personId) {
+        var response = await exec("getPerson", [personId])
+        return this._itemResponseFromJson(response, Person.fromJson)
+    }
+
+    async addPersonImage(personId, image) {
+        var response = await exec("addPersonImage", [personId, image])
+        return this._itemResponseFromJson(response, PersonImage.fromJson)
+    }
+
+    async deletePersonImage(personId, imageId) {
+        var response = await exec("deletePersonImage", [personId, imageId])
+        return this._successResponseFromJson(response)
+    }
+
+    async getPersonImage(personId, imageId) {
+        var response = await exec("getPersonImage", [personId, imageId])
+        return this._itemResponseFromJson(response, PersonImage.fromJson)
+    }
+
+    async getPersonImages(personId) {
+        var response = await exec("getPersonImages", [personId])
+        return this._listResponseFromJson(response, PersonImage.fromJson)
+    }
+
+    async getPersonImagesForPage(personId, page, size) {
+        var response = await exec("getPersonImagesForPage", [personId, page, size])
+        return this._listResponseFromJson(response, PersonImage.fromJson)
+    }
+
+    async createGroup(name, params) {
+        var response = await exec("createGroup", [name, params?.metadata])
+        return this._itemResponseFromJson(response, PersonGroup.fromJson)
+    }
+
+    async updateGroup(group) {
+        var response = await exec("updateGroup", [group])
+        return this._successResponseFromJson(response)
+    }
+
+    async editPersonsInGroup(groupId, request) {
+        var response = await exec("editPersonsInGroup", [groupId, request])
+        return this._successResponseFromJson(response)
+    }
+
+    async deleteGroup(groupId) {
+        var response = await exec("deleteGroup", [groupId])
+        return this._successResponseFromJson(response)
+    }
+
+    async getGroup(groupId) {
+        var response = await exec("getGroup", [groupId])
+        return this._itemResponseFromJson(response, PersonGroup.fromJson)
+    }
+
+    async getGroups() {
+        var response = await exec("getGroups", [])
+        return this._listResponseFromJson(response, PersonGroup.fromJson)
+    }
+
+    async getGroupsForPage(page, size) {
+        var response = await exec("getGroupsForPage", [page, size])
+        return this._listResponseFromJson(response, PersonGroup.fromJson)
+    }
+
+    async getPersonGroups(personId) {
+        var response = await exec("getPersonGroups", [personId])
+        return this._listResponseFromJson(response, PersonGroup.fromJson)
+    }
+
+    async getPersonGroupsForPage(personId, page, size) {
+        var response = await exec("getPersonGroupsForPage", [personId, page, size])
+        return this._listResponseFromJson(response, PersonGroup.fromJson)
+    }
+
+    async getPersonsInGroup(groupId) {
+        var response = await exec("getPersonsInGroup", [groupId])
+        return this._listResponseFromJson(response, Person.fromJson)
+    }
+
+    async getPersonsInGroupForPage(groupId, page, size) {
+        var response = await exec("getPersonsInGroupForPage", [groupId, page, size])
+        return this._listResponseFromJson(response, Person.fromJson)
+    }
+
+    async searchPerson(request) {
+        var response = await exec("searchPerson", [request])
+
+        var jsonObject = JSON.parse(response)
+        var data = null
+        if (jsonObject["data"] != null) {
+            data = []
+            for (var item of jsonObject["data"])
+                data.push(SearchPerson.fromJson(item))
+        }
+        var error = jsonObject["error"]
+
+        return [data, error]
+    }
+
+    _successResponseFromJson(jsonString) {
+        var jsonObject = JSON.parse(jsonString)
+        var data = jsonObject["data"]
+        var error = jsonObject["error"]
+        var success = data ?? false
+        return [success, error]
+    }
+
+    _itemResponseFromJson(jsonString, fromJSON) {
+        var jsonObject = JSON.parse(jsonString)
+        var data = fromJSON(jsonObject["data"])
+        var error = jsonObject["error"]
+        return [data, error]
+    }
+
+    _listResponseFromJson(jsonString, fromJSON) {
+        var jsonObject = JSON.parse(jsonString)
+        var data = PageableItemList.fromJson(jsonObject["data"], fromJSON)
+        var error = jsonObject["error"]
+        return [data, error]
+    }
+}

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

@@ -0,0 +1,18 @@
+export class PersonGroup {
+    name
+    id
+    metadata
+    createdAt
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+        var result = new PersonGroup()
+
+        result.name = jsonObject["name"]
+        result.id = jsonObject["id"]
+        result.metadata = jsonObject["metadata"]
+        result.createdAt = new Date(jsonObject["createdAt"])
+
+        return result
+    }
+}

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

@@ -0,0 +1,22 @@
+export class PersonImage {
+    path
+    url
+    contentType
+    id
+    metadata
+    createdAt
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+        var result = new PersonImage()
+
+        result.path = jsonObject["path"]
+        result.url = jsonObject["url"]
+        result.contentType = jsonObject["contentType"]
+        result.id = jsonObject["id"]
+        result.metadata = jsonObject["metadata"]
+        result.createdAt = new Date(jsonObject["createdAt"])
+
+        return result
+    }
+}

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

@@ -0,0 +1,31 @@
+import { SearchPersonImage } from './search_person_image'
+import { SearchPersonDetection } from './search_person_detection'
+
+export class SearchPerson {
+    images = []
+    detection
+    name
+    updatedAt
+    groups
+    id
+    metadata
+    createdAt
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+        var result = new SearchPerson()
+
+        if (jsonObject["images"] != null)
+            for (var item of jsonObject["images"])
+                result.images.push(SearchPersonImage.fromJson(item))
+        result.detection = SearchPersonDetection.fromJson(jsonObject["detection"])
+        result.name = jsonObject["name"]
+        result.updatedAt = new Date(jsonObject["updatedAt"])
+        result.groups = jsonObject["groups"]
+        result.id = jsonObject["id"]
+        result.metadata = jsonObject["metadata"]
+        result.createdAt = new Date(jsonObject["createdAt"])
+
+        return result
+    }
+}

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

@@ -0,0 +1,22 @@
+import { Point } from "../image_params/point"
+import { Rect } from "../image_params/rect"
+
+export class SearchPersonDetection {
+    landmarks = []
+    rect
+    crop
+    rotationAngle
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+        var result = new SearchPersonDetection()
+
+        for (var item of jsonObject["landmarks"])
+            result.landmarks.push(Point.fromJson(item))
+        result.rect = Rect.fromJson(jsonObject["rect"])
+        result.crop = jsonObject["crop"]
+        result.rotationAngle = jsonObject["rotationAngle"]
+
+        return result
+    }
+}

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

@@ -0,0 +1,26 @@
+export class SearchPersonImage {
+    similarity
+    distance
+    path
+    url
+    contentType
+    id
+    metadata
+    createdAt
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+        var result = new SearchPersonImage()
+
+        result.similarity = jsonObject["similarity"]
+        result.distance = jsonObject["distance"]
+        result.path = jsonObject["path"]
+        result.url = jsonObject["url"]
+        result.contentType = jsonObject["contentType"]
+        result.id = jsonObject["id"]
+        result.metadata = jsonObject["metadata"]
+        result.createdAt = new Date(jsonObject["createdAt"])
+
+        return result
+    }
+}

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

@@ -0,0 +1,17 @@
+export class SearchPersonRequest {
+    imageUpload
+    groupIdsForSearch
+    threshold
+    limit
+    detectAll
+    outputImageParams
+
+    constructor(image, params) {
+        this.imageUpload = image
+        this.groupIdsForSearch = params?.groupIdsForSearch
+        this.threshold = params?.threshold
+        this.limit = params?.limit
+        this.detectAll = params?.detectAll ?? false
+        this.outputImageParams = params?.outputImageParams
+    }
+}

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

@@ -0,0 +1,4 @@
+export enum CameraPosition {
+    FRONT,
+    BACK,
+}

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

@@ -0,0 +1,24 @@
+import { CustomizationColors } from './customization_colors'
+import { CustomizationFonts } from './customization_fonts'
+import { CustomizationImages } from './customization_images'
+
+export class Customization {
+    get colors(): CustomizationColors
+    set colors(val: CustomizationColors)
+
+    get fonts(): CustomizationFonts
+    set fonts(val: CustomizationFonts)
+
+    get images(): CustomizationImages
+    set images(val: CustomizationImages)
+
+    get uiCustomizationLayer(): Record<string, any> | null
+    set uiCustomizationLayer(val: Record<string, any> | null)
+
+    set onCustomButtonTapped(completion: CustomButtonTappedCompletion)
+
+    static fromJson(jsonObject: Record<string, any>): Customization
+    toJson(): Record<string, any>
+}
+
+export type CustomButtonTappedCompletion = (tag: number) => void

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

@@ -0,0 +1,31 @@
+export class CustomizationColors {
+    set onboardingScreenStartButtonBackground(val: number)
+    set onboardingScreenStartButtonTitle(val: number)
+    set onboardingScreenBackground(val: number)
+    set onboardingScreenTitleLabelText(val: number)
+    set onboardingScreenSubtitleLabelText(val: number)
+    set onboardingScreenMessageLabelsText(val: number)
+    set cameraScreenStrokeNormal(val: number)
+    set cameraScreenStrokeActive(val: number)
+    set cameraScreenSectorTarget(val: number)
+    set cameraScreenSectorActive(val: number)
+    set cameraScreenFrontHintLabelBackground(val: number)
+    set cameraScreenFrontHintLabelText(val: number)
+    set cameraScreenBackHintLabelBackground(val: number)
+    set cameraScreenBackHintLabelText(val: number)
+    set cameraScreenLightToolbarTint(val: number)
+    set cameraScreenDarkToolbarTint(val: number)
+    set retryScreenBackground(val: number)
+    set retryScreenRetryButtonBackground(val: number)
+    set retryScreenRetryButtonTitle(val: number)
+    set retryScreenTitleLabelText(val: number)
+    set retryScreenSubtitleLabelText(val: number)
+    set retryScreenHintLabelsText(val: number)
+    set processingScreenBackground(val: number)
+    set processingScreenProgress(val: number)
+    set processingScreenTitleLabel(val: number)
+    set successScreenBackground(val: number)
+
+    static fromJson(jsonObject: Record<string, number>): CustomizationColors
+    toJson(): Record<string, number>
+}

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

@@ -0,0 +1,17 @@
+import { Font}  from './font'
+
+export class CustomizationFonts {
+    set onboardingScreenStartButton(val: Font | null)
+    set onboardingScreenTitleLabel(val: Font | null)
+    set onboardingScreenSubtitleLabel(val: Font | null)
+    set onboardingScreenMessageLabels(val: Font | null)
+    set cameraScreenHintLabel(val: Font | null)
+    set retryScreenRetryButton(val: Font | null)
+    set retryScreenTitleLabel(val: Font | null)
+    set retryScreenSubtitleLabel(val: Font | null)
+    set retryScreenHintLabels(val: Font | null)
+    set processingScreenLabel(val: Font | null)
+
+    static fromJson(jsonObject: Record<string, any>): CustomizationFonts
+    toJson(): Record<string, any>
+}

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

@@ -0,0 +1,18 @@
+export class CustomizationImages {
+    set onboardingScreenCloseButton(val: string)
+    set onboardingScreenIllumination(val: string)
+    set onboardingScreenAccessories(val: string)
+    set onboardingScreenCameraLevel(val: string)
+    set cameraScreenCloseButton(val: string)
+    set cameraScreenLightOnButton(val: string)
+    set cameraScreenLightOffButton(val: string)
+    set cameraScreenSwitchButton(val: string)
+    set retryScreenCloseButton(val: string)
+    set retryScreenHintEnvironment(val: string)
+    set retryScreenHintSubject(val: string)
+    set processingScreenCloseButton(val: string)
+    set successScreenImage(val: string)
+
+    static fromJson(jsonObject: Record<string, string>): CustomizationImages
+    toJson(): Record<string, string>
+}

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

@@ -0,0 +1,14 @@
+export class Font {
+    name?: string
+    style?: number
+    size?: number
+
+    static fromJson(jsonObject?: any): Font | null
+}
+
+export enum FontStyle {
+    NORMAL,
+    BOLD,
+    ITALIC,
+    BOLD_ITALIC,
+}

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

@@ -0,0 +1,4 @@
+export enum ScreenOrientation {
+    PORTRAIT,
+    LANDSCAPE,
+}

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

@@ -0,0 +1,16 @@
+import { DetectFacesAttributeResult } from './detect_faces_attribute_result'
+import { ImageQualityResult } from '../image_quality/image_quality_result'
+import { Rect } from '../image_params/rect'
+import { Point } from '../image_params/point'
+
+export class DetectFaceResult {
+    get quality(): Array<ImageQualityResult> | null
+    get attributes(): Array<DetectFacesAttributeResult> | null
+    get crop(): string | null
+    get faceRect(): Rect | null
+    get originalRect(): Rect | null
+    get landmarks(): Array<Point> | null
+    get isQualityCompliant(): boolean
+
+    private constructor()
+}

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

@@ -0,0 +1,15 @@
+export enum DetectFacesAttribute {
+    AGE,
+    EYE_RIGHT,
+    EYE_LEFT,
+    EMOTION,
+    SMILE,
+    GLASSES,
+    HEAD_COVERING,
+    FOREHEAD_COVERING,
+    MOUTH,
+    MEDICAL_MASK,
+    OCCLUSION,
+    STRONG_MAKEUP,
+    HEADPHONES
+}

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

@@ -0,0 +1,11 @@
+import { DetectFacesAttribute } from './detect_faces_attribute'
+import { ImageQualityRange } from '../image_quality/image_quality_range'
+
+export class DetectFacesAttributeResult {
+    get attribute(): DetectFacesAttribute
+    get confidence(): number | null
+    get value(): string | null
+    get range(): ImageQualityRange | null
+
+    private constructor()
+}

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

@@ -0,0 +1,15 @@
+export class DetectFacesBackendException {
+    get code(): DetectFacesBackendErrorCode
+    get message(): string
+
+    private constructor()
+}
+
+export enum DetectFacesBackendErrorCode {
+    FR_FACE_NOT_DETECTED,
+    FACER_NO_LICENSE,
+    FACER_IS_NOT_INITIALIZED,
+    FACER_COMMAND_IS_NOT_SUPPORTED,
+    FACER_COMMAND_PARAMS_READ_ERROR,
+    UNDEFINED
+}

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

@@ -0,0 +1,19 @@
+import { DetectFacesAttribute } from './detect_faces_attribute'
+import { ImageQualityCharacteristic } from '../image_quality/image_quality_characteristic'
+import { OutputImageParams } from '../image_params/output_image_params'
+
+export class DetectFacesConfig {
+    attributes?: Array<DetectFacesAttribute>
+    customQuality?: Array<ImageQualityCharacteristic>
+    outputImageParams?: OutputImageParams
+    onlyCentralFace: boolean
+
+    constructor(
+        params?: {
+            attributes?: Array<DetectFacesAttribute>,
+            customQuality?: Array<ImageQualityCharacteristic>,
+            outputImageParams?: OutputImageParams,
+            onlyCentralFace?: boolean
+        }
+    )
+}

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

@@ -0,0 +1,21 @@
+import { DetectFacesBackendException } from "./detect_faces_backend_exception"
+
+export class DetectFacesException {
+    get code(): DetectFacesErrorCode
+    get message(): string
+    get underlyingError(): DetectFacesBackendException | null
+
+    private constructor()
+}
+
+export enum DetectFacesErrorCode {
+    IMAGE_EMPTY,
+    FR_FACE_NOT_DETECTED,
+    FACER_NO_LICENSE,
+    FACER_IS_NOT_INITIALIZED,
+    FACER_COMMAND_IS_NOT_SUPPORTED,
+    FACER_COMMAND_PARAMS_READ_ERROR,
+    PROCESSING_FAILED,
+    REQUEST_FAILED,
+    API_CALL_FAILED
+}

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

@@ -0,0 +1,27 @@
+import { DetectFacesConfig } from './detect_faces_config'
+
+export class DetectFacesRequest {
+    constructor(
+        image: string,
+        config: DetectFacesConfig,
+        params?: {
+            tag?: string,
+        }
+    )
+
+    static qualityFull(image: string): DetectFacesRequest
+
+    static qualityICAO(image: string): DetectFacesRequest
+
+    static qualityVisaSchengen(image: string): DetectFacesRequest
+
+    static qualityVisaUSA(image: string): DetectFacesRequest
+
+    static cropCentralFace(image: string): DetectFacesRequest
+
+    static cropAllFaces(image: string): DetectFacesRequest
+
+    static thumbnail(image: string): DetectFacesRequest
+
+    static allAttributes(image: string): DetectFacesRequest
+}

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

@@ -0,0 +1,12 @@
+import { DetectFaceResult } from './detect_face_result'
+import { DetectFacesException } from './detect_faces_exception'
+import { DetectFacesScenario } from './detect_faces_scenario'
+
+export class DetectFacesResponse {
+    get detection(): DetectFaceResult | null
+    get allDetections(): Array<DetectFaceResult> | null
+    get scenario(): DetectFacesScenario | null
+    get error(): DetectFacesException | null
+
+    private constructor()
+}

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

@@ -0,0 +1,10 @@
+export enum DetectFacesScenario {
+    CROP_CENTRAL_FACE,
+    CROP_ALL_FACES,
+    THUMBNAIL,
+    ATTRIBUTES_ALL,
+    QUALITY_FULL,
+    QUALITY_ICAO,
+    QUALITY_VISA_SCHENGEN,
+    QUALITY_VISA_USA
+}

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

@@ -0,0 +1,30 @@
+import { CameraPosition } from '../customization/camera_position'
+import { ScreenOrientation } from '../customization/screen_orientation'
+
+export class FaceCaptureConfig {
+    copyright: boolean
+    cameraSwitchEnabled: boolean
+    closeButtonEnabled: boolean
+    torchButtonEnabled: boolean
+    vibrateOnSteps: boolean
+    cameraPositionAndroid?: number
+    cameraPositionIOS: CameraPosition
+    screenOrientation?: Array<ScreenOrientation>
+    timeout?: number
+    holdStillDuration?: number
+
+    constructor(
+        params?: {
+            copyright?: boolean
+            cameraSwitchEnabled?: boolean
+            closeButtonEnabled?: boolean
+            torchButtonEnabled?: boolean
+            vibrateOnSteps?: boolean
+            cameraPositionAndroid?: number
+            cameraPositionIOS?: CameraPosition
+            screenOrientation?: Array<ScreenOrientation>
+            timeout?: number
+            holdStillDuration?: number
+        }
+    )
+}

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

@@ -0,0 +1,17 @@
+export class FaceCaptureException {
+    get code(): FaceCaptureErrorCode
+    get message(): string
+
+    private constructor()
+}
+
+export enum FaceCaptureErrorCode {
+    CANCEL,
+    TIMEOUT,
+    NOT_INITIALIZED,
+    SESSION_START_FAILED,
+    CAMERA_NOT_AVAILABLE,
+    CAMERA_NO_PERMISSION,
+    IN_PROGRESS_ALREADY,
+    CONTEXT_IS_NULL
+}

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

@@ -0,0 +1,15 @@
+export class FaceCaptureImage {
+    get image(): string
+    get imageType(): ImageType
+    get tag(): string | null
+}
+
+export enum ImageType {
+    PRINTED,
+    RFID,
+    LIVE,
+    DOCUMENT_WITH_LIVE,
+    EXTERNAL,
+    GHOST_PORTRAIT,
+    BARCODE
+}

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

@@ -0,0 +1,9 @@
+import { FaceCaptureImage } from './face_capture_image'
+import { FaceCaptureException } from './face_capture_exception'
+
+export class FaceCaptureResponse {
+    get image(): FaceCaptureImage | null
+    get error(): FaceCaptureException | null
+
+    private constructor()
+}

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

@@ -0,0 +1,25 @@
+import { Size } from './size'
+
+export class OutputImageCrop {
+    get type(): OutputImageCropAspectRatio
+    get size(): Size | null
+    get padColor(): number | null
+    get returnOriginalRect(): boolean
+
+    constructor(
+        type: OutputImageCropAspectRatio,
+        params?: {
+            size?: Size,
+            padColor?: number,
+            returnOriginalRect?: boolean,
+        }
+    )
+}
+
+export enum OutputImageCropAspectRatio {
+    RATIO_3X4,
+    RATIO_4X5,
+    RATIO_2X3,
+    RATIO_1X1,
+    RATIO_7X9
+}