@regulaforensics/vp-frontend-document-components 2.0.1 → 2.1.0

package/README.md

@@ -4,6 +4,7 @@
 3. [UI components](#ui-components)
    * [Integration via NPM](#integration-via-npm)
    * [Integration via CDN](#integration-via-cdn)
+   * [Settings](#settings)
    * [Events](#events)
    * [Response](#response)
    * [Attributes](#attributes)
@@ -105,6 +106,60 @@ Add the component name to the ```.html``` file. The available components are:
 
 Notice: To use ```<document-reader></document-reader>``` component on test environments, set the base64 license value to the ```license``` attribute. Example: ```<document-reader license="BASE64_LICENSE_KEY"></document-reader>```.
 
+### Settings
+
+After adding ```DocumentReaderService``` to the global variable, you can change the default document recognition settings:
+
+```javascript
+// Default settings for video capture (From camera button):
+window.RegulaDocumentSDK.recognizerProcessParam = {
+   processParam: {
+      returnUncroppedImage: true,
+      scenario: 'MrzAndLocate',
+      multipageProcessing: false,
+      returnPackagesForReprocess: false,
+      timeout: 20000,
+      resultTypeOutput: [],
+      imageQa: {
+         expectedPass: ['dpiThreshold', 'glaresCheck', 'focusCheck'],
+         dpiThreshold: 130,
+         glaresCheck: true,
+         glaresCheckParams: {
+            imgMarginPart: 0.05,
+            maxGlaringPart: 0.01,
+         },
+      },
+   },
+};
+
+// Default settings for image processing (From gallery button):
+window.RegulaDocumentSDK.imageProcessParam = {
+   processParam: {
+      scenario: 'MrzAndLocate',
+      returnUncroppedImage: true,
+      returnPackagesForReprocess: false,
+   },
+};
+```
+
+## Descriptions of settings
+
+| Setting                        | Info                                                                                                                                                      | Data type |                 Default value                 |                                                                                                                                                                                                                                                                                                 Values                                                                                                                                                                                                                                                                                                 |
+|:-------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------|:---------:|:---------------------------------------------:|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
+| **returnUncroppedImage**       | When enabled, returns input images in output.                                                                                                             |  boolean  |                  ```true```                   |                                                                                                                                                                                                                                                                                        ```true```, ```false```                                                                                                                                                                                                                                                                                         |
+| **scenario**                   | Recognition scenario.                                                                                                                                     |  string   |              ```MrzAndLocate```               |                                                                                                                                                                                                                                                                 ```'MrzAndLocate'```, ```'MrzOrLocate'```, ```'Mrz'```, ```'Locate'```                                                                                                                                                                                                                                                                 |                                                                                                  
+| **multipageProcessing**        | Enables multi-page document processing mode.                                                                                                              |  boolean  |                  ```true```                   |                                                                                                                                                                                                                                                                                        ```true```, ```false```                                                                                                                                                                                                                                                                                         |                                                                                                  
+| **timeout**                    | Recognition timeout in milliseconds. After this time process will be finished.                                                                            |  number   |                     2000                      |                                                                                                                                                                                                                                                                                              numbers > 0                                                                                                                                                                                                                                                                                               |                                                                                                  
+| **resultTypeOutput**           | Types of results to return in response. [] - all available types.                                                                                         | number[]  |                      []                       | ```1``` - DocumentImageResult, ```3``` - TextDataResult, ```5``` - DocBarCodeInfo, ```6``` - GraphicsResult, ```8``` - DocumentTypesCandidatesResult, ```9``` - ChosenDocumentTypeResult, ```20``` - AuthenticityResult, ```15``` - LexicalAnalysisResult, ```17``` - TextDataResult, ```18``` - TextDataResult, ```19``` - GraphicsResult, ```30``` - ImageQualityResult, ```33``` - StatusResult, ```36``` - TextResult, ```37``` - ImagesResult, ```85``` - DocumentPositionResult, ```102``` - TextDataResult, ```103``` - GraphicsResult, ```50``` - LicenseResult, ```49``` - EncryptedRCLResult |                                                                                                  
+| **returnPackagesForReprocess** | Enable returning the package for reprocessing on the backend.                                                                                             |  boolean  |                  ```false```                  |                                                                                                                                                                                                                                                                                        ```true```, ```false```                                                                                                                                                                                                                                                                                         |                                                                                                  
+| **imageQa**                    | When enabled, image quality checks status affects document optical and overall status.                                                                    |           |                                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                                                                  
+| **expectedPass**               | Activated image quality checks.                                                                                                                           | string[]  | ['dpiThreshold', 'glaresCheck', 'focusCheck'] |                                                                                                                                                                                                                                                                        ```dpiThreshold```, ```glaresCheck```, ```focusCheck```                                                                                                                                                                                                                                                                         |                                                                                                  
+| **dpiThreshold**               | This parameter sets threshold for Image QA check of the presented document physical dpi. If actual document dpi is below this threshold, check will fail. |  number   |                      150                      |                                                                                                                                                                                                                                                                                              numbers > 0                                                                                                                                                                                                                                                                                               |                                                                                                  
+| **glaresCheck**                | This option enables glares check while performing image quality validation.                                                                               |  boolean  |                  ```true```                   |                                                                                                                                                                                                                                                                                        ```true```, ```false```                                                                                                                                                                                                                                                                                         |                                                                                                  
+| **glaresCheckParams**          | Settings for glare check.                                                                                                                                 |           |                                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                                                                  
+
+**Attention!** If the ```multipage-processing``` or ```internal-scenario``` attributes are set, the ```multipageProcessing``` and ```scenario``` settings will be ignored.
+
 ### Events
 
 You can subscribe to the component events.
@@ -664,40 +719,34 @@ processor.streamParam = {
 Sets the settings for recognizing a document from the camera (```startRecognition``` method):
 
 ```javascript
+// Default settings:
 processor.recognizerProcessParam = {
    processParam: {
-      returnUncroppedImage: true,      // When enabled, returns input images in output. Disabled by default.
-      scenario: 'MrzAndLocate',        // Recognition scenario. Can be 'MrzAndLocate', 'MrzOrLocate', 'Mrz', 'Locate'. By default 'MrzAndLocate'.
-      multipageProcessing: true,       // Enables multi-page document processing mode. By default false.
-      timeout: 20000,                  // Recognition timeout in milliseconds. After this time process will be finished. By default 20000.
-      resultTypeOutput: [],            // Types of results to return in response. By default [] - all available types.
-      imageQa: {                       // Quality checks.
-         expectedPass: ['dpiThreshold', 'glaresCheck'],
-         dpiThreshold: 130,
-         glaresCheck: true,
-         glaresCheckParams: {
-            imgMarginPart: 0.05,
-            maxGlaringPart: 0.01,
-         },
-      },
+      scenario: 'MrzAndLocate',
+      returnUncroppedImage: true,
+      returnPackagesForReprocess: false,
    },
-}
+};
 ```
+See the list of all available settings [here](#settings).
 
 #### imageProcessParam
 
 Sets the settings for recognizing a document as a file (```processImage``` method):
 
 ```javascript
+// Default settings:
 processor.imageProcessParam = {
    processParam: {
-      returnUncroppedImage: true,      // When enabled, returns input images in output. Disabled by default.
-      scenario: 'MrzAndLocate',        // Recognition scenario. Can be 'MrzAndLocate', 'MrzOrLocate', 'Mrz', 'Locate'. By default 'MrzAndLocate'.
-      resultTypeOutput: [],            // Types of results to return in response. By default [] - all available types.
+      scenario: 'MrzAndLocate',
+      returnUncroppedImage: true,
+      returnPackagesForReprocess: false,
    },
 }
 ```
 
+See the list of all available settings [here](#settings).
+
 #### recognizeListener
 
 Sets the callback function that takes in the processing result for each frame: