@regulaforensics/face-sdk 6.3.94-beta → 6.3.95-beta

package/examples/capacitor/package.json

@@ -15,7 +15,7 @@
     "lint": "eslint"
   },
   "dependencies": {
-    "@regulaforensics/face-sdk": "6.3.94-beta",
+    "@regulaforensics/face-sdk": "6.3.95-beta",
     "@regulaforensics/face-core-basic": "6.3.12-beta",
     "@awesome-cordova-plugins/camera": "6.6.0",
     "@awesome-cordova-plugins/file": "6.6.0",

package/examples/cordova/package.json

@@ -14,7 +14,7 @@
   "author": "Regula Forensics Inc.",
   "license": "commercial",
   "dependencies": {
-    "@regulaforensics/face-sdk": "6.3.94-beta",
+    "@regulaforensics/face-sdk": "6.3.95-beta",
     "@regulaforensics/face-core-basic": "6.3.12-beta",
     "cordova-android": "12.0.1",
     "cordova-ios": "7.0.1",

package/examples/ionic/package.json

@@ -16,7 +16,7 @@
   },
   "private": true,
   "dependencies": {
-    "@regulaforensics/face-sdk": "6.3.94-beta",
+    "@regulaforensics/face-sdk": "6.3.95-beta",
     "@regulaforensics/face-core-basic": "6.3.12-beta",
     "cordova-plugin-camera": "7.0.0",
     "@awesome-cordova-plugins/camera": "6.6.0",

package/examples/react-native/package.json

@@ -12,7 +12,7 @@
     "test": "jest"
   },
   "dependencies": {
-    "@regulaforensics/face-sdk": "6.3.94-beta",
+    "@regulaforensics/face-sdk": "6.3.95-beta",
     "@regulaforensics/face-core-basic": "6.3.12-beta",
     "react": "18.3.1",
     "react-native": "0.75.4",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@regulaforensics/face-sdk",
-  "version": "6.3.94-beta",
+  "version": "6.3.95-beta",
   "description": "This is an npm module for Regula Face SDK. It allows you to easily compaire faces using your phone's camera.",
   "main": "www/react-native/index.js",
   "module": "www/capacitor/index.js",

package/plugin.xml

@@ -1,5 +1,5 @@
 <?xml version='1.0' encoding='utf-8'?>
-<plugin id="@regulaforensics/face-sdk" version="6.3.94-beta" xmlns="http://apache.org/cordova/ns/plugins/1.0">
+<plugin id="@regulaforensics/face-sdk" version="6.3.95-beta" xmlns="http://apache.org/cordova/ns/plugins/1.0">
   <name>FaceSDK</name>
   <description>Cordova plugin for Regula Face SDK</description>
   <license>commercial</license>

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

@@ -1,4 +1,13 @@
+/** 
+ * Physical position of camera's hardware on the system. 
+ */ 
 export enum CameraPosition {
+    /** 
+     * The camera position corresponds to the front camera. 
+     */
     FRONT,
+    /** 
+     * The camera position corresponds to the back camera. 
+     */
     BACK,
 }

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

@@ -2,6 +2,9 @@ import { CustomizationColors } from './customization_colors'
 import { CustomizationFonts } from './customization_fonts'
 import { CustomizationImages } from './customization_images'
 
+/**  
+ * Params that relate to the camera view controller customization and etc. 
+ */
 export class Customization {
     get colors(): CustomizationColors
     set colors(val: CustomizationColors)
@@ -15,10 +18,26 @@ export class Customization {
     get uiCustomizationLayer(): Record<string, any> | null
     set uiCustomizationLayer(val: Record<string, any> | null)
 
+    /** 
+     * Set onClick listener for buttons from {@link uiCustomizationLayer}. 
+     */
     set onCustomButtonTapped(completion: CustomButtonTappedCompletion)
 
+    /** 
+     * Allows you to deserialize object. 
+     */
     static fromJson(jsonObject: Record<string, any>): Customization
+    /** 
+     * Allows you to serialize object. 
+     */
     toJson(): Record<string, any>
 }
 
+
+/**
+ * Callback for receiving signal, when a custom button,
+ * configured in {@link Customization.uiCustomizationLayer}, is pressed.
+ * 
+ * @param tag button id, indication which button was pressed.
+ */
 export type CustomButtonTappedCompletion = (tag: number) => void

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

@@ -26,6 +26,12 @@ export class CustomizationColors {
     set processingScreenTitleLabel(val: number)
     set successScreenBackground(val: number)
 
+    /** 
+     * Allows you to deserialize object. 
+     */
     static fromJson(jsonObject: Record<string, number>): CustomizationColors
+    /** 
+     * Allows you to serialize object. 
+     */
     toJson(): Record<string, number>
 }

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

@@ -12,6 +12,12 @@ export class CustomizationFonts {
     set retryScreenHintLabels(val: Font | null)
     set processingScreenLabel(val: Font | null)
 
+    /** 
+     * Allows you to deserialize object. 
+     */
     static fromJson(jsonObject: Record<string, any>): CustomizationFonts
+    /** 
+     * Allows you to serialize object. 
+     */
     toJson(): Record<string, any>
 }

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

@@ -13,6 +13,12 @@ export class CustomizationImages {
     set processingScreenCloseButton(val: string)
     set successScreenImage(val: string)
 
+    /** 
+     * Allows you to deserialize object. 
+     */
     static fromJson(jsonObject: Record<string, string>): CustomizationImages
+    /** 
+     * Allows you to serialize object. 
+     */
     toJson(): Record<string, string>
 }

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

@@ -1,6 +1,20 @@
 export class Font {
+    /**
+     * Font family.
+     * 
+     * Beware that Android and iOS have diffrent font names,
+     * so you will have to use if condition.
+     */
     get name(): string
+    /** 
+     * Font size. 
+     */
     get size(): number | null
+    /**
+     * Font style.
+     * 
+     * Android only.
+     */
     get style(): FontStyle | null
 
     constructor(
@@ -11,6 +25,9 @@ export class Font {
         }
     )
 
+    /** 
+     * Allows you to deserialize object. 
+     */
     static fromJson(jsonObject?: any): Font | null
 }
 

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

@@ -2,10 +2,28 @@ import { DetectFacesAttribute } from './detect_faces_attribute'
 import { ImageQualityCharacteristic } from '../image_quality/image_quality_characteristic'
 import { OutputImageParams } from '../image_params/output_image_params'
 
+/** 
+ * Custom configuration 
+ */
 export class DetectFacesConfig {
+    /**
+     * Current array for the face image detection attributes.
+     */
     attributes?: Array<DetectFacesAttribute>
+    /**
+     * Current array for the face image quality assessment rules.
+     */
     customQuality?: Array<ImageQualityCharacteristic>
+    /**
+     * If set the uploaded image is processed according to the indicated settings.
+     */
     outputImageParams?: OutputImageParams
+    /**
+     * Whether to process only the central face on the image or all the faces.
+     * If set to `true`, the SDK detects and processes only one—the most central face in the image.
+     * If set to `false`, the SDK processes all faces in the image.
+     * Default is `false`.
+     */
     onlyCentralFace: boolean
 
     constructor(

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

@@ -8,6 +8,9 @@ export class DetectFacesException {
     private constructor()
 }
 
+/**
+ * Error codes for the {@link DetectFacesResponse} errors.
+ */
 export enum DetectFacesErrorCode {
     IMAGE_EMPTY,
     FR_FACE_NOT_DETECTED,

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

@@ -1,6 +1,19 @@
 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,
@@ -9,19 +22,59 @@ export class DetectFacesRequest {
         }
     )
 
+    /**
+     * 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/face_capture/face_capture_config.d.ts

@@ -7,8 +7,17 @@ export class FaceCaptureConfig {
     closeButtonEnabled: boolean
     torchButtonEnabled: boolean
     vibrateOnSteps: boolean
+    /**
+     * Android only.
+     */
     cameraPositionAndroid?: number
+    /**
+     * IOS only.
+     */
     cameraPositionIOS: CameraPosition
+    /**
+     * Android only.
+     */
     screenOrientation?: Array<ScreenOrientation>
     timeout?: number
     holdStillDuration?: number

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

@@ -4,12 +4,36 @@ export class FaceCaptureImage {
     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/image_params/output_image_crop.d.ts

@@ -1,9 +1,30 @@
 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(
@@ -16,6 +37,9 @@ export class OutputImageCrop {
     )
 }
 
+/**
+ * The AspectRatio according to which alignment is performed
+ */
 export enum OutputImageCropAspectRatio {
     RATIO_3X4,
     RATIO_4X5,

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

@@ -1,7 +1,22 @@
 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(

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

@@ -1,3 +1,6 @@
+/**
+ * Point class represents a two number X, Y value.
+ */
 export class Point {
     get x(): number
     get y(): number

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

@@ -1,3 +1,6 @@
+/**
+ * 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,3 +1,6 @@
+/**
+ * Image Quality Characteristic Name.
+ */
 export enum ImageQualityCharacteristicName {
     IMAGE_WIDTH,
     IMAGE_HEIGHT,