@regulaforensics/vp-frontend-face-components 6.3.1408-nightly → 6.3.1410-rc

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/README.md +23 -39
  2. package/dist/main.iife.js +1082 -21
  3. package/{dist → lib}/index.d.ts +238 -219
  4. package/package.json +3 -3
package/README.md CHANGED
@@ -10,7 +10,6 @@
10
10
  - [Events](#events)
11
11
  - [Response](#response)
12
12
  - [Custom Translations](#custom-translations)
13
- - [Package Resources](#package-resources)
14
13
  - [Examples](#examples)
15
14
  - [Licensing](#licensing)
16
15
  - [Additional Resources](#additional-resources)
@@ -135,7 +134,6 @@ component.settings = {
135
134
  tag: 'sessionIdValue',
136
135
  retryCount: 5,
137
136
  recordingProcess: 1,
138
- workerPath: 'https://your-worker-path.com',
139
137
  customization: {
140
138
  fontFamily: 'Noto Sans, sans-serif',
141
139
  fontSize: '16px',
@@ -209,37 +207,35 @@ Here are all the available settings:
209
207
  | `holdStillDuration` | For the Capture screen, sets the duration that the user needs to stand straight and look in the camera. | `number` | `undefined` | seconds | `face-capture` |
210
208
  | `timeoutInterval` | Timeout for the Capture screen. | `number` | `undefined` | seconds | `face-capture` |
211
209
  | `livenessType` | You can choose a scenario for the liveness assessment. `0` - active liveness, full process that requires head rotation; `1` - passive liveness, a person is asked to only take a selfie, no head rotation required. | `number` | `0` | `0`, `1` | `face-liveness` |
212
- | `workerPath` | The URL with path to your worker file. | `string` | `unique regula wasm url` | your URL to worker | `face-liveness`, `face-capture` |
213
- | `detectOcclusion` | Whether to disable face occlusion hint. | `boolean` | `true` | `true`, `false` | `face-capture` |
214
210
 
215
211
  ## Customization
216
212
 
217
213
  You can customize the color of some elements, fonts, and images with the help of the `customization` field in the `settings` object. The customization settings are the following:
218
214
 
219
- | Setting | Info | Migrate from | Data type | Default value |
220
- |:---------------------------------------------|:------------------------------------------------------------------------|-------------------------|:-------------------------------:|:-----------------------:|
221
- | `fontFamily` | Font. | `--font-family` | string | `Noto Sans, sans-serif` |
222
- | `fontSize` | Base font size. | `--font-size` | string | `16px` |
223
- | `onboardingScreenStartButtonBackground` | Instruction screen button background color. | `--main-color` | string | `#7E57C5` |
224
- | `onboardingScreenStartButtonBackgroundHover` | Instruction screen button background hover color. | `--hover-color` | string | `#7C45B4` |
225
- | `onboardingScreenStartButtonTitle` | Instruction screen button text color. | | string | `#FFFFFF` |
226
- | `onboardingScreenStartButtonTitleHover` | Instruction screen button text hover color. | | string | `#FFFFFF` |
227
- | `onboardingScreenIllumination` | Instruction screen "Illumination" icon image. | | base64 or url or imported image | `` |
228
- | `onboardingScreenAccessories` | Instruction screen "No accessories" icon image. | | base64 or url or imported image | `` |
229
- | `onboardingScreenCameraLevel` | Instruction screen "Camera level" icon image. | | base64 or url or imported image | `` |
230
- | `cameraScreenFrontHintLabelBackground` | Сamera screen plate with info message background color. | `--plate-color` | string | `#E8E8E8` |
231
- | `cameraScreenFrontHintLabelText` | Сamera screen plate with info message text color. | | string | `#000000` |
215
+ | Setting | Info | Migrate from | Data type | Default value |
216
+ |:---------------------------------------------|:-----------------------------------------------------------------------------|-------------------------|:-------------------------------:|:-----------------------:|
217
+ | `fontFamily` | Font. | `--font-family` | string | `Noto Sans, sans-serif` |
218
+ | `fontSize` | Base font size. | `--font-size` | string | `16px` |
219
+ | `onboardingScreenStartButtonBackground` | Instruction screen button background color. | `--main-color` | string | `#7E57C5` |
220
+ | `onboardingScreenStartButtonBackgroundHover` | Instruction screen button background hover color. | `--hover-color` | string | `#7C45B4` |
221
+ | `onboardingScreenStartButtonTitle` | Instruction screen button text color. | | string | `#FFFFFF` |
222
+ | `onboardingScreenStartButtonTitleHover` | Instruction screen button text hover color. | | string | `#FFFFFF` |
223
+ | `onboardingScreenIllumination` | Instruction screen "Illumination" icon image. | | base64 or url or imported image | `` |
224
+ | `onboardingScreenAccessories` | Instruction screen "No accessories" icon image. | | base64 or url or imported image | `` |
225
+ | `onboardingScreenCameraLevel` | Instruction screen "Camera level" icon image. | | base64 or url or imported image | `` |
226
+ | `cameraScreenFrontHintLabelBackground` | Сamera screen plate with info message background color. | `--plate-color` | string | `#E8E8E8` |
227
+ | `cameraScreenFrontHintLabelText` | Сamera screen plate with info message text color. | | string | `#000000` |
232
228
  | `cameraScreenSectorActive` | User progress sector color (available only in face-liveness component). | | string | `#7E57C5` |
233
- | `cameraScreenSectorTarget` | Target sector color (available only in face-liveness component). | `--target-sector-color` | string | `#BEABE2` |
234
- | `cameraScreenStrokeNormal` | Stroke color of the camera circle. | | string | `#7E57C5` |
235
- | `processingScreenProgress` | Processing screen spinner color. | | string | `#7E57C5` |
236
- | `retryScreenEnvironmentImage` | Retry screen environment image. | | base64 or url or imported image | `` |
237
- | `retryScreenPersonImage` | Retry screen person image. | | base64 or url or imported image | `` |
238
- | `retryScreenRetryButtonBackground` | Retry screen button background color. | `--main-color` | string | `#7E57C5` |
239
- | `retryScreenRetryButtonBackgroundHover` | Retry screen button background hover color. | `--hover-color` | string | `#7C45B4` |
240
- | `retryScreenRetryButtonTitle` | Retry screen button text color. | | string | `#FFFFFF` |
241
- | `retryScreenRetryButtonTitleHover` | Retry screen button text hover color. | | string | `#FFFFFF` |
242
- | `successScreenImage` | Success screen image. | | base64 or url or imported image | `` |
229
+ | `cameraScreenSectorTarget` | Target sector color (available only in face-liveness component). | `--target-sector-color` | string | `#BEABE2` |
230
+ | `cameraScreenStrokeNormal` | Stroke color of the camera circle. | | string | `#7E57C5` |
231
+ | `processingScreenProgress` | Processing screen spinner color. | | string | `#7E57C5` |
232
+ | `retryScreenEnvironmentImage` | Retry screen environment image. | | base64 or url or imported image | `` |
233
+ | `retryScreenPersonImage` | Retry screen person image. | | base64 or url or imported image | `` |
234
+ | `retryScreenRetryButtonBackground` | Retry screen button background color. | `--main-color` | string | `#7E57C5` |
235
+ | `retryScreenRetryButtonBackgroundHover` | Retry screen button background hover color. | `--hover-color` | string | `#7C45B4` |
236
+ | `retryScreenRetryButtonTitle` | Retry screen button text color. | | string | `#FFFFFF` |
237
+ | `retryScreenRetryButtonTitleHover` | Retry screen button text hover color. | | string | `#FFFFFF` |
238
+ | `successScreenImage` | Success screen image. | | base64 or url or imported image | `` |
243
239
 
244
240
  For example:
245
241
 
@@ -662,18 +658,6 @@ The list of labels used in the component:
662
658
  | **cameraLevel** | Camera at eye level. | `face-liveness`, `face-capture` |
663
659
  | **noAccessories** | No accessories: glasses, mask, hat, etc. | `face-liveness`, `face-capture` |
664
660
  | **getReady** | Get ready | `face-liveness`, `face-capture` |
665
- | **removeOcclusion** | Remove items covering your face | `face-liveness`, `face-capture` |
666
-
667
- ## Package Resources
668
-
669
- Face web components requires WASM (`Liveness.wasm`, `Liveness.data`) and worker (`Liveness.worker.js`) files to work.
670
- By default, these files are downloaded from Regula servers, but you can set your own source.
671
-
672
- **1.** To download these files from our server to local machine, you can get path from `webComponent.settings.workerPath` field after initialization. To see the file you should concat path and name of the file (`workerParh + '/Liveness.worker.js'`)
673
- **2.** Upload all three files (`Liveness.worker.js`, `Liveness.wasm`, `Liveness.data`) to the location you specified.
674
- **3.** Set your URL to `workerPath` to `settings` (see Settings section).
675
-
676
- **Attention!** The files must be located in the same directory and have the same names as were previously specified.
677
661
 
678
662
  ## Examples
679
663