@regulaforensics/vp-frontend-document-components 2.6.0 → 7.2.1567-nightly

package/lib/index.d.ts

@@ -5,6 +5,7 @@ import {
     MeasureSystem,
     DocumentFormat,
     MRZFormat,
+    ContainerList,
 } from '@regulaforensics/document-reader-webclient';
 
 interface Connection {
@@ -137,7 +138,7 @@ type FrameLineCap = 'butt' | 'round' | 'square';
 
 type CameraMode = 'user' | 'environment';
 
-type DocumentReaderResponseType = Response;
+type DocumentReaderResponseType = Response & { TransactionInfo?: TransactionInfo };
 type CameraSnapshotResponseType = Array<{ raw: string; mimeType: string }>;
 
 declare enum ResponseCode {
@@ -149,9 +150,10 @@ declare enum ResponseCode {
 
 interface CustomEventDataType<R> {
     status: ResponseCode;
+    details?: unknown;
     reason?: ErrorTypes;
     response?: R;
-    video?: Blob;
+    video?: VideoData;
 }
 
 interface DetailEvent<A, R> {
@@ -182,13 +184,6 @@ interface DocumentReaderImage {
     pageIdx: number;
 }
 
-interface ProcessingRequest {
-    tag?: string;
-    processParam: DocumentReaderProcessParam;
-    imagesList?: Array<DocumentReaderImage>;
-    imageInputParam?: ImageInputParamType;
-}
-
 interface WidthAndHeight {
     width: number;
     height: number;
@@ -202,11 +197,31 @@ interface StreamParams {
     resolution: Resolution;
 }
 
+interface VideoData {
+    data: Blob;
+    width: number;
+    height: number;
+    mimeType: string;
+    duration: number;
+    bitrate: number;
+}
+
 interface VideoRecordSettings {
     delay?: number;
     duration?: number;
 }
 
+interface TransactionInfo {
+    tag: string;
+    transactionId: string;
+}
+
+interface PackageParams {
+    sizeBytes: number;
+    dataName: string;
+    metadata?: Record<string, any>;
+}
+
 interface DocumentReaderProcessParam {
     returnPackageForReprocess?: boolean;
     returnUncroppedImage?: boolean;
@@ -249,12 +264,39 @@ interface DocumentReaderProcessParam {
             maxGlaringPart?: number;
         };
     };
+    backendProcessing?: {
+        serviceURL?: string;
+        httpHeaders?: Record<string, string>;
+    };
+}
+
+interface NewTransaction {
+    ContainerList: ContainerList;
+    TransactionInfo: {
+        ComputerName: string;
+        DateTime: string;
+        SystemInfo: string;
+        Tag: string;
+        TransactionID: string;
+    };
+    sessionLogFolder: string;
+}
+
+interface ProcessingRequest {
+    metadata?: Record<string, any>;
+    tag?: string;
+    processParam: DocumentReaderProcessParam;
+    imagesList?: Array<DocumentReaderImage>;
+    imageInputParam?: ImageInputParamType;
 }
 
 interface ImageProcessingRequest {
     tag?: string;
     imageInputParam?: ImageInputParamType;
-    processParam: Pick<DocumentReaderProcessParam, 'returnPackageForReprocess' | 'returnUncroppedImage' | 'scenario'>;
+    processParam: Pick<
+        DocumentReaderProcessParam,
+        'returnPackageForReprocess' | 'returnUncroppedImage' | 'scenario' | 'backendProcessing'
+    >;
 }
 
 interface CurrentPage {
@@ -284,7 +326,6 @@ interface DocumentTranslations {
     fromGallery?: string;
     processing?: string;
     preparingService?: string;
-    detectingDocument?: string;
     placeDocumentIntoFrame?: string;
     positionDocumentCenter?: string;
     noFocus?: string;
@@ -385,6 +426,7 @@ type DocumentDictionaries = Partial<Record<Locales, DocumentTranslations>>;
 type RecognizeListener = (data: Response) => void;
 type ResponseListener = (currentPage: CurrentPage) => void;
 type PrepareListener = ({ isPrepared }: { isPrepared: boolean }) => void;
+type ProcessingListener = ({ isProcessing }: { isProcessing: boolean }) => void;
 type InitializeListener = ({ isInitialized }: { isInitialized: boolean }) => void;
 
 declare global {
@@ -422,6 +464,7 @@ export interface IDocumentReader extends ICameraSnapshot {
 }
 
 export type DocumentReaderDetailType = DetailEvent<DocumentEventActions, DocumentReaderResponseType>;
+export type DocumentReaderDeviceDetailType = DetailEvent<DocumentEventActions, Response>;
 export type CameraSnapshotDetailType = DetailEvent<DocumentEventActions, CameraSnapshotResponseType>;
 
 export function defineComponents(): Promise<void>;
@@ -483,6 +526,8 @@ export class DocumentReaderService {
     recognizeListener: RecognizeListener | null;
     workerPath: string;
     version: { component: string };
+    get processingListener(): ProcessingListener | null;
+    set processingListener(listener: ProcessingListener | null);
     get prepareListener(): PrepareListener | null;
     set prepareListener(listener: PrepareListener | null);
     get initializeListener(): InitializeListener | null;
@@ -493,7 +538,10 @@ export class DocumentReaderService {
     process(imageDataArray: Array<ImageData>, params?: ProcessingRequest): Promise<Response>;
     processImage(imageDataArray: Array<ImageData>, params?: ProcessingRequest): Promise<Response>;
     startNewPage(): Promise<void>;
-    startNewDocument(): Promise<void>;
+    startNewDocument(metadata?: Record<string, any>): Promise<NewTransaction>;
+    createBackendTransaction(metadata?: Record<string, any>): Promise<NewTransaction>;
+    finalizePackage(): Promise<TransactionInfo>;
+    addDataToPackage(data: Uint8ClampedArray, params: PackageParams): Promise<void>;
     shutdown(): void;
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@regulaforensics/vp-frontend-document-components",
-  "version": "2.6.0",
+  "version": "7.2.1567-nightly",
   "description": "Regula framework agnostic web components to work with webcamera",
   "types": "lib/index.d.ts",
   "main": "dist/main.js",
@@ -18,6 +18,6 @@
     "test": "jest --testPathPattern=src/tests"
   },
   "dependencies": {
-    "@regulaforensics/document-reader-webclient": "^7.1.0"
+    "@regulaforensics/document-reader-webclient": "^7.1.3-beta.1"
   }
 }