@regulaforensics/vp-frontend-document-components 2.4.0 → 2.5.0

package/esm/main.js.LICENSE.txt

@@ -39,13 +39,3 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-
-/**
-@license @nocompile
-Copyright (c) 2018 The Polymer Project Authors. All rights reserved.
-This code may only be used under the BSD style license found at http://polymer.github.io/LICENSE.txt
-The complete set of authors may be found at http://polymer.github.io/AUTHORS.txt
-The complete set of contributors may be found at http://polymer.github.io/CONTRIBUTORS.txt
-Code distributed by Google as part of the polymer project is also
-subject to an additional IP rights grant found at http://polymer.github.io/PATENTS.txt
-*/

package/lib/index.d.ts

@@ -1668,6 +1668,7 @@ interface OriginalSymbol {
 }
 
 interface TextFieldValue {
+    containerType: number;
     source: Source;
     value: string;
     originalValue?: string;
@@ -2051,9 +2052,16 @@ type DocumentEventActions =
     | 'PRESS_FILE_BUTTON'
     | 'PRESS_RETRY_BUTTON'
     | 'PRESS_SKIP_BUTTON'
+    | 'PRESS_CAPTURE_BUTTON'
+    | 'PRESS_CHANGE_CAMERA_BUTTON'
+    | 'PRESS_MIRRORING_BUTTON'
+    | 'NEW_PAGE_AVAILABLE'
+    | 'NEW_PAGE_STARTED'
     | 'CLOSE'
     | 'CAMERA_PROCESS_CLOSED'
     | 'CAMERA_PROCESS_STARTED'
+    | 'VIDEO_STARTED'
+    | 'VIDEO_STOPPED'
     | 'FILE_PROCESS_STARTED'
     | 'PROCESS_FINISHED'
     | 'SERVICE_INITIALIZED';
@@ -2102,6 +2110,12 @@ type InternalScenarios =
     | 'MrzOrBarcode'
     | 'BarcodeAndLocate';
 
+type CaptureMode = 'auto' | 'captureVideo' | 'captureFrame';
+
+type FrameShapeType = 'line' | 'corners';
+
+type FrameLineCap = 'butt' | 'round' | 'square';
+
 type DocumentReaderResponseType = Response;
 type CameraSnapshotResponseType = Array<{ raw: string; mimeType: string }>;
 
@@ -2166,8 +2180,6 @@ interface DocumentReaderProcessParam {
     customParams?: Record<string, object>;
     imageOutputMaxHeight?: number;
     imageOutputMaxWidth?: number;
-    doublePageSpread?: boolean;
-    generateDoublePageSpreadImage?: boolean;
     fieldTypesFilter?: Array<TextFieldType>;
     dateFormat?: string;
     measureSystem?: MeasureSystem;
@@ -2260,6 +2272,7 @@ interface CameraSnapshotSettings {
     cameraId?: string;
     changeCameraButton?: boolean;
     closeButton?: boolean;
+    nonce?: string;
 }
 
 interface DocumentReaderSettings extends CameraSnapshotSettings {
@@ -2267,20 +2280,47 @@ interface DocumentReaderSettings extends CameraSnapshotSettings {
     multipageProcessing?: boolean;
     devLicense?: string;
     captureButton?: boolean;
-}
+    captureMode?: CaptureMode | string;
+    flipFrontIcon?: string;
+    flipBackIcon?: string;
+    skipButton?: boolean;
+    cameraFrameBorderWidth?: number;
+    backgroundMaskAlpha?: number;
+    cameraFramePortraitAspectRatio?: number;
+    cameraFrameLandscapeAspectRatio?: number;
+    statusPositionMultiplier?: number;
+    statusIcon?: number;
+    cameraFrameOffsetWidth?: number;
+    cameraFrameVerticalPositionMultiplier?: number;
+    cameraFrameShapeType?: FrameShapeType;
+    cameraFrameLineCap?: FrameLineCap;
+    cameraFrameLineLength?: number;
+    cameraFrameCornerRadius?: number;
+    cameraFrame?: boolean;
+}
+
+type TScenarioParams = {
+    name: string;
+    desc: string;
+    caption: string;
+    frameKWHDoublePageSpreadLandscape: string;
+    frameKWHDoublePageSpreadPortrait: string;
+    frameKWHLandscape: string;
+    frameKWHPortrait: string;
+    frameOrientation: number;
+    barcodeExt?: number;
+    faceExt?: number;
+    manualCrop?: number;
+    multiPageOff?: number;
+    seriesProcessMode?: number;
+    UVTorch?: number;
+};
 
 type DocumentDictionaries = Partial<Record<Locales, DocumentTranslations>>;
 type RecognizeListener = (data: Response) => void;
 type ResponseListener = (currentPage: CurrentPage) => void;
 type PrepareListener = ({ isPrepared }: { isPrepared: boolean }) => void;
-
-interface TLicense {
-    license: {
-        errorCode: number;
-        message: string;
-        status: boolean;
-    };
-}
+type InitializeListener = ({ isInitialized }: { isInitialized: boolean }) => void;
 
 declare global {
     interface HTMLElementEventMap {
@@ -2299,6 +2339,15 @@ export interface ICameraSnapshot {
     'close-button'?: boolean;
 }
 
+export type License = {
+    license: {
+        errorCode: number;
+        message: string;
+        status: boolean;
+    };
+    scenario: Array<TScenarioParams>;
+};
+
 export interface IDocumentReader extends ICameraSnapshot {
     'internal-scenario'?: InternalScenarios;
     'multipage-processing'?: boolean;
@@ -2328,41 +2377,48 @@ export class DocumentReaderCaptureWebComponent extends HTMLElement {
 }
 
 export class DocumentReaderProcessor {
-    isPrepared: boolean;
     isProcessing: boolean;
     isInitialized: boolean;
     videoElement: HTMLVideoElement | null;
-    recognizeListener: RecognizeListener | null;
     constructor(videoElement?: HTMLVideoElement);
+    get recognizeListener(): RecognizeListener | null;
+    set recognizeListener(listener: RecognizeListener | null);
     get streamParam(): Partial<StreamParams>;
     set streamParam(params: Partial<StreamParams>);
     get recognizerProcessParam(): ProcessingRequest;
     set recognizerProcessParam(params: ProcessingRequest);
     get imageProcessParam(): ImageProcessingRequest;
     set imageProcessParam(params: ImageProcessingRequest);
+    get workerPath(): string;
+    set workerPath(url: string);
     switchCamera(): Promise<void>;
     startRecognition(responseListener?: ResponseListener): Promise<Response | null>;
     processImage(images: FileList | Array<Blob>): Promise<Response>;
     stopRecognition(): void;
-    prepare(): Promise<void>;
-    initialize(license?: { license: string | undefined }): Promise<TLicense>;
+    initialize(license?: { license: string | undefined }): Promise<License>;
     shutdown(): void;
 }
 
 export class DocumentReaderService {
+    isAutoPrepare: boolean;
     isPrepared: boolean;
     isInitialized: boolean;
     isProcessing: boolean;
+    initData: License | null;
     recognizerProcessParam: ProcessingRequest;
     imageProcessParam: ImageProcessingRequest;
+    recognizeListener: RecognizeListener | null;
+    workerPath: string;
     version: { component: string };
     get prepareListener(): PrepareListener | null;
     set prepareListener(listener: PrepareListener | null);
+    get initializeListener(): InitializeListener | null;
+    set initializeListener(listener: InitializeListener | null);
     prepare(): Promise<void>;
-    initialize(initData?: { license: string | undefined }): Promise<TLicense>;
+    initialize(initData?: { license: string | undefined }): Promise<License>;
     processImageBase64(base64ImagesArray: Array<string>, params: ProcessingRequest): Promise<Response>;
-    process(imageDataArray: Array<ImageData>): Promise<Response>;
-    processImage(imageDataArray: Array<ImageData>): Promise<Response>;
+    process(imageDataArray: Array<ImageData>, params?: ProcessingRequest): Promise<Response>;
+    processImage(imageDataArray: Array<ImageData>, params?: ProcessingRequest): Promise<Response>;
     startNewPage(): Promise<void>;
     startNewDocument(): Promise<void>;
     shutdown(): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@regulaforensics/vp-frontend-document-components",
-  "version": "2.4.0",
+  "version": "2.5.0",
   "description": "Regula framework agnostic web components to work with webcamera",
   "types": "lib/index.d.ts",
   "main": "dist/main.js",