@getyoti/react-face-capture 0.3.1 → 0.4.0

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # CHANGELOG
 
+## v0.4.0
+
+### New features
+
+- implemented Face capture module vanilla, to run our module without react stack application
+- implemented brightness validation to stop images too dark or too bright
+- Implemented localisation languages
+  - `cs`: Czech
+  - `da`: Danish
+  - `de`: German
+  - `fi`: Finnish
+  - `hi`: Hindi
+  - `it`: Italian
+  - `ja`: Japanese
+  - `nb`: Norwegian
+  - `nl`: Dutch
+  - `pl`: Polish
+  - `pt`: Portuguese
+  - `ro`: Romanian
+  - `ru`: Russian
+  - `sv`: Swedish
+  - `th`: Thai
+  - `tr`: Turkish
+  - `vi`: Vietnamese
+
 ## v0.3.1
 
 ### New features

package/README.md

@@ -1,4 +1,4 @@
-# React Face capture integration
+# Yoti Face capture integration
 
 The purpose of this module is to capture a face and return the output image.
 
@@ -19,12 +19,12 @@ The package depends on the following peer dependencies
 
 | Browser | Versions                      |
 | ------- | ----------------------------- |
-| and_chr | 91                            |
-| chrome  | 91,90,89,88                   |
-| edge    | 91,90                         |
-| firefox | 89,88,87,86                   |
-| ios_saf | 14.5-14.6,14.0-14.4,13.4-13.7 |
-| safari  | 14.1,14,13.1,13               |
+| and_chr | 96                            |
+| chrome  | 96,95,94,93                   |
+| edge    | 96,95                         |
+| firefox | 95,94,93,92                   |
+| ios_saf | 15.0-15.1,14.5-14.8,14.0-14.4 |
+| safari  | 15.1,15,14.1,14               |
 
 </browserSupportTable>
 
@@ -84,11 +84,26 @@ new CopyPlugin([
 Current languages supported:
 
 - `en`: English
+- `cs`: Czech
+- `da`: Danish
+- `de`: German
 - `es`: Spanish (Spain)
 - `es-419`: Spanish (Latin America)
-- `it`: Italian
-- `de`: German
+- `fi`: Finnish
 - `fr`: French
+- `hi`: Hindi
+- `it`: Italian
+- `ja`: Japanese
+- `nb`: Norwegian
+- `nl`: Dutch
+- `pl`: Polish
+- `pt`: Portuguese
+- `ro`: Romanian
+- `ru`: Russian
+- `sv`: Swedish
+- `th`: Thai
+- `tr`: Turkish
+- `vi`: Vietnamese
 
 ### Language fallback
 
@@ -129,3 +144,44 @@ export function App() {
   return <FaceCapture onSuccess={onSuccess} onError={onError} />;
 }
 ```
+
+## Face capture module vanilla
+
+If you do not have a react tech stack, you can use the face capture vanilla version.
+When you install the library on your machine, It's located inside the folder `vanilla`.
+
+Add the package in your codebase and serve the static assets:
+
+### 1. serve package static assets
+
+```bash
+
+/@getyoti/react-face-capture/vanilla/assets/face-capture/
+/@getyoti/react-face-capture/vanilla/index.css
+/@getyoti/react-face-capture/vanilla/index.js
+```
+
+### 2. Add Face capture script and style
+
+Inside the page you want to have face capture, add Face capture scripts and style like in the example below.
+`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/`.
+
+### 3. Render face capture
+
+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.
+
+**index.html**
+
+```html
+<link href="/@getyoti/react-face-capture/vanilla/index.css" />
+<script src="/@getyoti/react-face-capture/vanilla/index.js" />
+<script>
+  const props = {
+    faceCaptureAssetsRootUrl: '/@getyoti/react-face-capture/vanilla/assets/';
+  };
+
+  Yoti.FaceCaptureModule.render(props, document.getElementById('face-capture-module-root'));
+</script>
+
+<div id="face-capture-module-root"></div>
+```