@ahmed_hani/dot-auto-capture-ui 7.4.0 → 7.6.1
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.
- package/README.md +29 -7
- package/document.mjs +607 -584
- package/document.umd.js +35 -24
- package/face.mjs +410 -379
- package/face.umd.js +28 -17
- package/magnifeye-liveness.mjs +457 -430
- package/magnifeye-liveness.umd.js +36 -26
- package/multi-range-liveness.mjs +2953 -0
- package/multi-range-liveness.umd.js +257 -0
- package/package.json +14 -9
- package/palm.mjs +750 -687
- package/palm.umd.js +36 -25
- package/smile-liveness.mjs +584 -558
- package/smile-liveness.umd.js +44 -33
- package/ui/src/types/multi-range.d.ts +28 -0
- package/ui/src/types/palm.d.ts +2 -1
- package/ui-common/src/types/common.d.ts +14 -4
- package/ui-common/src/types/events/common.d.ts +41 -0
- package/ui-common/src/types/events/index.d.ts +1 -0
- package/ui-common/src/types/events/multi-range.d.ts +16 -0
- package/ui-common/src/types/eye-gaze.d.ts +1 -0
- package/ui-common/src/types/index.d.ts +1 -0
- package/ui-common/src/types/magnifeye.d.ts +1 -0
- package/ui-common/src/types/multi-range.d.ts +37 -0
- package/ui-common/src/types/smile.d.ts +1 -0
- package/tsconfig.production.json +0 -22
package/README.md
CHANGED
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
Innovatrics Auto Capture UI Component. Does not work as a standalone component. Recommended to be used with:
|
|
5
5
|
- [Face Auto Capture Component](https://www.npmjs.com/package/@innovatrics/dot-face-auto-capture)
|
|
6
6
|
- [Document Auto Capture Component](https://www.npmjs.com/package/@innovatrics/dot-document-auto-capture)
|
|
7
|
+
- [Multi-Range Liveness Component](https://www.npmjs.com/package/@innovatrics/dot-multi-range-liveness)
|
|
7
8
|
- [MagnifEye Liveness Component](https://www.npmjs.com/package/@innovatrics/dot-magnifeye-liveness)
|
|
8
9
|
- [Smile Liveness Component](https://www.npmjs.com/package/@innovatrics/dot-smile-liveness)
|
|
9
10
|
- [Palm Capture Component](https://www.npmjs.com/package/@innovatrics/dot-palm-capture)
|
|
@@ -11,11 +12,11 @@ Innovatrics Auto Capture UI Component. Does not work as a standalone component.
|
|
|
11
12
|
Innovatrics Auto Capture UI Component is a web component that renders an overlay over the video stream. The overlay includes a placeholder, camera control buttons and instructions to guide the user to position their face, their palm or their ID document correctly.
|
|
12
13
|
|
|
13
14
|
<p align="center">
|
|
14
|
-
<img alt="Face Auto Capture" src="https://www.innovatrics.com/wp-content/uploads/2024/03/Passive-Liveness-preview-400px.gif">
|
|
15
|
-
<img alt="Document Auto Capture" src="https://www.innovatrics.com/wp-content/uploads/2024/03/Onboarding-document-scanning-400px.gif">
|
|
16
|
-
<img alt="MagnifEye Liveness" src="https://www.innovatrics.com/wp-content/uploads/2024/03/MagnifEye_liveness-preview-400px.gif">
|
|
17
|
-
<img alt="Smile Liveness" src="https://www.innovatrics.com/wp-content/uploads/2024/03/Smile-liveness-preview-400px.gif">
|
|
18
|
-
|
|
15
|
+
<img alt="Face Auto Capture" src="https://www.innovatrics.com/wp-content/uploads/2024/03/Passive-Liveness-preview-400px.gif" width="200" height="400">
|
|
16
|
+
<img alt="Document Auto Capture" src="https://www.innovatrics.com/wp-content/uploads/2024/03/Onboarding-document-scanning-400px.gif" width="200" height="400">
|
|
17
|
+
<img alt="MagnifEye Liveness" src="https://www.innovatrics.com/wp-content/uploads/2024/03/MagnifEye_liveness-preview-400px.gif" width="200" height="400">
|
|
18
|
+
<img alt="Smile Liveness" src="https://www.innovatrics.com/wp-content/uploads/2024/03/Smile-liveness-preview-400px.gif" width="200" height="400">
|
|
19
|
+
<img alt="Palm Auto Capture" src="https://www.innovatrics.com/wp-content/uploads/2025/03/palm.gif" width="200" height="400">
|
|
19
20
|
</p>
|
|
20
21
|
|
|
21
22
|
The Auto Capture UI Component can be used alongside other components to develop remote identity verification or digital onboarding solutions, as demonstrated in this [demo application](https://dot.innovatrics.com/).
|
|
@@ -27,7 +28,7 @@ You can also check out the [integration samples](https://github.com/innovatrics/
|
|
|
27
28
|
1. **Core Components**
|
|
28
29
|
|
|
29
30
|
**IMPORTANT**: For this component to work, it is highly recommended to be used along with
|
|
30
|
-
[Face Auto Capture Component](https://www.npmjs.com/package/@innovatrics/dot-face-auto-capture), [Document Auto Capture Component](https://www.npmjs.com/package/@innovatrics/dot-document-auto-capture), [MagnifEye Liveness Component](https://www.npmjs.com/package/@innovatrics/dot-magnifeye-liveness), [Smile Liveness Component](https://www.npmjs.com/package/@innovatrics/dot-smile-liveness) or [Palm Capture Component](https://www.npmjs.com/package/@innovatrics/dot-palm-capture) installed in your project. You can learn more about why this is important on our [developers portal](https://developers.innovatrics.com/digital-onboarding/technical/remote/dot-web-document/latest/documentation/#_introduction).
|
|
31
|
+
[Face Auto Capture Component](https://www.npmjs.com/package/@innovatrics/dot-face-auto-capture), [Document Auto Capture Component](https://www.npmjs.com/package/@innovatrics/dot-document-auto-capture), [Multi-Range Liveness Component](https://www.npmjs.com/package/@innovatrics/dot-multi-range-liveness), [MagnifEye Liveness Component](https://www.npmjs.com/package/@innovatrics/dot-magnifeye-liveness), [Smile Liveness Component](https://www.npmjs.com/package/@innovatrics/dot-smile-liveness) or [Palm Capture Component](https://www.npmjs.com/package/@innovatrics/dot-palm-capture) installed in your project. You can learn more about why this is important on our [developers portal](https://developers.innovatrics.com/digital-onboarding/technical/remote/dot-web-document/latest/documentation/#_introduction).
|
|
31
32
|
|
|
32
33
|
**Integration with** [Face Auto Capture Component](https://www.npmjs.com/package/@innovatrics/dot-face-auto-capture):
|
|
33
34
|
|
|
@@ -61,6 +62,24 @@ Both components must be wrapped in parent div with `position: relative`.
|
|
|
61
62
|
|
|
62
63
|
Or you can see an example in [documentation](https://developers.innovatrics.com/digital-onboarding/technical/remote/dot-web-document/latest/documentation/#_example_of_using_components_together)
|
|
63
64
|
|
|
65
|
+
**Integration with** [Multi-Range Liveness Component](https://www.npmjs.com/package/@innovatrics/dot-multi-range-liveness):
|
|
66
|
+
|
|
67
|
+
Both components must be wrapped in parent div with `position: relative` and `overflow: hidden`.
|
|
68
|
+
|
|
69
|
+
``` typescript
|
|
70
|
+
<div style={{position: "relative", overflow: "hidden"}}>
|
|
71
|
+
<MultiRangeLiveness
|
|
72
|
+
onComplete={handleOnComplete}
|
|
73
|
+
onError={handleError}
|
|
74
|
+
challengeSequence={["ONE", "THREE", "FIVE", "ZERO"]} // Challenge needs to be obtained from the API call to the Digital Identity Service
|
|
75
|
+
transactionCountingToken="provide-the-token-here"
|
|
76
|
+
/>
|
|
77
|
+
<MultiRangeLivenessUi showCameraButtons/>
|
|
78
|
+
</div>
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
Or you can see an example in [documentation](https://developers.innovatrics.com/digital-onboarding/technical/remote/dot-web-multi-range-liveness/latest/documentation/#_example_of_using_components_together)
|
|
82
|
+
|
|
64
83
|
**Integration with** [MagnifEye Liveness Component](https://www.npmjs.com/package/@innovatrics/dot-magnifeye-liveness):
|
|
65
84
|
|
|
66
85
|
Both components must be wrapped in parent div with `position: relative` and `overflow: hidden`.
|
|
@@ -109,6 +128,7 @@ Both components must be wrapped in parent div with `position: relative`.
|
|
|
109
128
|
|
|
110
129
|
Or you can see an example in [documentation](https://developers.innovatrics.com/digital-onboarding/technical/remote/dot-web-palm/latest/documentation/#_example_of_using_components_together)
|
|
111
130
|
|
|
131
|
+
|
|
112
132
|
## Installation
|
|
113
133
|
|
|
114
134
|
Installation of the package is available via NPM, PNPM or Yarn:
|
|
@@ -141,13 +161,15 @@ Head to our [developers portal](https://developers.innovatrics.com/digital-onboa
|
|
|
141
161
|
- Usage with TypeScript
|
|
142
162
|
- Properties
|
|
143
163
|
- Custom events - communication between the Auto Capture UI Component and the [Face Auto Capture Component](https://www.npmjs.com/package/@innovatrics/dot-face-auto-capture) or the [Document Auto Capture Component](https://www.npmjs.com/package/@innovatrics/dot-document-auto-capture)
|
|
144
|
-
- Examples of using the Auto Capture UI Component and the [Face Auto Capture Component](https://www.npmjs.com/package/@innovatrics/dot-face-auto-capture), the [Document Auto Capture Component](https://www.npmjs.com/package/@innovatrics/dot-document-auto-capture), the [MagnifEye Liveness Component](https://www.npmjs.com/package/@innovatrics/dot-magnifeye-liveness)
|
|
164
|
+
- Examples of using the Auto Capture UI Component and the [Face Auto Capture Component](https://www.npmjs.com/package/@innovatrics/dot-face-auto-capture), the [Document Auto Capture Component](https://www.npmjs.com/package/@innovatrics/dot-document-auto-capture), the [Multi-Range Liveness Component](https://www.npmjs.com/package/@innovatrics/dot-multi-range-liveness), the [MagnifEye Liveness Component](https://www.npmjs.com/package/@innovatrics/dot-magnifeye-liveness), the [Smile Liveness Component](https://www.npmjs.com/package/@innovatrics/dot-smile-liveness) or the [Palm Capture Component](https://www.npmjs.com/package/@innovatrics/dot-palm-capture) together
|
|
145
165
|
|
|
146
166
|
## Changelog
|
|
147
167
|
Face Auto Capture Component changelog [here](https://developers.innovatrics.com/digital-onboarding/technical/remote/dot-web-face/latest/documentation/#_changelog).
|
|
148
168
|
|
|
149
169
|
Document Auto Capture Component changelog [here](https://developers.innovatrics.com/digital-onboarding/technical/remote/dot-web-document/latest/documentation/#_changelog).
|
|
150
170
|
|
|
171
|
+
Multi-Range Liveness Component changelog [here](https://developers.innovatrics.com/digital-onboarding/technical/remote/dot-multi-range-liveness/latest/documentation/#_changelog).
|
|
172
|
+
|
|
151
173
|
MagnifEye Liveness Component changelog [here](https://developers.innovatrics.com/digital-onboarding/technical/remote/dot-web-magnifeye-liveness/latest/documentation/#_changelog).
|
|
152
174
|
|
|
153
175
|
Smile Liveness Component changelog [here](https://developers.innovatrics.com/digital-onboarding/technical/remote/dot-web-smile-liveness/latest/documentation/#_changelog).
|