@regulaforensics/vp-frontend-document-components 7.2.1592-nightly → 7.2.1595-nightly

package/README.md

@@ -259,7 +259,7 @@ After adding `DocumentReaderService` to the global variable, you can change the
 | **respectImageQuality**        | When enabled, image quality checks status affects document optical and overall status.                                                                                                                                                                                                                                                                                                                                                |  boolean  |                    `false`                    |                                                                                                                                                                                                                                                                  `true`, `false`                                                                                                                                                                                                                                                                  |                                                                                                  
 | **forceDocFormat**             | Force use of specified document format when locating and recognizing document to reduce the number of candidates.                                                                                                                                                                                                                                                                                                                     |  number   |                                               | `0` - ID1 document format, `1` - ID2 document format, `2` - ID3 document format, `3` - Undefined document format, `4` - A4 document format, `5` - ID3 double document format, `10` - ID1 format document rotated 90°, `11` - ID1 format document rotated 180°, `12` - ID1 format document rotated 270°, `13` - ID2 format document rotated 90°, `14` - ID3 format document rotated 180°, `1000` - Arbitrary format, `1002` - Flexible format. Standard formats can be resized during cropping, depending on various factors: light, background... |                                                                                                  
 | **noGraphics**                 | When enabled, no graphic fields will be cropped from document image.                                                                                                                                                                                                                                                                                                                                                                  |  boolean  |                    `false`                    |                                                                                                                                                                                                                                                                  `true`, `false`                                                                                                                                                                                                                                                                  |                                                                                                  
-| **documentAreaMin**            | Specifies minimal area of the image that document should cover to be treated as candidate when locating. Value should be in range from 0 to 1, where 1 is when document should fully cover the image.                                                                                                                                                                                                                                 |  number   |                       0                       |                                                                                                                                                                                                                                                                       0 - 1                                                                                                                                                                                                                                                                       |                                                                                                  
+| **documentAreaMin**            | Specifies minimal area of the image that document should cover to be treated as candidate when locating. Value should be in range from 0 to 100, where 100 is when document should fully cover the image.                                                                                                                                                                                                                             |  number   |                       0                       |                                                                                                                                                                                                                                                                      0 - 100                                                                                                                                                                                                                                                                      |                                                                                                  
 | **depersonalizeLog**           | When enabled, all personal data will be forcibly removed from the logs.                                                                                                                                                                                                                                                                                                                                                               |  boolean  |                    `false`                    |                                                                                                                                                                                                                                                                  `true`, `false`                                                                                                                                                                                                                                                                  |                                                                                                  
 | **multiDocOnImage**            | This option allows locating and cropping multiple documents from one image if enabled.                                                                                                                                                                                                                                                                                                                                                |  boolean  |                    `false`                    |                                                                                                                                                                                                                                                                  `true`, `false`                                                                                                                                                                                                                                                                  |                                                                                                  
 | **shiftExpiryDate**            | This option allows shifting the date of expiry into the future or past for number of months specified. This is useful, for example, in some cases when document might be still valid for some period after original expiration date to prevent negative validity status for such documents. Or by shifting the date to the past will set negative validity for the documents that is about to expire in a specified number of months. |  number   |                       0                       |                                                                                                                                                                                                                                                                    numbers > 0                                                                                                                                                                                                                                                                    |                                                                                                  
@@ -1405,6 +1405,10 @@ The Document Reader web components are also available on <a href="https://storyb
 Logging can be helpful when you run into any issues.
 Logs contain information about how you use our products. That data helps Regula stuff to analyze and troubleshoot the cases you may experience.
 
+There are two ways to output logs: console or function callback.
+
+#### Console
+
 To initiate the process of logs collecting:
 
 **1.** Open the Developer menu in your browser.
@@ -1419,7 +1423,7 @@ localStorage.logger = 'main,wasm>console'
 
 **4.** Reload the page.
 
-**5.** Add the `log` setting to the `processParam`:
+**5.** Add the `log` setting to the `processParam` if you want to see logs from WASM:
 
 ```json
 {
@@ -1430,3 +1434,31 @@ localStorage.logger = 'main,wasm>console'
 ```
 
 **6.** Start image processing. Logs will be displayed in Console.
+
+#### Function callback
+
+**1.** Import logging service from library.
+
+```javascript
+import { Logger } from '@regulaforensics/vp-frontend-document-components';
+```
+
+**2.** Set the callback function.
+
+```javascript
+Logger.logListener = (log) => {
+    // ...
+    // do something with log
+    // ...
+};
+```
+
+**3.** Add the `log` setting to the `processParam` if you want to see logs from WASM:
+
+```json
+{
+  "processParam": {
+    "log": true
+  }
+}
+```