@regulaforensics/vp-frontend-document-components 2.0.1 → 2.2.0

package/lib/services/FaceService.d.ts

@@ -1,12 +1,25 @@
 import { FaceLivenessResultType } from '../types';
-declare type GetLivenessResultOptions = {
-    uuid: string;
-    try_id: number;
+import { InitializedLivenessDetectionData } from './FaceLivenessService';
+import CameraModel from '../models/CameraModel';
+declare type GetLivenessDetectionResultOptions = {
+    transactionId: string;
     backendURL?: string;
     headers?: Record<string, string>;
+    publicKey: string;
 };
-declare function getLivenessResult(encryptedBody: Uint8Array, { uuid, try_id, backendURL, headers }: GetLivenessResultOptions): Promise<FaceLivenessResultType>;
+declare type DeviceMetadata = {
+    platform: string;
+    osVersion: string;
+    sdkVersion: string;
+    hostAppId: string;
+    deviceModel: string;
+    currentCameraId: string;
+    cameraState: CameraModel[];
+};
+declare function getLivenessDetectionResult(encryptedBody: Uint8Array, { transactionId, backendURL, headers, publicKey }: GetLivenessDetectionResultOptions): Promise<FaceLivenessResultType>;
+declare function getInitialisingData(deviceMetadata: DeviceMetadata, sessionId?: string, backendUrl?: string): Promise<InitializedLivenessDetectionData>;
 declare const _default: {
-    getLivenessResult: typeof getLivenessResult;
+    getInitialisingData: typeof getInitialisingData;
+    getLivenessDetectionResult: typeof getLivenessDetectionResult;
 };
 export default _default;

package/lib/types.d.ts

@@ -1,6 +1,51 @@
-import { Response } from '@regulaforensics/document-reader-webclient';
+import { Response } from './models/DocReaderWebclient/ext';
+import dictionaries from './i18n/dictionaries/_dictionaries';
 import { DocumentEventActions, FaceEventActions, InternalScenarios, ObjectFit, ResponseCode, StreamStatus, ErrorTypes, CameraFacingMode } from './constants';
 import CameraModel from './models/CameraModel';
+declare type DocumentTranslations = {
+    scanIDInBrowser?: string;
+    useYourDeviceCamera?: string;
+    success?: string;
+    processingFinished?: string;
+    largeFile?: string;
+    selectSmallerFile?: string;
+    versionNotSupported?: string;
+    updateBrowser?: string;
+    licenseError?: string;
+    licenseExpired?: string;
+    fileCorrupt?: string;
+    selectAnotherFile?: string;
+    timeout?: string;
+    error?: string;
+    somethingWentWrong?: string;
+    tryAgain?: string;
+    fromCamera?: string;
+    fromGallery?: string;
+    processing?: string;
+    preparingService?: string;
+    detectingDocument?: string;
+    placeDocumentIntoFrame?: string;
+    positionDocumentCenter?: string;
+    noFocus?: string;
+    moveCloser?: string;
+    glaresOnDocument?: string;
+    holdDocumentStraight?: string;
+    documentProcessing?: string;
+    flipDocument?: string;
+    cameraUnavailable?: string;
+    preparingCamera?: string;
+    noCameraAvailable?: string;
+    incorrectCameraId?: string;
+    allowAccessToCamera?: string;
+    cameraConnection?: string;
+    checkCameraId?: string;
+    verified?: string;
+    photoCapturedSuccessfully?: string;
+    uploadPhoto?: string;
+    useCameraOrGallery?: string;
+};
+export declare type Locales = keyof typeof dictionaries | string;
+export declare type DocumentDictionaries = Partial<Record<Locales, DocumentTranslations>>;
 export declare type XY = {
     x: number;
     y: number;
@@ -29,7 +74,6 @@ export declare type FacingModeType = keyof typeof CameraFacingMode;
 export declare type VideoStatusParamsType = {
     videoStatus: StreamStatus;
     camera: CameraTypes;
-    twoFacingModesAvailable: boolean;
 };
 export declare type CaptureFrameType = {
     imageData: Array<ImageData>;
@@ -54,86 +98,27 @@ export declare type UserAgentType = {
     vendor: string;
     vendorSub: string;
 };
-declare type FaceLivenessEyesType = {
-    predLeft: number;
-    predRight: number;
-    probLeft: number;
-    probRight: number;
-};
-declare type FaceLivenessOcclusionType = {
-    foreheadGlasses: boolean;
-    glasses: boolean;
-    hat: boolean;
-    medicineMask: boolean;
-    occlusion: boolean;
-    openedMouth: boolean;
-    sunglasses: boolean;
-};
-declare type FaceLivenessQualityType = {
-    blur: number;
-    brightness: number;
-    noise: number;
-};
-export declare type FaceLivenessResponseType = {
+export declare type FaceLivenessResultType = {
     code: number;
-    msg: string;
-    results: {
-        faceIdx: number;
-        livenessStatus: number;
-        metadata: {
-            ageNear: string;
-            ageNormal: string;
-            distance: number;
-            evaluationTime: number;
-            eyesNear: FaceLivenessEyesType;
-            eyesNormal: FaceLivenessEyesType;
-            faceQuality: {
-                details: Array<{
-                    attribute: string;
-                    score: number;
-                }>;
-                score: number;
-            };
-            faceTrackBreak: number;
-            occlusionNear: FaceLivenessOcclusionType;
-            occlusionNormal: FaceLivenessOcclusionType;
-            predArtMaskNear: number;
-            predArtMaskNormal: number;
-            predElectronicDeviceNear: number;
-            predElectronicDeviceNormal: number;
-            predGeometryClassifier: number;
-            predLivenessViewNear: number;
-            predLivenessViewNormal: number;
-            predOpticalFlow: number;
-            predShadesNear: number;
-            predShadesNormal: number;
-            predTotal: number;
-            probArtMaskNear: number;
-            probArtMaskNormal: number;
-            probElectronicDeviceNear: number;
-            probElectronicDeviceNormal: number;
-            probGeometryClassifier: number;
-            probOpticalFlow: number;
-            probShadesNear: number;
-            probShadesNormal: number;
-            qualityNear: FaceLivenessQualityType;
-            qualityNormal: FaceLivenessQualityType;
-            smileNear: string;
-            smileNormal: string;
-            symNear: number;
-            symNormal: number;
+    elapsed: string;
+    metadata: {
+        ctx: {
+            userIp: string;
         };
+        serverTime: string;
     };
-    versionDescriptor: string;
-    versionSDK: string;
+    status: number;
+};
+export declare type FaceLivenessResponseType = FaceLivenessResultType & {
     images: Array<string>;
+    transactionId: string;
+    sessionId: string;
 };
 export declare type FaceDetectionResponseType = {
     capture: Array<string>;
 };
 export declare type DocumentReaderResponseType = Response;
 export declare type CameraSnapshotResponseType = CaptureType;
-export declare type FaceLivenessResultType = Omit<FaceLivenessResponseType, 'images'>;
 export declare type FaceDebugOutput = {
     cft: boolean;
     face: {
@@ -240,6 +225,31 @@ export declare type DocumentReaderProcessParam = {
     timeoutFromFirstDetect?: number;
     timeoutFromFirstDocType?: number;
     resultTypeOutput?: Array<string>;
+    customParams?: Record<string, any>;
+    imageOutputMaxHeight?: number;
+    imageOutputMaxWidth?: number;
+    doublePageSpread?: boolean;
+    generateDoublePageSpreadImage?: boolean;
+    fieldTypesFilter?: Array<number>;
+    dateFormat?: string;
+    measureSystem?: number;
+    imageDpiOutMax?: number;
+    alreadyCropped?: boolean;
+    fastDocDetect?: boolean;
+    updateOCRValidityByGlare?: boolean;
+    returnCroppedBarcode?: boolean;
+    respectImageQuality?: boolean;
+    forceDocFormat?: number;
+    noGraphics?: boolean;
+    documentAreaMin?: number;
+    depersonalizeLog?: boolean;
+    multiDocOnImage?: boolean;
+    shiftExpiryDate?: number;
+    minimalHolderAge?: number;
+    mrzFormatsFilter?: Array<string>;
+    forceReadMrzBeforeLocate?: boolean;
+    parseBarcodes?: boolean;
+    splitNames?: boolean;
     imageQa?: {
         expectedPass?: Array<string>;
         dpiThreshold?: number;
@@ -250,15 +260,12 @@ export declare type DocumentReaderProcessParam = {
         };
     };
 };
-export declare type DocumentReaderRequest = {
-    processParam: Record<string, any>;
+export declare type ProcessingRequest = {
+    processParam: DocumentReaderProcessParam;
     imagesList?: Array<DocumentReaderImage>;
     imageInputParam?: ImageInputParamType;
 };
-export declare type SDKRecognizerProcessingRequest = {
-    processParam: DocumentReaderProcessParam;
-};
-export declare type SDKImageProcessingRequest = {
+export declare type ImageProcessingRequest = {
     processParam: Pick<DocumentReaderProcessParam, 'returnPackageForReprocess' | 'returnUncroppedImage' | 'scenario'>;
 };
 export declare type DevicesType = {
@@ -271,15 +278,19 @@ export interface StreamDataType {
     status: StreamStatus;
     stream: MediaStream | null;
     camera: CameraTypes;
-    twoFacingModesAvailable: boolean;
 }
+export declare type StreamParams = {
+    cameraMode: FacingModeType;
+    preferredCameraId: string;
+    resolution: WidthAndHeight;
+};
 export declare type CameraTypes = {
     selectedCamera: CameraModel;
     frontCameras: Array<CameraModel>;
     backCameras: Array<CameraModel>;
 };
 export declare type CurrentPage = {
-    data: Response;
+    data: Response | null;
     startNextPage: () => Promise<void>;
     finishRecognition: () => void;
 };
@@ -292,20 +303,20 @@ declare global {
     }
 }
 interface IBaseComponent {
-    locale?: string;
+    locale?: Locales;
     copyright?: boolean;
     'camera-id'?: string;
     'change-camera'?: boolean;
+    'start-screen'?: boolean;
 }
 interface IDocumentBaseComponent extends IBaseComponent {
     'start-screen'?: boolean;
     multiple?: boolean;
     'object-fit'?: keyof typeof ObjectFit;
 }
-export interface IFaceLiveness extends Omit<IBaseComponent, 'headers'> {
+export interface IFaceLiveness extends IBaseComponent {
     url?: string;
     debug?: boolean;
-    headers?: string | Record<string, string>;
 }
 export interface IDocumentReader extends IDocumentBaseComponent {
     'internal-scenario'?: keyof typeof InternalScenarios;
@@ -316,8 +327,17 @@ export interface IFaceDetection extends IBaseComponent {
     debug?: boolean;
 }
 export declare type ICameraSnapshot = IDocumentBaseComponent;
+export declare type FacePositionLivenessDetection = {
+    width: number;
+    height: number;
+    x: number;
+    y: number;
+};
+export { default as DocumentReaderService } from './services/DocumentReaderService';
+export { default as DocumentReaderProcessor } from './services/DocumentReaderProcessor';
 export { default as DocumentReaderCaptureWebComponent } from './web-components/CameraSnapshot';
 export { default as DocumentReaderWebComponent } from './web-components/DocumentReader';
 export { default as FaceDetectionWebComponent } from './web-components/FaceDetection';
 export { default as FaceLivenessWebComponent } from './web-components/FaceLiveness';
 export { default as FullScreenContainer } from './web-components/FullScreenContainer';
+export { defineComponents } from './index-document';

package/lib/utils.d.ts

@@ -1,6 +1,7 @@
-import { ImageOutputType, ObjectFit } from './constants';
+import { DocumentCaptureStatus, ImageOutputType, ObjectFit } from './constants';
 import CameraModel from './models/CameraModel';
 import { CameraTypes, CaptureFrameType, DevicesType, FaceDebugOutput, FacingModeType, FrameObject, StreamDataType, VideoParamsType, WidthAndHeight } from './types';
+import { Response } from './models/DocReaderWebclient/ext';
 export declare function uint8ArrayToBase64(arr: Uint8ClampedArray, videoFrame: {
     width: number;
     height: number;
@@ -25,3 +26,5 @@ export declare function getVideo(resolution: WidthAndHeight, cameraTypes: Camera
 export declare function getImageFromVideo(videoElement: HTMLVideoElement, outputType: ImageOutputType): CaptureFrameType;
 export declare function getNextCamera(camerasInfo: CameraTypes): string;
 export declare function drawFaceDebugOutput(canvas: HTMLCanvasElement, videoElementParams: VideoParamsType, debugOutput: FaceDebugOutput): void;
+export declare function mergeDeep<T, S, R>(target: T, source: S): R | T;
+export declare function getStatus(response: Response, pageIdx: number, multipageProcessing?: boolean): DocumentCaptureStatus.FINDING | DocumentCaptureStatus.SUCCESS | DocumentCaptureStatus.RESOLUTION | DocumentCaptureStatus.GLARE | DocumentCaptureStatus.FOCUS | DocumentCaptureStatus.HOLD | DocumentCaptureStatus.START_NEXT_PAGE | DocumentCaptureStatus.TIMEOUT;

package/lib/web-components/CameraSnapshot.d.ts

@@ -1,11 +1,14 @@
-import { Root } from 'react-dom/client';
+import { DocumentDictionaries } from '../types';
 export default class DocumentReaderCaptureWebComponent extends HTMLElement {
-    root: Root;
-    mounted: boolean;
+    private _root;
+    private _mounted;
+    private _translations;
     constructor();
     static get observedAttributes(): Array<string>;
     attributeChangedCallback(name: string): void;
     connectedCallback(): void;
+    set translations(dictionary: DocumentDictionaries | null);
+    get translations(): DocumentDictionaries | null;
     render(): void;
     disconnectedCallback(): void;
 }

package/lib/web-components/DocumentReader.d.ts

@@ -1,11 +1,14 @@
-import { Root } from 'react-dom/client';
+import { DocumentDictionaries } from '../types';
 export default class DocumentReaderWebComponent extends HTMLElement {
-    root: Root;
-    mounted: boolean;
+    private _root;
+    private _mounted;
+    private _translations;
     constructor();
     static get observedAttributes(): Array<string>;
     attributeChangedCallback(name: string): void;
     connectedCallback(): void;
+    set translations(dictionary: DocumentDictionaries | null);
+    get translations(): DocumentDictionaries | null;
     render(): void;
     disconnectedCallback(): void;
 }

package/lib/web-components/FaceDetection.d.ts

@@ -1,7 +1,6 @@
-import { Root } from 'react-dom/client';
 export default class FaceDetectionWebComponent extends HTMLElement {
-    root: Root;
-    mounted: boolean;
+    private _root;
+    private _mounted;
     constructor();
     static get observedAttributes(): Array<string>;
     attributeChangedCallback(name: string): void;

package/lib/web-components/FaceLiveness.d.ts

@@ -1,14 +1,16 @@
-import { Root } from 'react-dom/client';
 export default class FaceLivenessWebComponent extends HTMLElement {
-    root: Root;
-    mounted: boolean;
-    requestHeaders: Record<string, string>;
+    private _root;
+    private _mounted;
+    private _headers;
+    private _sessionIdValue;
     constructor();
     static get observedAttributes(): Array<string>;
     attributeChangedCallback(name: string): void;
     connectedCallback(): void;
     set headers(headersData: Record<string, string>);
     get headers(): Record<string, string>;
+    set sessionId(id: string);
+    get sessionId(): string;
     render(): void;
     disconnectedCallback(): void;
 }

package/lib/web-components/FullScreenContainer.d.ts

@@ -1,4 +1,4 @@
 export default class FullScreenContainer extends HTMLElement {
-    root: ShadowRoot;
+    private _root;
     constructor();
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@regulaforensics/vp-frontend-document-components",
-  "version": "2.0.1",
+  "version": "2.2.0",
   "description": "Regula framework agnostic web components to work with webcamera",
   "types": "lib/types.d.ts",
   "main": "dist/main.js",
@@ -14,7 +14,6 @@
   "license": "MIT",
   "homepage": "https://storybook-document.regulaforensics.com/",
   "scripts": {
-    "start": "webpack serve --config webpack.dev.js",
     "build-face": "npm run clean-lib && npm run generate-face-types && webpack --config webpack.face-umd.js",
     "build-document": "npm run clean-lib && npm run generate-document-types && webpack --config webpack.document-umd.js && webpack --config webpack.document-esm.js",
     "storybook": "start-storybook -p 6006 -c .storybook-development -h localhost",
@@ -24,6 +23,8 @@
     "build-storybook-document-rc": "build-storybook -c .storybook-rc/document",
     "build-storybook-face-release": "build-storybook -c .storybook-release/face",
     "build-storybook-document-release": "build-storybook -c .storybook-release/document",
+    "build-storybook-document-beta": "build-storybook -c .storybook-beta/document",
+    "build-storybook-face-beta": "build-storybook -c .storybook-beta/face",
     "generate-dictionaries": "node scripts/xml-dictionary-parser/index.js Translator.xml src/i18n/dictionaries",
     "clean-lib": "rm -rf ./lib",
     "generate-face-types": "tsc --project ./configs/face.tsconfig.json",
@@ -35,9 +36,8 @@
     "*.{js,ts,tsx}": "eslint --fix"
   },
   "dependencies": {
-    "@regulaforensics/document-reader-webclient": "^6.3.2",
     "@regulaforensics/facesdk-webclient": "^3.1.2",
-    "@webcomponents/webcomponentsjs": "^2.6.0",
+    "@webcomponents/webcomponentsjs": "~2.6.0",
     "localize-react": "^1.7.1",
     "react": "^18.2.0",
     "react-device-detect": "^2.2.2",
@@ -57,13 +57,14 @@
     "@regulaforensics/vp-frontend-face-components": "*",
     "@regulaforensics/vp-frontend-face-components-nightly": "*",
     "@regulaforensics/vp-frontend-face-components-rc": "*",
+    "@regulaforensics/vp-frontend-document-components-beta": "*",
+    "@regulaforensics/vp-frontend-face-components-beta": "*",
     "@storybook/addon-actions": "^6.5.13",
     "@storybook/addon-essentials": "^6.5.13",
     "@storybook/addon-links": "^6.5.13",
     "@storybook/builder-webpack5": "^6.5.13",
     "@storybook/manager-webpack5": "^6.5.13",
     "@storybook/react": "^6.5.13",
-    "@types/pako": "^1.0.3",
     "@types/react": "^18.0.21",
     "@types/react-dom": "^18.0.6",
     "@types/uuid": "^8.3.4",
@@ -79,7 +80,6 @@
     "eslint-plugin-react": "^7.31.8",
     "fast-xml-parser": "^4.0.10",
     "he": "^1.2.0",
-    "html-webpack-plugin": "^5.5.0",
     "husky": "^8.0.0",
     "lint-staged": "^13.0.3",
     "prettier": "^2.7.1",

package/lib/common/InstructionIconFaceDetection.d.ts

@@ -1,5 +0,0 @@
-/// <reference types="react" />
-declare function InstructionIconFaceDetection({ size }: {
-    size?: number;
-}): JSX.Element;
-export default InstructionIconFaceDetection;

package/lib/common/InstructionIconFaceLiveness.d.ts

@@ -1,5 +0,0 @@
-/// <reference types="react" />
-declare function InstructionIconFaceLiveness({ size }: {
-    size?: number;
-}): JSX.Element;
-export default InstructionIconFaceLiveness;

package/lib/common/NoGlareIcon.d.ts

@@ -1,5 +0,0 @@
-/// <reference types="react" />
-declare function NoGlareIcon({ size }: {
-    size?: number;
-}): JSX.Element;
-export default NoGlareIcon;

package/lib/common/NoSmilingIcon.d.ts

@@ -1,5 +0,0 @@
-/// <reference types="react" />
-declare function NoSmilingIcon({ size }: {
-    size?: number;
-}): JSX.Element;
-export default NoSmilingIcon;

package/lib/components/InstructionScreen.d.ts

@@ -1,9 +0,0 @@
-/// <reference types="react" />
-declare type InstructionScreenProps = {
-    onStart: () => void;
-    icon: string;
-    title: string;
-    subtitle: string;
-};
-declare function InstructionScreen({ onStart, icon, title, subtitle }: InstructionScreenProps): JSX.Element;
-export default InstructionScreen;

package/lib/components/RetryScreen.d.ts

@@ -1,7 +0,0 @@
-/// <reference types="react" />
-declare type RetryScreenProps = {
-    errorCode: number;
-    onReset: () => void;
-};
-declare function RetryScreen({ errorCode, onReset }: RetryScreenProps): JSX.Element;
-export default RetryScreen;