@regulaforensics/face-sdk 8.3.1174-rc → 8.3.1176-nightly

package/www/types/index.d.ts

@@ -5,7 +5,16 @@ import { CustomizationImages } from './customization/customization_images'
 import { Customization, CustomButtonTappedCompletion } from './customization/customization'
 import { Font } from './customization/font'
 import { ScreenOrientation } from './customization/screen_orientation'
-export { CameraPosition, CustomizationColors, CustomizationFonts, CustomizationImages, Customization, CustomButtonTappedCompletion, Font, ScreenOrientation }
+export {
+    CameraPosition,
+    CustomizationColors,
+    CustomizationFonts,
+    CustomizationImages,
+    Customization,
+    CustomButtonTappedCompletion,
+    Font,
+    ScreenOrientation,
+}
 
 import { FaceSDKVersion } from './init/face_sdk_version'
 import { InitConfig } from './init/init_config'
@@ -13,7 +22,14 @@ 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 }
+export {
+    FaceSDKVersion,
+    InitConfig,
+    InitException,
+    InitErrorCode,
+    LicenseException,
+    LicensingResultCode,
+}
 
 import { DetectFaceResult } from './detect_faces/detect_face_result'
 import { DetectFacesAttributeResult } from './detect_faces/detect_faces_attribute_result'
@@ -24,34 +40,96 @@ import { DetectFacesException, DetectFacesErrorCode } from './detect_faces/detec
 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 }
+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 }
+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 }
+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 }
+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 { 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 { LivenessNotification, LivenessProcessStatus, LivenessNotificationCompletion } from './liveness/liveness_notification'
 import { LivenessResponse, LivenessStatus } from './liveness/liveness_response'
-export { LivenessBackendException, LivenessBackendErrorCode, LivenessConfig, RecordingProcess, LivenessType, LivenessSkipStep, LivenessException, LivenessErrorCode, LivenessNotification, LivenessProcessStatus, LivenessNotificationCompletion, LivenessResponse, LivenessStatus }
+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 { VerificationResponse } from './liveness/verification_response'
+export {
+    LivenessBackendException,
+    LivenessBackendErrorCode,
+    LivenessConfig,
+    RecordingProcess,
+    LivenessType,
+    LivenessSkipStep,
+    LivenessException,
+    LivenessErrorCode,
+    LivenessNotification,
+    LivenessProcessStatus,
+    LivenessNotificationCompletion,
+    LivenessResponse,
+    LivenessStatus,
+    // EnrollmentConfig,
+    // EnrollmentRequest,
+    // VerificationConfig,
+    // ErrorResponse,
+    // EnrollmentResponse,
+    // VerifyMatchResponse,
+    // VerificationResponse,
+}
 
 import { ComparedFace } from './match_faces/compared_face'
 import { ComparedFacesPair } from './match_faces/compared_faces_pair'
@@ -64,7 +142,21 @@ import { MatchFacesException, MatchFacesErrorCode } from './match_faces/match_fa
 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 }
