@regulaforensics/vp-frontend-document-components 2.6.1 → 7.2.1606

package/esm/main.js.LICENSE.txt

@@ -1,14 +1,3 @@
-/*!
- * ASP.NET SignalR JavaScript Library v2.2.2
- * http://signalr.net/
- *
- * Copyright (c) .NET Foundation. All rights reserved.
- * Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
- *
- */
-
-/*! jQuery v2.2.0 | (c) jQuery Foundation | jquery.org/license */
-
 /*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/facebook/regenerator/blob/main/LICENSE */
 
 /**

package/lib/index.d.ts

@@ -5,41 +5,9 @@ import {
     MeasureSystem,
     DocumentFormat,
     MRZFormat,
+    ContainerList,
 } from '@regulaforensics/document-reader-webclient';
 
-interface Connection {
-    id: string;
-    proxies: { [hubName: string]: any };
-    transport: {
-        name: string;
-        supportsKeepAlive: SupportsKeepAliveHandler;
-    };
-    createHubProxy(hubName: string): Proxy;
-    start(options?: any, callback?: () => void): any;
-    stop(async?: boolean, notifyServer?: boolean): void;
-    reconnecting(callback: () => void): void;
-    disconnected(callback: () => void): void;
-}
-
-interface Proxy {
-    state: any;
-    connection: Connection;
-    hubName: string;
-    init(connection: Connection, hubName: string): void;
-    hasSubscriptions(): boolean;
-    on(eventName: string, callback?: (...msg: any[]) => void): Proxy;
-    off(eventName: string, callback?: (...msg: any[]) => void): Proxy;
-    invoke(methodName: string, ...args: any[]): Promise<any>;
-}
-
-interface Options {
-    qs?: string | undefined;
-    logging?: boolean | undefined;
-    useDefaultPath?: boolean | undefined;
-}
-
-type SupportsKeepAliveHandler = () => boolean;
-
 interface DeviceInfo {
     reader_ready: boolean;
     rfid_ready: boolean;
@@ -137,7 +105,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 +117,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 +151,6 @@ interface DocumentReaderImage {
     pageIdx: number;
 }
 
-interface ProcessingRequest {
-    tag?: string;
-    processParam: DocumentReaderProcessParam;
-    imagesList?: Array<DocumentReaderImage>;
-    imageInputParam?: ImageInputParamType;
-}
-
 interface WidthAndHeight {
     width: number;
     height: number;
@@ -202,11 +164,27 @@ interface StreamParams {
     resolution: Resolution;
 }
 
+interface VideoData {
+    data: Blob;
+    mimeType: string;
+}
+
 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 +227,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 +289,6 @@ interface DocumentTranslations {
     fromGallery?: string;
     processing?: string;
     preparingService?: string;
-    detectingDocument?: string;
     placeDocumentIntoFrame?: string;
     positionDocumentCenter?: string;
     noFocus?: string;
@@ -327,14 +331,6 @@ interface CameraSnapshotSettings {
     statusBackgroundColor?: string;
 }
 
-interface DocumentReaderDeviceSettings {
-    locale?: Locales | string;
-    nonce?: string;
-    serviceUrl?: string;
-    regulaLogo?: boolean;
-    properties?: Record<string, any>;
-}
-
 interface DocumentReaderSettings extends CameraSnapshotSettings {
     internalScenario?: InternalScenarios | string;
     multipageProcessing?: boolean;
@@ -385,12 +381,12 @@ 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 {
     interface HTMLElementEventMap {
         'document-reader': CustomEvent<DocumentReaderDetailType>;
-        'document-reader-device': CustomEvent<DocumentReaderDetailType>;
         'camera-snapshot': CustomEvent<CameraSnapshotDetailType>;
     }
 }
@@ -442,13 +438,6 @@ export class DocumentReaderCaptureWebComponent extends HTMLElement {
     get settings(): CameraSnapshotSettings;
 }
 
-export class DocumentReaderDeviceWebComponent extends HTMLElement {
-    set translations(dictionary: DocumentDictionaries | null);
-    get translations(): DocumentDictionaries | null;
-    set settings(params: DocumentReaderDeviceSettings);
-    get settings(): DocumentReaderDeviceSettings;
-}
-
 export class DocumentReaderProcessor {
     isProcessing: boolean;
     isInitialized: boolean;
@@ -483,6 +472,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,22 +484,9 @@ 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;
 }
-
-export class DocumentReaderController {
-    hubProxy: null | Proxy;
-    isInitialized: boolean;
-    get serviceUrl(): string;
-    set serviceUrl(url: string);
-    initRegulaReader(): Promise<void>;
-    getLastResults(): Promise<Response>;
-    getImages(): Promise<void>;
-    setProperty(name: string, value: any): Promise<void>;
-    getProperty(name: string): Promise<any>;
-    getAvailableDevices(index: number): Promise<string>;
-    clearResults(): Promise<void>;
-    healthCheck(): Promise<DeviceInfo>;
-    disconnect(): void;
-}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@regulaforensics/vp-frontend-document-components",
-  "version": "2.6.1",
+  "version": "7.2.1606",
   "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.1"
+    "@regulaforensics/document-reader-webclient": "^7.2.2"
   }
 }