@regulaforensics/vp-frontend-document-components 7.3.1696-rc → 7.3.1755-nightly

package/README.md

@@ -93,7 +93,7 @@ import { defineComponents, DocumentReaderService } from '@regulaforensics/vp-fro
 ```
 Without module bundler:
 ```javascript
-import { defineComponents, DocumentReaderService } from './node_modules/@regulaforensics/vp-frontend-document-components/esm/main.js';
+import { defineComponents, DocumentReaderService } from './node_modules/@regulaforensics/vp-frontend-document-components/dist/main.js';
 ```
 
 **Step 3.** Define the components, depending on the functionality that you need.
@@ -105,9 +105,20 @@ defineComponents();
 
 If you need the entire scope of functionality:
 
-**1.** Add `DocumentReaderService` to the global variable `RegulaDocumentSDK`:
+**1.** Add `DocumentReaderService` to the global variable `RegulaDocumentSDK` and set processing scenario:
 ```javascript
 window.RegulaDocumentSDK = new DocumentReaderService();
+
+window.RegulaDocumentSDK.recognizerProcessParam = {
+  processParam: {
+    scenario: 'MrzAndLocate',
+  },
+};
+window.RegulaDocumentSDK.imageProcessParam = {
+  processParam: {
+    scenario: 'MrzAndLocate',
+  },
+};
 ```
 **2.** Define the components and initialize the service:
 
@@ -148,7 +159,7 @@ Use the CDN link in a format as follows: `unpkg.com/:package@:version/:file`
 
 For example:
 ```html
-<script src="https://unpkg.com/@regulaforensics/vp-frontend-document-components@latest/dist/main.js"></script>
+<script src="https://unpkg.com/@regulaforensics/vp-frontend-document-components@latest/dist/main.iife.js"></script>
 ```
 
 **Note:** You can find all available script versions in the corresponding section of npm, using the same link from the previous example.
@@ -166,9 +177,20 @@ If you need the entire scope of functionality:
 ```javascript
 const { defineComponents, DocumentReaderService } = window.Regula;
 ```
-**2.** Add `DocumentReaderService` to the global variable `RegulaDocumentSDK`:
+**2.** Add `DocumentReaderService` to the global variable `RegulaDocumentSDK` and set processing scenario:
 ```javascript
 window.RegulaDocumentSDK = new DocumentReaderService();
