@regulaforensics/face-sdk 6.5.63-beta → 6.5.67-beta

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

@@ -1,80 +0,0 @@
-import { DetectFacesConfig } from './detect_faces_config'
-
-/**
- * Detect Faces Request.
- * Could be created by predefined scenarios (e.g: {@link DetectFacesRequest.qualityICAO}, {@link DetectFacesRequest.cropAllFaces} etc. )
- * or by using custom {@link DetectFacesConfig}.
- */
-export class DetectFacesRequest {
-
-    /**
-     * Create {@link DetectFacesRequest} object.
-     * 
-     * @param image - Image base64.
-     * @param config - Custom Request configuration to specify  image, quality, attributes parameters.
-     * @param params.tag - Defines tag that can be used in detect faces processing. Defaults to `null`.
-     */
-    constructor(
-        image: string,
-        config: DetectFacesConfig,
-        params?: {
-            tag?: string,
-        }
-    )
-
-    /**
-     * Creates a request to check all the available quality characteristics.
-     * 
-     * @param image - Image base64.
-     */
-    static qualityFull(image: string): DetectFacesRequest
-
-    /**
-     * Creates a request to check the quality characteristics based on the ICAO standard.
-     * 
-     * @param image - Image base64.
-     */
-    static qualityICAO(image: string): DetectFacesRequest
-
-    /**
-     * Creates a request to check the quality characteristics based on the Schengen visa standard.
-     * 
-     * @param image - Image base64.
-     */
-    static qualityVisaSchengen(image: string): DetectFacesRequest
-
-    /**
-     * Creates a request to check the quality characteristics based on the USA visa standard.
-     * 
-     * @param image - Image base64.
-     */
-    static qualityVisaUSA(image: string): DetectFacesRequest
-
-    /**
-     * Creates a request for a cropped portrait of the person whose face is the most central.
-     * 
-     * @param image - Image base64.
-     */
-    static cropCentralFace(image: string): DetectFacesRequest
-
-    /**
-     * Creates a request for cropped portraits of all the people in the image.
-     * 
-     * @param image - Image base64.
-     */
-    static cropAllFaces(image: string): DetectFacesRequest
-
-    /**
-     * Creates a request for a cropped portrait of the person whose face is the most central in the image in the original size.
-     * 
-     * @param image - Image base64.
-     */
-    static thumbnail(image: string): DetectFacesRequest
-
-    /**
-     * Creates a request for all available attribute results.
-     * 
-     * @param image - Image base64.
-     */
-    static allAttributes(image: string): DetectFacesRequest
-}

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

@@ -1,12 +0,0 @@
-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

@@ -1,10 +0,0 @@
-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

@@ -1,39 +0,0 @@
-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
-    /**
-     * Android only.
-     */
-    cameraPositionAndroid?: number
-    /**
-     * IOS only.
-     */
-    cameraPositionIOS: CameraPosition
-    /**
-     * Android only.
-     */
-    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

@@ -1,17 +0,0 @@
-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

@@ -1,39 +0,0 @@
-export class FaceCaptureImage {
-    get image(): string
-    get imageType(): ImageType
-    get tag(): string | null
-}
-
-/**
- * The image type of {@link FaceCaptureImage} influences matching results and provides the information about the source of the image.
- */
-export enum ImageType {
-    /**
-     * The image contains a printed portrait of a person.
-     */
-    PRINTED,
-    /**
-     * The image contains a portrait of a person and is taken from the RFID chip.
-     */
-    RFID,
-    /**
-     * The image is taken from the camera.
-     */
-    LIVE,
-    /**
-     * The image contains a document with a portrait of a person.
-     */
-    DOCUMENT_WITH_LIVE,
-    /**
-     * The image from an unknown source.
-     */
-    EXTERNAL,
-    /**
-     * The image is a ghost portrait.
-     */
-    GHOST_PORTRAIT,
-    /**
-     * The image from a barcode
-     */
-    BARCODE
-}

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

@@ -1,9 +0,0 @@
-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

@@ -1,49 +0,0 @@
-import { Size } from './size'
-
-/**
- * Crop settings for {@link OutputImageParams}.
- */
-export class OutputImageCrop {
-    /**
-     * The aspect ratio according to which alignment is performed.
-     */
-    get type(): OutputImageCropAspectRatio
-    /**
-     * The resize value to process.
-     * If the value doesn't match AspectRatio `type` proportion or minimum size, an adjustment is applied.
-     * Use {@link OutputImageCropAspectRatio} to check you size matches AspectRatio `type` proportions and minimum size.
-     */
-    get size(): Size | null
-    /**
-     * When an image is aligned by `type`, its original size may be insufficient, and in this case it needs to be supplemented, "padded".
-     * padColor sets the value for the color that will be used for such a supplement.
-     */
-    get padColor(): number | null
-
-    /**
-     * If set, the coordinates of the rectangle with the face in the original image prepared for the face crop
-     * are returned in the {@link DetectFaceResult.originalRect} field.
-     * Default is `false`.
-     */
-    get returnOriginalRect(): boolean
-
-    constructor(
-        type: OutputImageCropAspectRatio,
-        params?: {
-            size?: Size,
-            padColor?: number,
-            returnOriginalRect?: boolean,
-        }
-    )
-}
-
-/**
- * The AspectRatio according to which alignment is performed
- */
-export enum OutputImageCropAspectRatio {
-    RATIO_3X4,
-    RATIO_4X5,
-    RATIO_2X3,
-    RATIO_1X1,
-    RATIO_7X9
-}

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

