@regulaforensics/vp-frontend-face-components 2.0.0 → 2.0.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.
Files changed (33) hide show
  1. package/README.md +14 -2
  2. package/dist/main.js +1 -1
  3. package/dist/main.js.LICENSE.txt +10 -0
  4. package/lib/common/Button.d.ts +2 -2
  5. package/lib/common/Message.d.ts +2 -2
  6. package/lib/components/ButtonFaceLiveness.d.ts +2 -2
  7. package/lib/components/DocumentCapture.d.ts +2 -2
  8. package/lib/components/DocumentReaderLayout.d.ts +2 -2
  9. package/lib/components/ErrorBoundary.d.ts +4 -4
  10. package/lib/components/FaceCapture.d.ts +4 -4
  11. package/lib/components/FaceHintAnimaition.d.ts +2 -2
  12. package/lib/components/FaceLayout.d.ts +2 -2
  13. package/lib/components/InfoScreenFaceLiveness.d.ts +1 -1
  14. package/lib/components/SectorAnimationSvg.d.ts +2 -2
  15. package/lib/components/WebCamera.d.ts +2 -2
  16. package/lib/constants.d.ts +10 -28
  17. package/lib/contexts/DocumentAttributesContext.d.ts +2 -2
  18. package/lib/contexts/DocumentSDKContext.d.ts +2 -2
  19. package/lib/contexts/FaceAttributesContext.d.ts +3 -2
  20. package/lib/hoc/withDocumentAttributesContext.d.ts +2 -2
  21. package/lib/hoc/withDocumentSDKContext.d.ts +2 -2
  22. package/lib/hoc/withFaceAttributesContext.d.ts +2 -2
  23. package/lib/hoc/withLocalize.d.ts +2 -2
  24. package/lib/hooks/useDocumentReaderSeries.d.ts +1 -2
  25. package/lib/hooks/useDocumentReaderSingle.d.ts +1 -2
  26. package/lib/models/CustomError.d.ts +2 -2
  27. package/lib/services/DeviceOrientationService.d.ts +18 -0
  28. package/lib/services/DocumentReaderProcessor.d.ts +7 -14
  29. package/lib/services/DocumentReaderService.d.ts +23 -43
  30. package/lib/services/FaceLivenessService.d.ts +9 -1
  31. package/lib/services/FaceService.d.ts +9 -9
  32. package/lib/types.d.ts +4 -4
  33. package/package.json +1 -1
package/README.md CHANGED
@@ -81,7 +81,7 @@ Connect the script in your ```.html``` file. CDN link: ```unpkg.com/:package@:ve
81
81
  Example:
82
82
 
83
83
  ```html
84
- <script src="https://unpkg.com/@regulaforensics/vp-frontend-face-components@1.2.0/dist/main.js"></script>
84
+ <script src="https://unpkg.com/@regulaforensics/vp-frontend-face-components@2.0.0/dist/main.js"></script>
85
85
  ```
86
86
 
87
87
  Add the name of the component to the html, as in the example above.
@@ -405,8 +405,20 @@ function listener(event) {
405
405
  component.addEventListener('face-capture', listener);
406
406
  ```
407
407
 
408
- Please find ```face-liveness``` response structure in [OpenAPI documentation](https://dev.regulaforensics.com/FaceSDK-web-openapi/#tag/liveness-2.0/operation/get_liveness_transaction).
408
+ The ```face-liveness``` response has the following structure
409
409
 
410
+ ```javascript
411
+ {
412
+ code: number // Result codes from core lib
413
+ metadata: {
414
+ [key: string]: any
415
+ };
416
+ sessionId: string
417
+ status: number // liveness status
418
+ transactionId: string
419
+ images: string[] // array with the final image in base64
420
+ }
421
+ ````
410
422
 
411
423
  The ```face-capture``` response has the following structure
412
424