🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more →
@getyoti/react-face-capture
Advanced tools
@getyoti/react-face-capture - npm Package Compare versions
Comparing version 2.3.1 to 2.3.2
| # CHANGELOG | ||
| ## v2.3.2 | ||
| ### New features | ||
| - Add the new _experimental_ property `isScoPortraitCamera` to adapt the module | ||
| to camera streams with a portrait resolution in SCO (self-checkout) machines. | ||
| ## v2.3.1 | ||
@@ -4,0 +11,0 @@ |
@@ -259,2 +259,6 @@ declare module '@getyoti/react-face-capture' { | ||
| numStableFrames?: number; | ||
| /** Defines if the FCM should adapt to a camera stream with portrait | ||
| * resolution in a SCO (self-checkout) machine. (default:false) | ||
| * @experimental*/ | ||
| isScoPortraitCamera?: boolean; | ||
| } | ||
@@ -261,0 +265,0 @@ |
| { | ||
| "name": "@getyoti/react-face-capture", | ||
| "version": "2.3.1", | ||
| "version": "2.3.2", | ||
| "description": "Face capture module to collect picture and data for Yoti AI API", | ||
@@ -5,0 +5,0 @@ "main": "index.js", |
@@ -27,8 +27,8 @@ # Yoti Face Capture integration | ||
| | ------- | ------------------- | | ||
| | and_chr | 127 | | ||
| | chrome | 127,126,125,124 | | ||
| | edge | 127,126 | | ||
| | firefox | 129,128,127,126 | | ||
| | ios_saf | 17.5,17.4,17.3 | | ||
| | safari | 17.5,17.4,17.3,17.2 | | ||
| | and_chr | 128 | | ||
| | chrome | 128,127,126,125 | | ||
| | edge | 128,127 | | ||
| | firefox | 130,129,128,127 | | ||
| | ios_saf | 17.6,17.5,17.4 | | ||
| | safari | 17.6,17.5,17.4,17.3 | | ||
@@ -107,29 +107,30 @@ </browserSupportTable> | ||
| | Property name | Type | Default | Mandatory | Description | | ||
| | ------------------------ | ------------------------------------- | ---------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | captureMethod | String `manual/auto` | `auto` | - | Capture method to take the photo: by clicking a button or auto-capture. | | ||
| | manualCaptureFallback | Boolean | `true` | - | In `auto` capture method, allow the use of `manual` capture mode as fallback. This would be triggered only when low performance conditions are detected, usually on very old devices. NOTE: If this option is turned off, some users might not be able to successfully submit an image. | | ||
| | secure | Boolean | `true` | - | Use the [secure mode](#secure-mode) | | ||
| | clientSdkId | String | - | Yes\* | Identifies your Yoti Hub application. This value can be found in the Hub, within your application section, in the keys tab. | | ||
| | onSuccess | Function(payload, base64PreviewImage) | - | Yes | Callback called once the result (payload) is complete. The content of capture will vary when using secure or non-secure mode (See [secure mode section](#secure-mode)). The second argument `base64PreviewImage` will only be provided if `returnPreviewImage` is set to `true`. | | ||
| | onError | Function | - | - | Callback called when there is an error. See Appendix for the list of error codes we currently support. | | ||
| | onReadyForCapture | Function | - | - | Callback called when the Face Capture is ready to take images (camera feed and face scan are ready). | | ||
| | showOverlay | Boolean | `true` | - | Optional use of the face overlay. | | ||
| | resolutionType | String `hd/full_hd` | `hd` | - | Image resolution constraints passed to `getUserMedia`. | | ||
| | format | String `jpeg/png` | `jpeg` | - | Image format type. | | ||
| | imageType | String `original/cropped` | `original` | - | Selects if the image will be the original or it will be cropped in order to improve the timing response when processing the image in the API call. | | ||
| | qualityType | String `high/medium/low` | `high` | - | Sets the image quality of jpeg format images only. High (1) - Medium (0.96) - Low (0.90). | | ||
| | language | Language code \*\* | `en` | - | The language code to set the Face Capture language. | | ||
| | a11yLiveRegionMode | String `assertive/polite` | `polite` | - | Determines the [politeness setting of the live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Live_Regions#live_regions) used to read out prompts for screen reader users | | ||
| | showInitialGuidance | Boolean | `true` | - | Show the initial help guidance. | | ||
| | faceCaptureAssetsRootUrl | String | `assets/face-capture/` | - | Root url where the face detection assets are located. See [copy assets](#copy-assets) section for assets configuration. | | ||
| | loadTimeout | Number | 15000 milliseconds | - | Sets the time (ms) the Face Capture will use to notify through the `onError` callback about downloading taking too long. The Face Capture will keep downloading after the notification. | | ||
| | showGetHelpButton | Boolean | `true` | - | Show the Get Help button. | | ||
| | autoSessionReload | Boolean | `true` | - | Automatically renews sessions after they expire. | | ||
| | userRetryError | Boolean | `true` | - | Gives the possibility to users to retry several times when an error occurs. | | ||
| | returnPreviewImage | Boolean | `false` | - | Provide the image captured (`base64PreviewImage`) in the `onSuccess` callback. | | ||
| | encryptImage | Boolean | `true` | - | Encrypt the image inside the payload argument on the `onSuccess` callback when it runs the secure mode. | | ||
| | allowBackgroundFaces | Boolean | `false` | - | Allows faces to be present in the background when the image is being captured. The face capture will return a cropped image with the main face when set to `true`. Note: This feature is designed for retail terminals and unsuitable for online user's face capture. | | ||
| | faceSelectionMethod | String `center/area` | `center` | - | Defines where the main face can be placed, in the center or anywhere in the image. Note: This feature is designed for retail terminals and unsuitable for online user's face capture. It is recommend to enable `allowBackgroundFaces` when `faceSelectionMethod` is set to `area`. | | ||
| | numStableFrames | Number | 4 | - | Determines how many frames are used for the stability check. The minimum value is 3 and the maximum is 6. | | ||
| | Property name | Type | Default | Mandatory | Description | | ||
| | ------------------------------------ | ------------------------------------- | ---------------------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | captureMethod | String `manual/auto` | `auto` | - | Capture method to take the photo: by clicking a button or auto-capture. | | ||
| | manualCaptureFallback | Boolean | `true` | - | In `auto` capture method, allow the use of `manual` capture mode as fallback. This would be triggered only when low performance conditions are detected, usually on very old devices. NOTE: If this option is turned off, some users might not be able to successfully submit an image. | | ||
| | secure | Boolean | `true` | - | Use the [secure mode](#secure-mode) | | ||
| | clientSdkId | String | - | Yes\* | Identifies your Yoti Hub application. This value can be found in the Hub, within your application section, in the keys tab. | | ||
| | onSuccess | Function(payload, base64PreviewImage) | - | Yes | Callback called once the result (payload) is complete. The content of capture will vary when using secure or non-secure mode (See [secure mode section](#secure-mode)). The second argument `base64PreviewImage` will only be provided if `returnPreviewImage` is set to `true`. | | ||
| | onError | Function | - | - | Callback called when there is an error. See Appendix for the list of error codes we currently support. | | ||
| | onReadyForCapture | Function | - | - | Callback called when the Face Capture is ready to take images (camera feed and face scan are ready). | | ||
| | showOverlay | Boolean | `true` | - | Optional use of the face overlay. | | ||
| | resolutionType | String `hd/full_hd` | `hd` | - | Image resolution constraints passed to `getUserMedia`. | | ||
| | format | String `jpeg/png` | `jpeg` | - | Image format type. | | ||
| | imageType | String `original/cropped` | `original` | - | Selects if the image will be the original or it will be cropped in order to improve the timing response when processing the image in the API call. | | ||
| | qualityType | String `high/medium/low` | `high` | - | Sets the image quality of jpeg format images only. High (1) - Medium (0.96) - Low (0.90). | | ||
| | language | Language code \*\* | `en` | - | The language code to set the Face Capture language. | | ||
| | a11yLiveRegionMode | String `assertive/polite` | `polite` | - | Determines the [politeness setting of the live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Live_Regions#live_regions) used to read out prompts for screen reader users | | ||
| | showInitialGuidance | Boolean | `true` | - | Show the initial help guidance. | | ||
| | faceCaptureAssetsRootUrl | String | `assets/face-capture/` | - | Root url where the face detection assets are located. See [copy assets](#copy-assets) section for assets configuration. | | ||
| | loadTimeout | Number | 15000 milliseconds | - | Sets the time (ms) the Face Capture will use to notify through the `onError` callback about downloading taking too long. The Face Capture will keep downloading after the notification. | | ||
| | showGetHelpButton | Boolean | `true` | - | Show the Get Help button. | | ||
| | autoSessionReload | Boolean | `true` | - | Automatically renews sessions after they expire. | | ||
| | userRetryError | Boolean | `true` | - | Gives the possibility to users to retry several times when an error occurs. | | ||
| | returnPreviewImage | Boolean | `false` | - | Provide the image captured (`base64PreviewImage`) in the `onSuccess` callback. | | ||
| | encryptImage | Boolean | `true` | - | Encrypt the image inside the payload argument on the `onSuccess` callback when it runs the secure mode. | | ||
| | allowBackgroundFaces | Boolean | `false` | - | Allows faces to be present in the background when the image is being captured. The face capture will return a cropped image with the main face when set to `true`. Note: This feature is designed for retail terminals and unsuitable for online user's face capture. | | ||
| | faceSelectionMethod | String `center/area` | `center` | - | Defines where the main face can be placed, in the center or anywhere in the image. Note: This feature is designed for retail terminals and unsuitable for online user's face capture. It is recommend to enable `allowBackgroundFaces` when `faceSelectionMethod` is set to `area`. | | ||
| | numStableFrames | Number | 4 | - | Determines how many frames are used for the stability check. The minimum value is 3 and the maximum is 6. | | ||
| | isScoPortraitCamera _(experimental)_ | Boolean | `false` | - | Defines if the FCM should adapt to a camera stream with portrait resolution in a SCO (self-checkout) machine. This property won't rotate your camera stream but adapt the module to a portrait resolution. This property is meant for SCO machines only and shouldn't be used on mobile phone integrations. | | ||
@@ -136,0 +137,0 @@ **(\*)** |
@@ -110,3 +110,3 @@ Name: react | ||
| Name: @getyoti/react-face-capture | ||
| Version: 2.3.1 | ||
| Version: 2.3.2 | ||
| License: Yoti Face Capture Licence | ||
@@ -113,0 +113,0 @@ Private: false |
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
No alert changes
Improved metrics
- Number of lines in readme file
361
0.28%Worsened metrics
- Total package byte prevSize
10316883
-0.05%- Lines of code
11674
-0.04%No dependency changes