@regulaforensics/vp-frontend-document-components 2.2.0 → 2.3.0

package/README.md

@@ -213,25 +213,25 @@ The generated event object (```event.detail```) contains three fields that descr
 
 Type of actions:
 
-| Type of action               |        Description of the action         |        In which component is present         |
-|:-----------------------------|:----------------------------------------:|:--------------------------------------------:|
-| ```ELEMENT_VISIBLE```        |    Component is appended in the DOM.     | ```document-reader```, ```camera-snapshot``` |
-| ```PRESS_CAMERA_BUTTON```    |   The "From camera" button is pressed.   | ```document-reader```, ```camera-snapshot``` |
-| ```PRESS_FILE_BUTTON```      |  The "From gallery" button is pressed.   | ```document-reader```, ```camera-snapshot``` |
-| ```PRESS_RETRY_BUTTON```     |      The "Retry" button is pressed.      | ```document-reader```, ```camera-snapshot``` |
-| ```PRESS_SKIP_BUTTON```      |      The "Skip" button is pressed.       |            ```document-reader```             |
-| ```CLOSE```                  |      The "Close" button is pressed.      | ```document-reader```, ```camera-snapshot``` |
-| ```CAMERA_PROCESS_STARTED``` | Recognition from the camera has started. | ```document-reader```, ```camera-snapshot``` |
-| ```FILE_PROCESS_STARTED```   |       File processing has started.       | ```document-reader```, ```camera-snapshot``` |
-| ```PROCESS_FINISHED```       |   The component has finished its work.   | ```document-reader```, ```camera-snapshot``` |
-| ```SERVICE_INITIALIZED```    |   The component has started its work.    |            ```document-reader```             |
+| Type of action               |                     Description of the action                     |        In which component is present         |
+|:-----------------------------|:-----------------------------------------------------------------:|:--------------------------------------------:|
+| ```ELEMENT_VISIBLE```        |                 Component is appended in the DOM.                 | ```document-reader```, ```camera-snapshot``` |
+| ```PRESS_CAMERA_BUTTON```    |               The "From camera" button is pressed.                | ```document-reader```, ```camera-snapshot``` |
+| ```PRESS_FILE_BUTTON```      |               The "From gallery" button is pressed.               | ```document-reader```, ```camera-snapshot``` |
+| ```PRESS_RETRY_BUTTON```     |                  The "Retry" button is pressed.                   | ```document-reader```, ```camera-snapshot``` |
+| ```PRESS_SKIP_BUTTON```      |                   The "Skip" button is pressed.                   |            ```document-reader```             |
+| ```CLOSE```                  |                  The "Close" button is pressed.                   | ```document-reader```, ```camera-snapshot``` |
+| ```CAMERA_PROCESS_STARTED``` |             Recognition from the camera has started.              | ```document-reader```, ```camera-snapshot``` |
+| ```FILE_PROCESS_STARTED```   |                   File processing has started.                    | ```document-reader```, ```camera-snapshot``` |
+| ```PROCESS_FINISHED```       |               The component has finished its work.                | ```document-reader```, ```camera-snapshot``` |
+| ```SERVICE_INITIALIZED```    |                The component has started its work.                |            ```document-reader```             |
 
 In cases of successful operation of the components, the ```data``` field will contain the following fields:
 
 ```javascript
 {
   response: { ... }, // component result
-  status: 1 // 1 for successful work and 0 for unsuccessful
+  status: 1
 }
 ```
 
@@ -244,6 +244,14 @@ In cases of unsuccessful work, the ```data``` field will contain the following f
 }
 ```
 
+Description of statuses:
+
+| Status |     Description of the status      |
+|:-------|:----------------------------------:|
+| 0      |          Process failed.           |
+| 1      | Process is completed successfully. |
+| 2      |  Process is completed by timeout.  |
+
 Table of error causes:
 
 | Reason                         |      Description of the reason      |
@@ -426,6 +434,54 @@ For camera-snapshot:
 }
 ```
 
+</td>
+<td></td>
+</tr>
+<tr>
+<td>Recognition from the camera has started.</td>
+<td>
+
+For document-reader:  
+```document-reader```
+
+For camera-snapshot:  
+```camera-snapshot```
+
+</td>
+<td>
+
+```javascript
+{
+  action: "CAMERA_PROCESS_STARTED", 
+  data: null,
+  manual: true
+}
+```
+
+</td>
+<td></td>
+</tr>
+<tr>
+<td>File processing has started.</td>
+<td>
+
+For document-reader:  
+```document-reader```
+
+For camera-snapshot:  
+```camera-snapshot```
+
+</td>
+<td>
+
+```javascript
+{
+  action: "FILE_PROCESS_STARTED", 
+  data: null,
+  manual: true
+}
+```
+
 </td>
 <td></td>
 </tr>
@@ -457,6 +513,33 @@ For camera-snapshot:
 <td></td>
 </tr>
 <tr>
+<td>The work of the component is completed by timeout.</td>
+<td>
+
+```document-reader```
+
+</td>
+<td>
+
+```javascript
+{
+  action: "PROCESS_FINISHED", 
+  data: {
+    response: { ... },
+    status: 2
+  },
+  manual: false
+}
+```
+
+</td>
+<td>
+
+This event available only in ```document-reader```.
+
+</td>
+</tr>
+<tr>
 <td>The work of the component failed.</td>
 <td>