@regulaforensics/vp-frontend-document-components 7.5.1924-nightly → 7.5.1925-nightly

package/README.md

@@ -268,6 +268,7 @@ After adding `DocumentReaderService` to the global variable, you can change the
 | **scenario**                   | Recognition scenario.                                                                                                                                                                                                                                                                                                                                                                                                                 |  string   |                'MrzAndLocate'                 |                                                                                                                                                                                                                                                  'MrzAndLocate', 'MrzOrLocate', 'Mrz', 'Locate'                                                                                                                                                                                                                                                   |                                                                                                  
 | **multipageProcessing**        | Whether to enable 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                                                                                                                                                                                                                                                                    |                                                                                                  
+| **timeoutFromFirstDetect**     | Start the countdown from the moment the document is detected.                                                                                                                                                                                                                                                                                                                                                                         |  number   |                     5000                      |                                                                                                                                                                                                                                                                    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               |                                                                                                  
 | **returnPackageForReprocess**  | When enabled, returns the package for reprocessing on the backend.                                                                                                                                                                                                                                                                                                                                                                    |  boolean  |                    `false`                    |                                                                                                                                                                                                                                                                  `true`, `false`                                                                                                                                                                                                                                                                  |                                                                                                  
 | **imageQa**                    | When enabled, image quality checks status affects document optical and overall status.                                                                                                                                                                                                                                                                                                                                                |           |                                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                                                                  
@@ -1062,6 +1063,7 @@ You can send the results to the backend for further processing:
 ```javascript
 window.RegulaDocumentSDK.recognizerProcessParam = {
   processParam: {
+    scenario: InternalScenarios.MrzAndLocate,
     backendProcessing: {
       serviceURL: 'YOUR_SERVICE_URL',
       httpHeaders: {  // you can set http headers if necessary
@@ -1091,11 +1093,19 @@ For cases when user's main device lacks camera or does not succeed to scan with
 you have an option to delegate scanning to another available device (i.e. phone).
 
 #### 1. "From other phone" action may be configured on the start screen:
-- configure [backend reprocessing](#backend-reprocessing)
-- add 'delegateURL' and 'tag':
+- add 'delegateProcessing' and 'tag':
   ```javascript 
   processor.recognizerProcessParam = {
-    delegateURL: 'https://your-page.com?tag={tag}', // the page which will be used by other device
+    processParam: {
+      scenario: InternalScenarios.MrzAndLocate,
+    },
+    delegateProcessing: {
+      delegateURL: 'https://your-page.com?tag={tag}', // the page which will be used by other device
+      serviceURL: 'https://my-service.com', // your backend service
+      httpHeaders: { // http headers if needed
+        header: 'value'
+      }
+    },
     tag: 123 // your session id, will be added to delegateURL in place of {tag} substring
   }
   ```
@@ -1108,14 +1118,12 @@ you have an option to delegate scanning to another available device (i.e. phone)
 
 #### 2. Configure Delegate page component on delegateURL:
 - configure [backend reprocessing](#backend-reprocessing)
+- backendProcessing setting for the device and delegateProcessing setting for the main page must match
 - use the same tag as on the main page
    ```javascript 
-    window.RegulaDocumentSDK.recognizerProcessParam = {
-      tag: 123 // your session id, i.e. it can be extracted from your delegate page URL
-    };
-
     element.settings = {
       startScreen: false, // From camera recognition is expected
+      mobileDelegate: true
     }
     ```
 - use finalizePackage() to send the data for further reprocessing

package/dist/index.d.ts

@@ -231,6 +231,7 @@ export declare class DocumentReaderService {
     private _initializeListener;
     private _processingListener;
     private _queueService;
+    onFinalize: TOnFinalize | null;
     isAutoPrepare: boolean;
     isPrepared: boolean;
     isInitialized: boolean;
@@ -521,7 +522,11 @@ export declare interface PackageParams {
 
 export declare interface ProcessingRequest extends BaseRequest {
     metadata?: Record<string, any>;
-    delegateURL?: string;
+    delegateProcessing?: {
+        serviceURL: string;
+        delegateURL: string;
+        httpHeaders?: Record<string, string>;
+    };
     processParam: DocumentReaderProcessParam;
     imagesList?: Array<DocumentReaderImage>;
     imageInputParam?: ImageInputParamType;
@@ -550,6 +555,8 @@ declare type TInitializeListener = ({ isInitialized }: {
     isInitialized: boolean;
 }) => void;
 
+declare type TOnFinalize = (transaction: TransactionInfo) => void;
+
 declare type TPrepareListener = ({ isPrepared }: {
     isPrepared: boolean;
 }) => void;