@getyoti/react-face-capture 0.3.1 → 0.6.0
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/CHANGELOG.md +45 -0
- package/README.md +73 -9
- package/index.js +1 -1
- package/package.json +4 -6
- package/vanilla/assets/face-capture/tiny_face_detector_model-shard1 +0 -0
- package/vanilla/assets/face-capture/tiny_face_detector_model-weights_manifest.json +197 -0
- package/vanilla/index.css +1 -0
- package/vanilla/index.js +3 -0
- package/vanilla/index.js.LICENSE.txt +34 -0
- package/vanilla/index.js.map +1 -0
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,50 @@
|
|
|
1
1
|
# CHANGELOG
|
|
2
2
|
|
|
3
|
+
## v0.6.0
|
|
4
|
+
|
|
5
|
+
### New features
|
|
6
|
+
|
|
7
|
+
- Implemented localisation languages
|
|
8
|
+
- `ar`: Arabic
|
|
9
|
+
- `lv`: Latvian
|
|
10
|
+
|
|
11
|
+
## v0.5.0
|
|
12
|
+
|
|
13
|
+
### New features
|
|
14
|
+
|
|
15
|
+
- Implemented localisation languages
|
|
16
|
+
- `et`: Estonian
|
|
17
|
+
- `id`: Bahasa
|
|
18
|
+
- `ko`: Korean
|
|
19
|
+
- `lt`: Lithuanian
|
|
20
|
+
- `ms`: Malay
|
|
21
|
+
- `uk`: Ukranian
|
|
22
|
+
|
|
23
|
+
## v0.4.0
|
|
24
|
+
|
|
25
|
+
### New features
|
|
26
|
+
|
|
27
|
+
- Implemented Face capture module vanilla, to run our module without react stack application
|
|
28
|
+
- Implemented brightness validation to stop images too dark or too bright
|
|
29
|
+
- Implemented localisation languages
|
|
30
|
+
- `cs`: Czech
|
|
31
|
+
- `da`: Danish
|
|
32
|
+
- `de`: German
|
|
33
|
+
- `fi`: Finnish
|
|
34
|
+
- `hi`: Hindi
|
|
35
|
+
- `it`: Italian
|
|
36
|
+
- `ja`: Japanese
|
|
37
|
+
- `nb`: Norwegian
|
|
38
|
+
- `nl`: Dutch
|
|
39
|
+
- `pl`: Polish
|
|
40
|
+
- `pt`: Portuguese
|
|
41
|
+
- `ro`: Romanian
|
|
42
|
+
- `ru`: Russian
|
|
43
|
+
- `sv`: Swedish
|
|
44
|
+
- `th`: Thai
|
|
45
|
+
- `tr`: Turkish
|
|
46
|
+
- `vi`: Vietnamese
|
|
47
|
+
|
|
3
48
|
## v0.3.1
|
|
4
49
|
|
|
5
50
|
### New features
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Yoti Face capture integration
|
|
2
2
|
|
|
3
3
|
The purpose of this module is to capture a face and return the output image.
|
|
4
4
|
|
|
@@ -19,12 +19,12 @@ The package depends on the following peer dependencies
|
|
|
19
19
|
|
|
20
20
|
| Browser | Versions |
|
|
21
21
|
| ------- | ----------------------------- |
|
|
22
|
-
| and_chr |
|
|
23
|
-
| chrome |
|
|
24
|
-
| edge |
|
|
25
|
-
| firefox |
|
|
26
|
-
| ios_saf | 14.5-14.
|
|
27
|
-
| safari |
|
|
22
|
+
| and_chr | 96 |
|
|
23
|
+
| chrome | 96,95,94,93 |
|
|
24
|
+
| edge | 96,95 |
|
|
25
|
+
| firefox | 95,94,93,92 |
|
|
26
|
+
| ios_saf | 15.0-15.1,14.5-14.8,14.0-14.4 |
|
|
27
|
+
| safari | 15.1,15,14.1,14 |
|
|
28
28
|
|
|
29
29
|
</browserSupportTable>
|
|
30
30
|
|
|
@@ -84,11 +84,34 @@ new CopyPlugin([
|
|
|
84
84
|
Current languages supported:
|
|
85
85
|
|
|
86
86
|
- `en`: English
|
|
87
|
+
- `ar`: Arabic
|
|
88
|
+
- `cs`: Czech
|
|
89
|
+
- `da`: Danish
|
|
90
|
+
- `de`: German
|
|
87
91
|
- `es`: Spanish (Spain)
|
|
88
92
|
- `es-419`: Spanish (Latin America)
|
|
89
|
-
- `
|
|
90
|
-
- `
|
|
93
|
+
- `et`: Estonian
|
|
94
|
+
- `fi`: Finnish
|
|
91
95
|
- `fr`: French
|
|
96
|
+
- `hi`: Hindi
|
|
97
|
+
- `id`: Bahasa
|
|
98
|
+
- `it`: Italian
|
|
99
|
+
- `ja`: Japanese
|
|
100
|
+
- `ko`: Korean
|
|
101
|
+
- `lt`: Lithuanian
|
|
102
|
+
- `lv`: Latvian
|
|
103
|
+
- `ms`: Malay
|
|
104
|
+
- `nb`: Norwegian
|
|
105
|
+
- `nl`: Dutch
|
|
106
|
+
- `pl`: Polish
|
|
107
|
+
- `pt`: Portuguese
|
|
108
|
+
- `ro`: Romanian
|
|
109
|
+
- `ru`: Russian
|
|
110
|
+
- `sv`: Swedish
|
|
111
|
+
- `th`: Thai
|
|
112
|
+
- `tr`: Turkish
|
|
113
|
+
- `uk`: Ukranian
|
|
114
|
+
- `vi`: Vietnamese
|
|
92
115
|
|
|
93
116
|
### Language fallback
|
|
94
117
|
|
|
@@ -129,3 +152,44 @@ export function App() {
|
|
|
129
152
|
return <FaceCapture onSuccess={onSuccess} onError={onError} />;
|
|
130
153
|
}
|
|
131
154
|
```
|
|
155
|
+
|
|
156
|
+
## Face capture module vanilla
|
|
157
|
+
|
|
158
|
+
If you do not have a react tech stack, you can use the face capture vanilla version.
|
|
159
|
+
When you install the library on your machine, It's located inside the folder `vanilla`.
|
|
160
|
+
|
|
161
|
+
Add the package in your codebase and serve the static assets:
|
|
162
|
+
|
|
163
|
+
### 1. serve package static assets
|
|
164
|
+
|
|
165
|
+
```bash
|
|
166
|
+
|
|
167
|
+
/@getyoti/react-face-capture/vanilla/assets/face-capture/
|
|
168
|
+
/@getyoti/react-face-capture/vanilla/index.css
|
|
169
|
+
/@getyoti/react-face-capture/vanilla/index.js
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
### 2. Add Face capture script and style
|
|
173
|
+
|
|
174
|
+
Inside the page you want to have face capture, add Face capture scripts and style like in the example below.
|
|
175
|
+
`faceCaptureAssetsRootUrl` is property you can use to instruct the library where neural net files are served otherwise we look the files relative to the page location `assets/face-capture/`.
|
|
176
|
+
|
|
177
|
+
### 3. Render face capture
|
|
178
|
+
|
|
179
|
+
Our scripts will give you access to `Yoti.FaceCaptureModule.render` you can pass 2 parameters, first parameters are the props and are the same used in react integration and second parameter you need a html DOM reference so we know where we can render the UI.
|
|
180
|
+
|
|
181
|
+
**index.html**
|
|
182
|
+
|
|
183
|
+
```html
|
|
184
|
+
<link href="/@getyoti/react-face-capture/vanilla/index.css" />
|
|
185
|
+
<script src="/@getyoti/react-face-capture/vanilla/index.js" />
|
|
186
|
+
<script>
|
|
187
|
+
const props = {
|
|
188
|
+
faceCaptureAssetsRootUrl: '/@getyoti/react-face-capture/vanilla/assets/';
|
|
189
|
+
};
|
|
190
|
+
|
|
191
|
+
Yoti.FaceCaptureModule.render(props, document.getElementById('face-capture-module-root'));
|
|
192
|
+
</script>
|
|
193
|
+
|
|
194
|
+
<div id="face-capture-module-root"></div>
|
|
195
|
+
```
|