@@ -1,28 +0,0 @@
-import { OutputImageCrop } from './output_image_crop'
-
-/**
- * Set of parameter for image processing.
- */
-export class OutputImageParams {
-    /**
-     * If set, aligned and cropped portrait is returned in the crop field.
-     * Alignment is performed according to type.
-     * If a head on the original image is tilted, for the returned portrait it is aligned in a straight vertical line.
-     * 
-     * If there are more than one face in the photo, all the faces will be detected and processed, and separate portraits for each face will be returned.
-     * So, if there were five people in the photo, you'll get five processed portraits.
-     */
-    get crop(): OutputImageCrop | null
-    /**
-     * If set, the background color is replaced.
-     * The silhouette of a person is cut out and the background is filled with this color.
-     */
-    get backgroundColor(): number | null
-
-    constructor(
-        params?: {
-            crop?: OutputImageCrop,
-            backgroundColor?: number,
-        }
-    )
-}

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

@@ -1,9 +0,0 @@
-/**
- * Point class represents a two number X, Y value.
- */
-export class Point {
-    get x(): number
-    get y(): number
-
-    private constructor()
-}

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

@@ -1,8 +0,0 @@
-export class Rect {
-    get left(): number
-    get top(): number
-    get right(): number
-    get bottom(): number
-
-    private constructor()
-}

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

@@ -1,6 +0,0 @@
-export class Size {
-    get width(): number
-    get height(): number
-
-    constructor(width: number, height: number)
-}

package/www/types/image_quality/image_quality_characteristic.d.ts

@@ -1,7 +0,0 @@
-/**
- * Image Quality parameter to include in {@link DetectFacesConfig} as {@link DetectFacesConfig.customQuality}.
- */
-export class ImageQualityCharacteristic {
-    withCustomRange(min: number, max: number): ImageQualityCharacteristic
-    withCustomValue(value: number): ImageQualityCharacteristic
-}

package/www/types/image_quality/image_quality_characteristic_name.d.ts

@@ -1,61 +0,0 @@
-/**
- * Image Quality Characteristic Name.
- */
-export enum ImageQualityCharacteristicName {
-    IMAGE_WIDTH,
-    IMAGE_HEIGHT,
-    IMAGE_WIDTH_TO_HEIGHT,
-    IMAGE_CHANNELS_NUMBER,
-    ART_FACE,
-    PADDING_RATIO,
-    FACE_MID_POINT_HORIZONTAL_POSITION,
-    FACE_MID_POINT_VERTICAL_POSITION,
-    HEAD_WIDTH_RATIO,
-    HEAD_HEIGHT_RATIO,
-    EYES_DISTANCE,
-    YAW,
-    PITCH,
-    ROLL,
-    BLUR_LEVEL,
-    NOISE_LEVEL,
-    UNNATURAL_SKIN_TONE,
-    FACE_DYNAMIC_RANGE,
-    EYE_RIGHT_CLOSED,
-    EYE_LEFT_CLOSED,
-    EYE_RIGHT_OCCLUDED,
-    EYE_LEFT_OCCLUDED,
-    EYES_RED,
-    EYE_RIGHT_COVERED_WITH_HAIR,
-    EYE_LEFT_COVERED_WITH_HAIR,
-    OFF_GAZE,
-    TOO_DARK,
-    TOO_LIGHT,
-    FACE_GLARE,
-    SHADOWS_ON_FACE,
-    SHOULDERS_POSE,
-    EXPRESSION_LEVEL,
-    MOUTH_OPEN,
-    SMILE,
-    DARK_GLASSES,
-    REFLECTION_ON_GLASSES,
-    FRAMES_TOO_HEAVY,
-    FACE_OCCLUDED,
-    HEAD_COVERING,
-    FOREHEAD_COVERING,
-    STRONG_MAKEUP,
-    HEAD_PHONES,
-    MEDICAL_MASK,
-    BACKGROUND_UNIFORMITY,
-    SHADOWS_ON_BACKGROUND,
-    OTHER_FACES,
-    BACKGROUND_COLOR_MATCH,
-    UNKNOWN,
-    IMAGE_CHARACTERISTIC_ALL_RECOMMENDED,
-    HEAD_SIZE_AND_POSITION_ALL_RECOMMENDED,
-    FACE_IMAGE_QUALITY_ALL_RECOMMENDED,
-    EYES_CHARACTERISTICS_ALL_RECOMMENDED,
-    SHADOW_AND_LIGHTING_ALL_RECOMMENDED,
-    POSE_AND_EXPRESSION_ALL_RECOMMENDED,
-    HEAD_OCCLUSION_ALL_RECOMMENDED,
-    QUALITY_BACKGROUND_ALL_RECOMMENDED
-}