+
+window.RegulaDocumentSDK.recognizerProcessParam = {
+  processParam: {
+    scenario: 'MrzAndLocate',
+  },
+};
+window.RegulaDocumentSDK.imageProcessParam = {
+  processParam: {
+    scenario: 'MrzAndLocate',
+  },
+};
 ```
 **3.** Define the components and initialize the service.
 
@@ -194,7 +216,6 @@ After adding `DocumentReaderService` to the global variable, you can change the
   window.RegulaDocumentSDK.recognizerProcessParam = {
     processParam: {
       returnUncroppedImage: true,
-      scenario: 'MrzAndLocate',
       multipageProcessing: false,
       returnPackageForReprocess: false,
       timeout: 20000,
@@ -216,7 +237,6 @@ After adding `DocumentReaderService` to the global variable, you can change the
   ```javascript
   window.RegulaDocumentSDK.imageProcessParam = {
     processParam: {
-      scenario: 'MrzAndLocate',
       returnUncroppedImage: true,
       returnPackageForReprocess: false,
     },
@@ -381,6 +401,7 @@ Available fields of `event.detail.data` object:
 | `FILE_SIZE`                | The file size is too large         |
 | `INCORRECT_FILE`           | Problems with reading the file     |
 | `INCORRECT_SCENARIO`       | Scenario is not supported          |
+| `MISSING_SCENARIO`         | Scenario is missing                |
 | `UNKNOWN_ERROR`            | Unknown error                      |
 | `NOT_SUPPORTED`            | The browser is not supported       |
 | `CAMERA_UNKNOWN_ERROR`     | Unknown camera error               |
@@ -862,20 +883,20 @@ There are two ways to define the element's settings: using the `settings` proper
 See the description and examples below.
 
 * Using `settings` property to configure element:
-  ```javascript
-  const element = document.createElement('document-reader');
-  
-  element.settings = {
-    startScreen: true,
-    internalScenario: 'Locate',
-    multipageProcessing: true,
-  };
-  ```
+```javascript
+const element = document.createElement('document-reader');
+
+element.settings = {
+  startScreen: true,
+  internalScenario: 'Locate',
+  multipageProcessing: true,
+};
+```
 
 * Using attributes to configure element:
-  ```javascript
-  <document-reader start-screen internal-scenario="Locate"></document-reader>
-  ```
+```javascript
+<document-reader start-screen internal-scenario="Locate"></document-reader>
+```
 
 We **recommend** using the `settings` property of the element to configure its parameters.
 This method gives more flexibility in setup, in addition, all new parameters in the future will be available **only** as the settings of the object (not as HTML attributes).
@@ -1074,7 +1095,7 @@ import { DocumentReaderProcessor } from '@regulaforensics/vp-frontend-document-c
 
 Without module bundler:
 ```javascript
-import { DocumentReaderProcessor } from '/node_modules/@regulaforensics/vp-frontend-document-components/esm/main.js';
+import { DocumentReaderProcessor } from '/node_modules/@regulaforensics/vp-frontend-document-components/dist/main.js';
 ```
    
 **Step 3.** Add a video tag to the `.html` file, then prepare and initialize `DocumentReaderProcessor`.
@@ -1083,6 +1104,17 @@ import { DocumentReaderProcessor } from '/node_modules/@regulaforensics/vp-front
 const videoElement = document.getElementById('yourVideoElement');
 const processor = new DocumentReaderProcessor(videoElement);
 
+processor.recognizerProcessParam = {
+  processParam: {
+    scenario: 'MrzAndLocate',
+  },
+};
+processor.imageProcessParam = {
+  processParam: {
+    scenario: 'MrzAndLocate',
+  },
+};
+
 try {
    // Variant 1 - for production environment 
    await processor.initialize(); 
@@ -1130,7 +1162,7 @@ Use the CDN link in a format as follows: `unpkg.com/:package@:version/:file`
 
 For example:
 ```html
-<script src="https://unpkg.com/@regulaforensics/vp-frontend-document-components@latest/dist/main.js"></script>
+<script src="https://unpkg.com/@regulaforensics/vp-frontend-document-components@latest/dist/main.iife.js"></script>
 ```
 
 **Note:** You can find all available script versions in the corresponding section of npm, using the same link from the previous example.
@@ -1140,26 +1172,37 @@ For example:
 `DocumentReaderProcessor` is available in the global variable `window.Regula`. See the following example:
  
  ```javascript
- const { DocumentReaderProcessor } = window.Regula;
- 
- const videoElement = document.getElementById('yourVideoElement');
- const processor = new DocumentReaderProcessor(videoElement);
- 
- try {
-    // Variant 1 - for production environment 
-    await processor.initialize(); 
-    
-    // Variant 2 - for test-only environment 
-    // await processor.initialize({ license: 'BASE64_LICENSE_KEY' });  
- 
-    const result = await processor.startRecognition(); // Result of the document recognition will be located here.
- 
-    processor.stopRecognition();
- 
-    console.log(result);
- } catch (e) {
-    console.log(e);
- }
+const { DocumentReaderProcessor } = window.Regula;
+
+const videoElement = document.getElementById('yourVideoElement');
+const processor = new DocumentReaderProcessor(videoElement);
+
+processor.recognizerProcessParam = {
+  processParam: {
+    scenario: 'MrzAndLocate',
+  },
+};
+processor.imageProcessParam = {
+  processParam: {
+    scenario: 'MrzAndLocate',
+  },
+};
+
+try {
+  // Variant 1 - for production environment 
+  await processor.initialize(); 
+  
+  // Variant 2 - for test-only environment 
+  // await processor.initialize({ license: 'BASE64_LICENSE_KEY' });  
+
+  const result = await processor.startRecognition(); // Result of the document recognition will be located here.
+
+  processor.stopRecognition();
+
+  console.log(result);
+} catch (e) {
+  console.log(e);
+}
  ```
      
 In the preceding example, the `DocumentReaderProcessor` object is created using the HTML element with ID `yourVideoElement`. 
@@ -1288,7 +1331,6 @@ The parameters for recognizing a document from the camera (by the `startRecognit
 ```javascript
 processor.recognizerProcessParam = {
    processParam: {
-      scenario: 'MrzAndLocate',
       returnUncroppedImage: true,
       returnPackageForReprocess: false,
    },
@@ -1306,7 +1348,6 @@ See the following example with several parameters and their default values:
 // Default settings:
 processor.imageProcessParam = {
    processParam: {
-      scenario: 'MrzAndLocate',
       returnUncroppedImage: true,
       returnPackageForReprocess: false,
    },