@regulaforensics/face-sdk 8.4.1336-rc → 8.4.1343-nightly

package/www/react-native/index.js

@@ -104,15 +104,13 @@ export {
 
 import { LivenessConfig, RecordingProcess, LivenessType, LivenessSkipStep } from './liveness/liveness_config'
 import { EnrollmentConfig } from './liveness/enrollment_config'
-import { EnrollmentRequest } from './liveness/enrollment_request'
 import { VerificationConfig } from './liveness/verification_config'
 import { LivenessBackendException, LivenessBackendErrorCode } from './liveness/liveness_backend_exception'
 import { LivenessException, LivenessErrorCode } from './liveness/liveness_exception'
 import { LivenessResponse, LivenessStatus } from './liveness/liveness_response'
 import { LivenessNotification, LivenessProcessStatus } from './liveness/liveness_notification'
-import { ErrorResponse } from './liveness/error_response'
 import { EnrollmentResponse } from './liveness/enrollment_response'
-import { VerifyMatchResponse } from './liveness/verify_match_response'
+import { VerificationMatchResponse } from './liveness/verification_match_response'
 import { VerificationResponse } from './liveness/verification_response'
 export {
     LivenessBackendException,
@@ -128,11 +126,9 @@ export {
     LivenessResponse,
     LivenessStatus,
     EnrollmentConfig,
-    EnrollmentRequest,
     VerificationConfig,
-    ErrorResponse,
     EnrollmentResponse,
-    VerifyMatchResponse,
+    VerificationMatchResponse,
     VerificationResponse,
 }
 
@@ -173,6 +169,7 @@ 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 { SearchPersonFilter } from './person_database/search_person_filter'
 import { SearchPerson } from './person_database/search_person'
 export {
     EditGroupPersonsRequest,
@@ -185,6 +182,7 @@ export {
     SearchPersonDetection,
     SearchPersonImage,
     SearchPersonRequest,
+    SearchPersonFilter,
     SearchPerson,
 }
 
@@ -311,11 +309,6 @@ export class FaceSDK {
         return [lr, er];
     }
 
-    async enrollWithTrustedPhoto(request) {
-        var response = await exec("enrollWithTrustedPhoto", [request])
-        return EnrollmentResponse.fromJson(JSON.parse(response));
-    }
-
     stopLiveness() {
         exec("stopLiveness", [])
     }

package/www/react-native/liveness/enrollment_config.js

@@ -1,6 +1,8 @@
 import { CameraPosition } from '../customization/camera_position'
 import { ScreenOrientation } from '../customization/screen_orientation'
 import { RecordingProcess, LivenessType, LivenessSkipStep } from './liveness_config'
+import { Person } from '../person_database/person'
+import { SearchPersonFilter } from '../person_database/search_person_filter'
 
 export class EnrollmentConfig {
     copyright
@@ -19,10 +21,8 @@ export class EnrollmentConfig {
     tag
     skipStep
     metadata
-    externalId
-    groupId
-    checkDuplicatesEnabled
-    duplicatesThreshold
+    person
+    searchFilter
 
     constructor(options) {
         this.copyright = options?.copyright ?? true
@@ -41,10 +41,8 @@ export class EnrollmentConfig {
         this.tag = options?.tag
         this.skipStep = options?.skipStep ?? []
         this.metadata = options?.metadata
-        this.externalId = options?.externalId
-        this.groupId = options?.groupId
-        this.checkDuplicatesEnabled = options?.checkDuplicatesEnabled
-        this.duplicatesThreshold = options?.duplicatesThreshold
+        this.person = Person.fromJson(options?.person)
+        this.searchFilter = SearchPersonFilter.fromJson(options?.searchFilter)
     }
 
     static fromJson(jsonObject) {
@@ -67,10 +65,8 @@ export class EnrollmentConfig {
         result.tag = jsonObject["tag"]
         result.skipStep = jsonObject["skipStep"]
         result.metadata = jsonObject["metadata"]
-        result.externalId = jsonObject["externalId"]
-        result.groupId = jsonObject["groupId"]
-        result.checkDuplicatesEnabled = jsonObject["checkDuplicatesEnabled"]
-        result.duplicatesThreshold = jsonObject["duplicatesThreshold"]
+        result.person = Person.fromJson(jsonObject["person"])
+        result.searchFilter = SearchPersonFilter.fromJson(jsonObject["searchFilter"])
 
         return result
     }
@@ -93,10 +89,8 @@ export class EnrollmentConfig {
             "tag": this.tag,
             "skipStep": this.skipStep,
             "metadata": this.metadata,
-            "externalId": this.externalId,
-            "groupId": this.groupId,
-            "checkDuplicatesEnabled": this.checkDuplicatesEnabled,
-            "duplicatesThreshold": this.duplicatesThreshold,
+            "person": this.person?.toJson(),
+            "searchFilter": this.searchFilter?.toJson(),
         }
     }
 }

package/www/react-native/liveness/enrollment_response.js

@@ -1,26 +1,30 @@
-import { ErrorResponse } from './error_response'
+import { Person } from '../person_database/person'
+import { SearchPerson } from '../person_database/search_person'
 
 export class EnrollmentResponse {
-    personId
-    externalId
-    error
+    enrolled
+    person
+    searchPersons
 
     static fromJson(jsonObject) {
         if (jsonObject == null) return null
         const result = new EnrollmentResponse()
 
-        result.personId = jsonObject["personId"]
-        result.externalId = jsonObject["externalId"]
-        result.error = ErrorResponse.fromJson(jsonObject["error"])
+        result.enrolled = jsonObject["enrolled"]
+        result.person = Person.fromJson(jsonObject["person"])
+        result.searchPersons = []
+        if (jsonObject["searchPersons"] != null)
+            for (const item of jsonObject["searchPersons"])
+                result.searchPersons.push(SearchPerson.fromJson(item))
 
         return result
     }
 
     toJson() {
         return {
-            "personId": this.personId,
-            "externalId": this.externalId,
-            "error": this.error?.toJson(),
+            "enrolled": this.enrolled,
+            "person": this.person?.toJson(),
+            "searchPersons": this.searchPersons?.map(e => e.toJson()),
         }
     }
 }

package/www/react-native/liveness/liveness_exception.js

@@ -36,9 +36,9 @@ export const LivenessErrorCode = {
     PROCESSING_FRAME_FAILED: 7,
     APPLICATION_INACTIVE: 8,
     BAD_FACE_QUALITY: 9,
-    BAD_FRAME_SIZE: 10,
-    CAMERA_NOT_AVAILABLE: 11,
-    CAMERA_NO_PERMISSION: 12,
+    CAMERA_NOT_AVAILABLE: 10,
+    CAMERA_NO_PERMISSION: 11,
+    BAD_FRAME_SIZE: 12,
     CONTEXT_IS_NULL: 13,
     IN_PROGRESS_ALREADY: 14,
     ZOOM_NOT_SUPPORTED: 15,

package/www/react-native/liveness/verification_config.js

@@ -20,7 +20,7 @@ export class VerificationConfig {
     skipStep
     metadata
     personId
-    groupId
+    externalId
     threshold
 
     constructor(options) {
@@ -41,10 +41,22 @@ export class VerificationConfig {
         this.skipStep = options?.skipStep ?? []
         this.metadata = options?.metadata
         this.personId = options?.personId
-        this.groupId = options?.groupId
+        this.externalId = options?.externalId
         this.threshold = options?.threshold
     }
 
+    static withPersonId(personId, options) {
+        const result = new VerificationConfig(options)
+        result.personId = personId
+        return result
+    }
+
+    static withExternalId(externalId, options) {
+        const result = new VerificationConfig(options)
+        result.externalId = externalId
+        return result
+    }
+
     static fromJson(jsonObject) {
         if (jsonObject == null) return null
         const result = new VerificationConfig()
@@ -66,7 +78,7 @@ export class VerificationConfig {
         result.skipStep = jsonObject["skipStep"]
         result.metadata = jsonObject["metadata"]
         result.personId = jsonObject["personId"]
-        result.groupId = jsonObject["groupId"]
+        result.externalId = jsonObject["externalId"]
         result.threshold = jsonObject["threshold"]
 
         return result
@@ -91,7 +103,7 @@ export class VerificationConfig {
             "skipStep": this.skipStep,
             "metadata": this.metadata,
             "personId": this.personId,
-            "groupId": this.groupId,
+            "externalId": this.externalId,
             "threshold": this.threshold,
         }
     }

package/www/react-native/liveness/{verify_match_response.js → verification_match_response.js}

@@ -1,12 +1,12 @@
-export class VerifyMatchResponse {
-    passed
+export class VerificationMatchResponse {
+    verified
     similarity
 
     static fromJson(jsonObject) {
         if (jsonObject == null) return null
-        const result = new VerifyMatchResponse()
+        const result = new VerificationMatchResponse()
 
-        result.passed = jsonObject["passed"]
+        result.verified = jsonObject["verified"]
         result.similarity = jsonObject["similarity"]
 
         return result
@@ -14,7 +14,7 @@ export class VerifyMatchResponse {
 
     toJson() {
         return {
-            "passed": this.passed,
+            "verified": this.verified,
             "similarity": this.similarity,
         }
     }

package/www/react-native/liveness/verification_response.js

@@ -1,27 +1,27 @@
-import { VerifyMatchResponse } from './verify_match_response'
-import { ErrorResponse } from './error_response'
+import { VerificationMatchResponse } from './verification_match_response'
+import { Person } from '../person_database/person'
 
 export class VerificationResponse {
-    passed
+    verified
+    person
     match
-    error
 
     static fromJson(jsonObject) {
         if (jsonObject == null) return null
         const result = new VerificationResponse()
 
-        result.passed = jsonObject["passed"]
-        result.match = VerifyMatchResponse.fromJson(jsonObject["match"])
-        result.error = ErrorResponse.fromJson(jsonObject["error"])
+        result.verified = jsonObject["verified"]
+        result.person = Person.fromJson(jsonObject["person"])
+        result.match = VerificationMatchResponse.fromJson(jsonObject["match"])
 
         return result
     }
 
     toJson() {
         return {
-            "passed": this.passed,
+            "verified": this.verified,
+            "person": this.person?.toJson(),
             "match": this.match?.toJson(),
-            "error": this.error?.toJson(),
         }
     }
 }

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

@@ -1,35 +1,44 @@
 import { dateToString } from '../internal/bridge'
 
 export class Person {
+    id
+    createdAt
     name
     updatedAt
     groups
-    id
     metadata
-    createdAt
+    externalId
+    expireAt
+    ttl
 
     static fromJson(jsonObject) {
         if (jsonObject == null) return null
         var result = new Person()
 
+        result.id = jsonObject["id"]
+        result.createdAt = jsonObject["createdAt"] === null ? null : new Date(jsonObject["createdAt"]);
         result.name = jsonObject["name"]
-        result.updatedAt = new Date(jsonObject["updatedAt"])
+        result.updatedAt = jsonObject["updatedAt"] === null ? null : new Date(jsonObject["updatedAt"]);
         result.groups = jsonObject["groups"]
-        result.id = jsonObject["id"]
         result.metadata = jsonObject["metadata"]
-        result.createdAt = new Date(jsonObject["createdAt"])
+        result.externalId = jsonObject["externalId"]
+        result.expireAt = jsonObject["expireAt"] === null ? null : new Date(jsonObject["expireAt"]);
+        result.ttl = jsonObject["ttl"]
 
         return result
     }
 
     toJson() {
         return {
+            "id": this.id,
+            "createdAt": dateToString(this.createdAt),
             "name": this.name,
             "updatedAt": dateToString(this.updatedAt),
             "groups": this.groups,
-            "id": this.id,
             "metadata": this.metadata,
-            "createdAt": dateToString(this.createdAt),
+            "externalId": this.externalId,
+            "expireAt": dateToString(this.expireAt),
+            "ttl": this.ttl,
         }
     }
 }

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

@@ -11,6 +11,9 @@ export class SearchPerson {
     id
     metadata
     createdAt
+    externalId
+    expireAt
+    ttl
 
     static fromJson(jsonObject) {
         if (jsonObject == null) return null
@@ -26,6 +29,9 @@ export class SearchPerson {
         result.id = jsonObject["id"]
         result.metadata = jsonObject["metadata"]
         result.createdAt = new Date(jsonObject["createdAt"])
+        result.externalId = jsonObject["externalId"]
+        result.expireAt = new Date(jsonObject["expireAt"])
+        result.ttl = jsonObject["ttl"]
 
         return result
     }
@@ -40,6 +46,9 @@ export class SearchPerson {
             "id": this.id,
             "metadata": this.metadata,
             "createdAt": dateToString(this.createdAt),
+            "externalId": this.externalId,
+            "expireAt": dateToString(this.expireAt),
+            "ttl": this.ttl,
         }
     }
 }

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

@@ -0,0 +1,44 @@
+export class SearchPersonFilter {
+    groups
+    threshold
+    limit
+    fieldName
+    fieldValues
+    exclude
+
+    constructor(options) {
+        this.groups = options?.groups ?? []
+        this.threshold = options?.threshold ?? 0
+        this.limit = options?.limit ?? 1
+    }
+
+    filterField(fieldName, fieldValues, options) {
+        this.fieldName = fieldName
+        this.fieldValues = fieldValues
+        this.exclude = options?.exclude ?? false
+    }
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+        var result = new SearchPersonFilter({
+            groups: jsonObject["groups"],
+            threshold: jsonObject["threshold"],
+            limit: jsonObject["limit"]
+        })
+        result.fieldName = jsonObject["fieldName"];
+        result.fieldValues = jsonObject["fieldValues"];
+        result.exclude = jsonObject["exclude"];
+        return result
+    }
+
+    toJson() {
+        return {
+            "groups": this.groups,
+            "threshold": this.threshold,
+            "limit": this.limit,
+            "fieldName": this.fieldName,
+            "fieldValues": this.fieldValues,
+            "exclude": this.exclude,
+        }
+    }
+}

package/www/types/index.d.ts

@@ -98,15 +98,13 @@ export {
 
 import { LivenessConfig, RecordingProcess, LivenessType, LivenessSkipStep } from './liveness/liveness_config'
 import { EnrollmentConfig } from './liveness/enrollment_config'
-import { EnrollmentRequest } from './liveness/enrollment_request'
 import { VerificationConfig } from './liveness/verification_config'
 import { LivenessBackendException, LivenessBackendErrorCode } from './liveness/liveness_backend_exception'
 import { LivenessException, LivenessErrorCode } from './liveness/liveness_exception'
 import { LivenessResponse, LivenessStatus } from './liveness/liveness_response'
 import { LivenessNotification, LivenessProcessStatus, LivenessNotificationCompletion } from './liveness/liveness_notification'
-import { ErrorResponse } from './liveness/error_response'
 import { EnrollmentResponse } from './liveness/enrollment_response'
-import { VerifyMatchResponse } from './liveness/verify_match_response'
+import { VerificationMatchResponse } from './liveness/verification_match_response'
 import { VerificationResponse } from './liveness/verification_response'
 export {
     LivenessBackendException,
@@ -123,11 +121,9 @@ export {
     LivenessResponse,
     LivenessStatus,
     EnrollmentConfig,
-    EnrollmentRequest,
     VerificationConfig,
-    ErrorResponse,
     EnrollmentResponse,
-    VerifyMatchResponse,
+    VerificationMatchResponse,
     VerificationResponse,
 }
 
@@ -168,6 +164,7 @@ 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 { SearchPersonFilter } from './person_database/search_person_filter'
 import { SearchPerson } from './person_database/search_person'
 export {
     EditGroupPersonsRequest,
@@ -180,6 +177,7 @@ export {
     SearchPersonDetection,
     SearchPersonImage,
     SearchPersonRequest,
+    SearchPersonFilter,
     SearchPerson,
 }
 
@@ -299,8 +297,6 @@ export class FaceSDK {
         }
     ): Promise<[LivenessResponse, VerificationResponse | null]>
 
-    enrollWithTrustedPhoto(request: EnrollmentRequest): Promise<EnrollmentResponse>
-
     stopLiveness(): void
 
     matchFaces(

package/www/types/liveness/enrollment_config.d.ts

@@ -1,6 +1,8 @@
 import { CameraPosition } from '../customization/camera_position'
 import { ScreenOrientation } from '../customization/screen_orientation'
 import { RecordingProcess, LivenessType, LivenessSkipStep } from './liveness_config'
+import { Person } from '../person_database/person'
+import { SearchPersonFilter } from '../person_database/search_person_filter'
 
 export interface EnrollmentConfig {
     /**
@@ -87,11 +89,7 @@ export interface EnrollmentConfig {
 
     metadata?: Record<string, any>
 
-    externalId: string
+    person?: Person
 
-    groupId?: string
-
-    checkDuplicatesEnabled?: boolean
-
-    duplicatesThreshold?: number
+    searchFilter?: SearchPersonFilter
 }

package/www/types/liveness/enrollment_response.d.ts

@@ -1,9 +1,10 @@
-import { ErrorResponse } from './error_response'
+import { Person } from '../person_database/person'
+import { SearchPerson } from '../person_database/search_person'
 
 export class EnrollmentResponse {
-    readonly personId?: string
-    readonly externalId?: string
-    readonly error?: ErrorResponse
+    readonly enrolled: boolean
+    readonly person: Person | null
+    readonly searchPersons: Array<SearchPerson> | null
 
     private constructor()
 }

package/www/types/liveness/liveness_exception.d.ts

@@ -29,12 +29,12 @@ export enum LivenessErrorCode {
     APPLICATION_INACTIVE,
     /** Processing finished by bad face quality. */
     BAD_FACE_QUALITY,
-    /** Processing finished by bad frame size. */
-    BAD_FRAME_SIZE,
     /** Device has no available camera. */
     CAMERA_NOT_AVAILABLE,
     /** Application does not have camera permission. */
     CAMERA_NO_PERMISSION,
+    /** Processing finished by bad frame size. */
+    BAD_FRAME_SIZE,
     /**
      * Application context is null.
      * 

package/www/types/liveness/verification_config.d.ts

@@ -2,7 +2,7 @@ import { CameraPosition } from '../customization/camera_position'
 import { ScreenOrientation } from '../customization/screen_orientation'
 import { RecordingProcess, LivenessType, LivenessSkipStep } from './liveness_config'
 
-export interface VerificationConfig {
+export class VerificationConfig {
     /**
      * Defines, whether the logo is visible on the bottom of Liveness UI screens. Defaults to `true`.
      */
@@ -87,9 +87,53 @@ export interface VerificationConfig {
 
     metadata?: Record<string, any>
 
-    personId: string
-
-    groupId?: string
-
     threshold?: number
+
+    private constructor();
+
+    static withPersonId(
+        personId: string,
+        options?: {
+            copyright?: boolean
+            cameraSwitchEnabled?: boolean
+            closeButtonEnabled?: boolean
+            torchButtonEnabled?: boolean
+            vibrateOnSteps?: boolean
+            cameraPositionAndroid?: number
+            cameraPositionIOS?: CameraPosition
+            screenOrientation?: Array<ScreenOrientation>
+            locationTrackingEnabled?: boolean
+            preventScreenRecording?: boolean
+            attemptsCount?: number
+            recordingProcess?: RecordingProcess
+            livenessType?: LivenessType
+            tag?: string
+            skipStep?: Array<LivenessSkipStep>
+            metadata?: Record<string, any>
+            threshold?: number
+        }
+    ): VerificationConfig;
+
+    static withExternalId(
+        externalId: string,
+        options?: {
+            copyright?: boolean
+            cameraSwitchEnabled?: boolean
+            closeButtonEnabled?: boolean
+            torchButtonEnabled?: boolean
+            vibrateOnSteps?: boolean
+            cameraPositionAndroid?: number
+            cameraPositionIOS?: CameraPosition
+            screenOrientation?: Array<ScreenOrientation>
+            locationTrackingEnabled?: boolean
+            preventScreenRecording?: boolean
+            attemptsCount?: number
+            recordingProcess?: RecordingProcess
+            livenessType?: LivenessType
+            tag?: string
+            skipStep?: Array<LivenessSkipStep>
+            metadata?: Record<string, any>
+            threshold?: number
+        }
+    ): VerificationConfig;
 }

package/www/types/liveness/verification_match_response.d.ts

@@ -0,0 +1,6 @@
+export class VerificationMatchResponse {
+    readonly verified: boolean
+    readonly similarity: number
+
+    private constructor()
+}

package/www/types/liveness/verification_response.d.ts

@@ -1,10 +1,10 @@
-import { VerifyMatchResponse } from './verify_match_response'
-import { ErrorResponse } from './error_response'
+import { VerificationMatchResponse } from './verification_match_response'
+import { Person } from '../person_database/person'
 
 export class VerificationResponse {
-    readonly passed: boolean
-    readonly match?: VerifyMatchResponse
-    readonly error?: ErrorResponse
+    readonly verified: boolean
+    readonly person?: Person
+    readonly match?: VerificationMatchResponse
 
     private constructor()
 }

package/www/types/person_database/person.d.ts

@@ -3,31 +3,35 @@
  * A Person Database object that represents Person.
  */
 export class Person {
+    id?: string | null
+
+    get createdAt(): Date | null
+
     /**
      * Person name.
      * Updatable field.
      */
-    name: string
+    name?: string | null
 
     /**
      * Person update date.
      */
-    get updatedAt(): Date
+    updatedAt?: Date | null
 
     /**
      * Array if Group IDs Person belongs to.
      */
-    get groups(): string[]
-
-    get id(): string
+    groups?: string[] | null
 
     /**
      * A free-form object containing Person extended attributes.
      * Updatable field.
      */
-    metadata: any
+    metadata?: any | null
+
+    externalId?: string | null
 
-    get createdAt(): Date
+    expireAt?: Date | null
 
-    private constructor()
+    ttl?: number | null
 }

package/www/types/person_database/search_person.d.ts

@@ -27,5 +27,11 @@ export class SearchPerson {
     
     get createdAt(): Date
 
+    externalId?: string | null
+
+    expireAt?: Date | null
+
+    ttl?: number | null
+
     private constructor()
 }