@regulaforensics/vp-frontend-document-components 7.5.1958-nightly → 7.5.1961-nightly

package/README.md

@@ -298,7 +298,7 @@ After adding `DocumentReaderService` to the global variable, you can change the
 | **forceReadMrzBeforeLocate**   | When enabled, make sure that in series processing MRZ is located fully inside the result document image, if present on the document. Enabling this option may add extra processing time, by disabling optimizations, but allows more stability in output image quality.                                                                                                                                                               |  boolean  |                    `false`                    |                                                                                                                                                                                                                                                                  `true`, `false`                                                                                                                                                                                                                                                                  |                                                                                                  
 | **parseBarcodes**              | This option can be disabled to stop parsing after barcode is read.                                                                                                                                                                                                                                                                                                                                                                    |  boolean  |                    `true`                     |                                                                                                                                                                                                                                                                  `true`, `false`                                                                                                                                                                                                                                                                  |                                                                                                  
 | **splitNames**                 | When enabled, the Surname and GivenNames fields will be divided into ft_First_Name, ft_Second_Name, ft_Third_Name, ft_Fourth_Name, ft_Last_Name fields.                                                                                                                                                                                                                                                                               |  boolean  |                    `false`                    |                                                                                                                                                                                                                                                                  `true`, `false`                                                                                                                                                                                                                                                                  |                                                                                                  
-| **backendProcessing**          | When enabled, it prepares the processing result to be sent to the backend for re-processing. Use ```service.finalizePackage();``` after receiving the processing results to send them to the backend.                                                                                                                                                                                                                                 |  Object   |                      {}                       |                                                                                                                                                                                                                   { serviceURL: 'URL', httpHeaders: { key1: 'header1', key2: 'header2', ... }, timeoutConnection: number > 0 }                                                                                                                                                                                                                    |                                                                                                  
+| **backendProcessing**          | When enabled, it prepares the processing result to be sent to the backend for re-processing. Use ```service.finalizePackage();``` after receiving the processing results to send them to the backend.                                                                                                                                                                                                                                 |  Object   |                      {}                       |                                                                                                                                                                                                                                   { serviceURL: 'URL', httpHeaders: { key1: 'header1', key2: 'header2', ... } }                                                                                                                                                                                                                                   |                                                                                                  
 | **generateNumericCodes**       | This parameter is used to generate numeric representation for issuing state and nationality codes.                                                                                                                                                                                                                                                                                                                                    |  boolean  |                                               |                                                                                                                                                                                                                                                                  `true`, `false`                                                                                                                                                                                                                                                                  |                                                                                                  
 
 **Attention!** If the `multipage-processing` or `internal-scenario` attributes are set, the corresponding `multipageProcessing` and `scenario` parameters' values are ignored.

package/dist/index.d.ts

@@ -7,6 +7,7 @@ import { ProcessResponse } from '@regulaforensics/document-reader-webclient';
 import { Response as Response_2 } from '@regulaforensics/document-reader-webclient';
 import { Result } from '@regulaforensics/document-reader-webclient';
 import { TextFieldType } from '@regulaforensics/document-reader-webclient';
+import { TransactionInfo } from '@regulaforensics/document-reader-webclient';
 
 export declare interface BaseRequest {
     tag?: string;
@@ -220,13 +221,10 @@ export declare interface DocumentReaderProcessParam {
     backendProcessing?: {
         serviceURL?: string;
         httpHeaders?: Record<string, string>;
-        timeoutConnection?: number;
     };
 }
 
-export declare type DocumentReaderResponseType = Response_2 & {
-    TransactionInfo?: TransactionInfo;
-};
+export declare type DocumentReaderResponseType = Response_2;
 
 export declare class DocumentReaderService {
     private _worker;
@@ -234,12 +232,12 @@ export declare class DocumentReaderService {
     private _initializeListener;
     private _processingListener;
     private _queueService;
+    private _initProcess;
     onFinalize: TOnFinalize | null;
     isAutoPrepare: boolean;
     isPrepared: boolean;
     isInitialized: boolean;
     isProcessing: boolean;
-    _initProcess: Promise<License> | null;
     initData: License | null;
     recognizerProcessParam: ProcessingRequest;
     imageProcessParam: ImageProcessingRequest;
@@ -263,14 +261,14 @@ export declare class DocumentReaderService {
     doInitialize(initData?: {
         license: string | undefined;
     }): Promise<License>;
-    private processGeneric;
-    processImageBase64(base64ImagesArray: Array<string>, params: ProcessingRequest): Promise<Response_2 | ProcessRejectResponse>;
-    process(imageDataArray: Array<ImageData>, params?: ProcessingRequest): Promise<Response_2 | ProcessRejectResponse>;
-    processImage(imageDataArray: Array<ImageData>, params?: ProcessingRequest): Promise<Response_2 | ProcessRejectResponse>;
+    private doProcess;
+    processImageBase64(base64ImagesArray: Array<string>, params: ProcessingRequest): Promise<Response_2>;
+    process(imageDataArray: Array<ImageData>, params?: ProcessingRequest): Promise<Response_2>;
+    processImage(imageDataArray: Array<ImageData>, params?: ProcessingRequest): Promise<Response_2>;
     startNewPage(): Promise<void>;
     startNewDocument(metadata?: Record<string, any>): Promise<NewTransaction>;
     createBackendTransaction(metadata?: Record<string, any>): Promise<NewTransaction>;
-    finalizePackage(): Promise<TransactionInfo>;
+    finalizePackage(): Promise<TransactionIdentifier>;
     addDataToPackage(data: Uint8ClampedArray, params: PackageParams): Promise<void>;
     shutdown(): void;
 }
@@ -508,13 +506,7 @@ export declare enum MirrorType {
 
 export declare interface NewTransaction {
     ContainerList: ContainerList;
-    TransactionInfo: {
-        ComputerName: string;
-        DateTime: string;
-        SystemInfo: string;
-        Tag: string;
-        TransactionID: string;
-    };
+    TransactionInfo: TransactionInfo;
     sessionLogFolder: string;
 }
 
@@ -565,7 +557,7 @@ declare type TInitializeListener = ({ isInitialized }: {
     isInitialized: boolean;
 }) => void;
 
-declare type TOnFinalize = (transaction: TransactionInfo) => void;
+declare type TOnFinalize = (transaction: TransactionIdentifier) => void;
 
 declare type TPrepareListener = ({ isPrepared }: {
     isPrepared: boolean;
@@ -580,7 +572,8 @@ export declare interface TransactionEvent {
     data: GetTransactionsByTagResponse;
 }
 
-export declare interface TransactionInfo {
+export declare interface TransactionIdentifier {
+    metadata?: unknown;
     tag: string;
     transactionId: string;
 }