+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'
@@ -77,7 +169,19 @@ 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 {
+    EditGroupPersonsRequest,
+    ImageUpload,
+    PageableItemList,
+    PersonDatabase,
+    PersonGroup,
+    PersonImage,
+    Person,
+    SearchPersonDetection,
+    SearchPersonImage,
+    SearchPersonRequest,
+    SearchPerson,
+}
 
 /**
  * Entry point of the Regula Face SDK.
@@ -151,7 +255,7 @@ export class FaceSDK {
      * and a nullable {@link InitException}.
      */
     initialize(
-        params?: {
+        options?: {
             config?: InitConfig
         }
     ): Promise<[boolean, InitException | null]>
@@ -163,7 +267,7 @@ export class FaceSDK {
     deinitialize(): void
 
     startFaceCapture(
-        params?: {
+        options?: {
             config?: FaceCaptureConfig,
             cameraSwitchCallback?: CameraSwitchCallback,
         }
@@ -172,18 +276,36 @@ export class FaceSDK {
     stopFaceCapture(): void
 
     startLiveness(
-        params?: {
+        options?: {
             config?: LivenessConfig,
             notificationCompletion?: LivenessNotificationCompletion,
             cameraSwitchCallback?: CameraSwitchCallback,
         }
     ): Promise<LivenessResponse>
 
+    // startEnrollment(
+    //     config: EnrollmentConfig,
+    //     options?: {
+    //         notificationCompletion?: LivenessNotificationCompletion,
+    //         cameraSwitchCallback?: CameraSwitchCallback,
+    //     }
+    // ): Promise<[LivenessResponse, EnrollmentResponse | null]>
+
+    // startVerification(
+    //     config: VerificationConfig,
+    //     options?: {
+    //         notificationCompletion?: LivenessNotificationCompletion,
+    //         cameraSwitchCallback?: CameraSwitchCallback,
+    //     }
+    // ): Promise<[LivenessResponse, VerificationResponse | null]>
+
+    // enrollWithTrustedPhoto(request: EnrollmentRequest): Promise<EnrollmentResponse>
+
     stopLiveness(): void
 
     matchFaces(
         request: MatchFacesRequest,
-        params?: {
+        options?: {
             config?: MatchFacesConfig
         }
     ): Promise<MatchFacesResponse>

package/www/types/init/init_config.d.ts

@@ -16,7 +16,7 @@ export class InitConfig {
      */
     constructor(
         license: string,
-        params?: {
+        options?: {
             licenseUpdate?: boolean
         })
 }

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

@@ -0,0 +1,97 @@
+import { CameraPosition } from '../customization/camera_position'
+import { ScreenOrientation } from '../customization/screen_orientation'
+import { RecordingProcess, LivenessType, LivenessSkipStep } from './liveness_config'
+
+export interface EnrollmentConfig {
+    /**
+     * Defines, whether the logo is visible on the bottom of Liveness UI screens. Defaults to `true`.
+     */
+    copyright?: boolean
+
+    /**
+     * Defines, whether the camera's toolbar switch camera button is available on the Liveness UI. Defaults to `false`.
+     * When set to `true` the CameraToolbarView will contain a button to change current `cameraPosition`.
+     * Only for livenessType = {@link LivenessType.PASSIVE}.
+     */
+    cameraSwitchEnabled?: boolean
+
+    closeButtonEnabled?: boolean
+
+    /**
+     * Defines, whether the camera's toolbar torch button is available on the Liveness UI. Defaults to `true`.
+     * When set to `false` the CameraToolbarView won't contain a button to toggle camera's flashlight.
+     * Only for livenessType = {@link LivenessType.PASSIVE}.
+     */
+    torchButtonEnabled?: boolean
+
+    /**
+     * Enables vibration during Liveness processing. Defaults to `true`.
+     */
+    vibrateOnSteps?: boolean
+
+    /**
+     * Android only.
+     */
+    cameraPositionAndroid?: number
+
+    /**
+     * IOS only.
+     */
+    cameraPositionIOS?: CameraPosition
+
+    /**
+     * Allows you to specify an orientation of the camera view controller.
+     */
+    screenOrientation?: Array<ScreenOrientation>
+
+    /**
+     * Defines whether the liveness request sends a location of a device. Defaults to `true`.
+     * When set to `true` the liveness request to web service will contain the `location`
+     * object within the json `metadata` object.
+     * The location is used only when permissions are granted and the location is available.
+     */
+    locationTrackingEnabled?: boolean
+
+    /**
+     * Prevents screenshots and screen recording while FaceCapture camera screen is displayed.
+     * Defaults to `false`.
+     */
+    preventScreenRecording?: boolean
+
+    /**
+     * The number of attempts to pass the Liveness before completing with error. Defaults to `0`.
+     * When set to `0`  the Liveness will always ask to retry on error.
+     */
+    attemptsCount?: number
+
+    /**
+     * Defines whether the liveness recording video of processing.
+     * Defaults to {@link RecordingProcess.ASYNCHRONOUS_UPLOAD}.
+     */
+    recordingProcess?: RecordingProcess
+
+    /**
+     * Defines whether the liveness processing type. Defaults to {@link LivenessType.ACTIVE}.
+     */
+    livenessType?: LivenessType
+
+    /**
+     * Defines tag that can be used in Liveness processing. Defaults to `null`.
+     */
+    tag?: string
+
+    /**
+     * Defines which steps of the user interface can be omitted. See {@link LivenessSkipStep} enum for details.
+     */
+    skipStep?: Array<LivenessSkipStep>
+
+    metadata?: Record<string, any>
+
+    externalId: string
+
+    groupId?: string
+
+    checkDuplicatesEnabled?: boolean
+
+    duplicatesThreshold?: number
+}

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

@@ -0,0 +1,24 @@
+export class EnrollmentRequest {
+    readonly externalId: string
+    readonly groupId?: string
+    readonly trustedImage?: string
+    readonly trustedImageUrl?: string
+
+    static withImage(
+        externalId: string,
+        trustedImage: string,
+        options?: {
+            groupId?: string
+        }
+    ): EnrollmentRequest;
+
+    static withImageUrl(
+        externalId: string,
+        trustedImageUrl: string,
+        options?: {
+            groupId?: string
+        }
+    ): EnrollmentRequest;
+
+    private constructor()
+}

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

@@ -0,0 +1,9 @@
+import { ErrorResponse } from './error_response'
+
+export class EnrollmentResponse {
+    readonly personId?: string
+    readonly externalId?: string
+    readonly error?: ErrorResponse
+
+    private constructor()
+}

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

@@ -0,0 +1,6 @@
+export class ErrorResponse {
+    readonly code: number
+    readonly message: string
+
+    private constructor()
+}

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

@@ -91,7 +91,7 @@ export class LivenessConfig {
     metadata?: Record<string, any>
 
     constructor(
-        params?: {
+        options?: {
             copyright?: boolean
             cameraSwitchEnabled?: boolean
             closeButtonEnabled?: boolean
@@ -121,6 +121,7 @@ export enum RecordingProcess {
 export enum LivenessType {
     ACTIVE,
     PASSIVE,
+    PASSIVE_WITH_BLINK,
 }
 
 export enum LivenessSkipStep {

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

@@ -9,18 +9,48 @@ export class LivenessException {
 }
 
 export enum LivenessErrorCode {
+    /** FaceSDK Core is not initialized. */
     NOT_INITIALIZED,
+    /** There is no valid license on the service. */
     NO_LICENSE,
+    /** Liveness API call failed due to networking error or backend internal error. */
     API_CALL_FAILED,
+    /** Failed when Core could not start new session. */
     SESSION_START_FAILED,
+    /** User cancelled liveness processing. */
     CANCELLED,
+    /** Processing finished by timeout. */
     PROCESSING_TIMEOUT,
+    /** Processing failed. */
     PROCESSING_FAILED,
+    /** Failed when Core cannot recognize frame. */
     PROCESSING_FRAME_FAILED,
+    /** Client application did enter the background, liveness process interrupted. */
     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,
+    /**
+     * Application context is null.
+     * 
+     * Android only.
+     */
     CONTEXT_IS_NULL,
+    /**
+     * Liveness process already in progress.
+     * 
+     * Android only.
+     */
     IN_PROGRESS_ALREADY,
+    /**
+     * The camera on the current device doesn't support zoom change.
+     * 
+     * Android only.
+     */
     ZOOM_NOT_SUPPORTED,
-    CAMERA_NO_PERMISSION,
-    CAMERA_NOT_AVAILABLE,
 }

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

@@ -26,6 +26,8 @@ export enum LivenessProcessStatus {
     FAILED,
     RETRY,
     SUCCESS,
+    BLINK,
+    BAD_FACE_QUALITY,
 }
 
 export type LivenessNotificationCompletion = (notification: LivenessNotification) => void

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

@@ -0,0 +1,95 @@
+import { CameraPosition } from '../customization/camera_position'
+import { ScreenOrientation } from '../customization/screen_orientation'
+import { RecordingProcess, LivenessType, LivenessSkipStep } from './liveness_config'
+
+export interface VerificationConfig {
+    /**
+     * Defines, whether the logo is visible on the bottom of Liveness UI screens. Defaults to `true`.
+     */
+    copyright?: boolean
+
+    /**
+     * Defines, whether the camera's toolbar switch camera button is available on the Liveness UI. Defaults to `false`.
+     * When set to `true` the CameraToolbarView will contain a button to change current `cameraPosition`.
+     * Only for livenessType = {@link LivenessType.PASSIVE}.
+     */
+    cameraSwitchEnabled?: boolean
+
+    closeButtonEnabled?: boolean
+
+    /**
+     * Defines, whether the camera's toolbar torch button is available on the Liveness UI. Defaults to `true`.
+     * When set to `false` the CameraToolbarView won't contain a button to toggle camera's flashlight.
+     * Only for livenessType = {@link LivenessType.PASSIVE}.
+     */
+    torchButtonEnabled?: boolean
+
+    /**
+     * Enables vibration during Liveness processing. Defaults to `true`.
+     */
+    vibrateOnSteps?: boolean
+
+    /**
+     * Android only.
+     */
+    cameraPositionAndroid?: number
+
+    /**
+     * IOS only.
+     */
+    cameraPositionIOS?: CameraPosition
+
+    /**
+     * Allows you to specify an orientation of the camera view controller.
+     */
+    screenOrientation?: Array<ScreenOrientation>
+
+    /**
+     * Defines whether the liveness request sends a location of a device. Defaults to `true`.
+     * When set to `true` the liveness request to web service will contain the `location`
+     * object within the json `metadata` object.
+     * The location is used only when permissions are granted and the location is available.
+     */
+    locationTrackingEnabled?: boolean
+
+    /**
+     * Prevents screenshots and screen recording while FaceCapture camera screen is displayed.
+     * Defaults to `false`.
+     */
+    preventScreenRecording?: boolean
+
+    /**
+     * The number of attempts to pass the Liveness before completing with error. Defaults to `0`.
+     * When set to `0`  the Liveness will always ask to retry on error.
+     */
+    attemptsCount?: number
+
+    /**
+     * Defines whether the liveness recording video of processing.
+     * Defaults to {@link RecordingProcess.ASYNCHRONOUS_UPLOAD}.
+     */
+    recordingProcess?: RecordingProcess
+
+    /**
+     * Defines whether the liveness processing type. Defaults to {@link LivenessType.ACTIVE}.
+     */
+    livenessType?: LivenessType
+
+    /**
+     * Defines tag that can be used in Liveness processing. Defaults to `null`.
+     */
+    tag?: string
+
+    /**
+     * Defines which steps of the user interface can be omitted. See {@link LivenessSkipStep} enum for details.
+     */
+    skipStep?: Array<LivenessSkipStep>
+
+    metadata?: Record<string, any>
+
+    personId: string
+
+    groupId?: string
+
+    threshold?: number
+}

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

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

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

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

package/www/types/match_faces/match_faces_config.d.ts

@@ -3,7 +3,7 @@ export class MatchFacesConfig {
     locationTrackingEnabled: boolean
 
     constructor(
-        params?: {
+        options?: {
             processingMode?: ProcessingMode
             locationTrackingEnabled?: boolean
         }

package/www/types/match_faces/match_faces_image.d.ts

@@ -27,7 +27,7 @@ export class MatchFacesImage {
     constructor(
         image: string,
         imageType: ImageType,
-        params?: {
+        options?: {
             detectAll?: boolean
         }
     )

package/www/types/match_faces/match_faces_request.d.ts

@@ -25,7 +25,7 @@ export class MatchFacesRequest {
 
     constructor(
         images: Array<MatchFacesImage>,
-        params?: {
+        options?: {
             outputImageParams?: OutputImageParams
             tag?: string
             metadata?: Record<string, any>

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

@@ -1,6 +1,6 @@
 export class EditGroupPersonsRequest {
     constructor(
-        params: {
+        options: {
             personIdsToAdd?: string[],
             personIdsToRemove?: string[],
         }

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

@@ -13,7 +13,7 @@ import { SearchPerson } from './search_person'
 export class PersonDatabase {
     createPerson(
         name: string,
-        params?: {
+        options?: {
             groupIds?: string[],
             metadata?: any,
         }
@@ -50,7 +50,7 @@ export class PersonDatabase {
 
     createGroup(
         name: string,
-        params?: {
+        options?: {
             metadata?: any,
         }
     ): Promise<[PersonGroup | null, string | null]>

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

@@ -31,7 +31,7 @@ export class SearchPersonRequest {
 
     constructor(
         image: ImageUpload,
-        params?: {
+        options?: {
             groupIdsForSearch?: string[],
             threshold?: number,
             limit?: number,