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

package/lib/services/DocumentReaderProcessor.d.ts

@@ -16,7 +16,7 @@ declare class DocumentReaderProcessor {
     private _isProcessing;
     private _pageIdx;
     constructor(videoElement?: HTMLVideoElement);
-    get streamParam(): StreamParams;
+    get streamParam(): Partial<StreamParams>;
     set streamParam(params: Partial<StreamSettings>);
     get recognizerProcessParam(): ProcessingRequest;
     set recognizerProcessParam(params: ProcessingRequest);

package/lib/services/DocumentReaderService.d.ts

@@ -21,9 +21,9 @@ declare class DocumentReaderService {
     get imageProcessParam(): ImageProcessingRequest;
     set imageProcessParam(params: ImageProcessingRequest);
     get isInitialized(): boolean;
-    private set isInitialized(value);
+    set isInitialized(value: boolean);
     get isPrepared(): boolean;
-    private set isPrepared(value);
+    set isPrepared(value: boolean);
     get isProcessing(): boolean;
     get prepareListener(): PrepareListener | null;
     set prepareListener(listener: PrepareListener | null);

package/lib/services/FaceLivenessService.d.ts

@@ -1,55 +1,20 @@
 import EventEmitter from './EventEmitter';
 import CameraModel from '../models/CameraModel';
-declare type ConfigParams = {
-    ballSmoothingWeight: number;
-    ballVelocityX: number;
-    ballVelocityY: number;
-    debugOutput: boolean | undefined;
-    dontShowReadinessTimeoutMs: number;
-    fitFaceMultNear: number;
-    fixFaceOrientationMsgDurationMs: number;
-    fixFaceOrientationMsgTimeoutMs: number;
-    frameHeight: number;
-    frameWidth: number;
-    holdStillIOUMinNear: number;
-    holdStillIOUMinNormal: number;
-    holdStillNearTimeoutMs: number;
-    holdStillNormalTimeoutMs: number;
-    lookStraightMsgTimeoutMs: number;
-    maxPitchNear: number;
-    maxPitchNormal: number;
-    maxRollNormal: number;
-    maxYawNear: number;
-    maxYawNormal: number;
-    minReadiness: number;
-    moveAwayMultNear: number;
-    moveCloserMultNear: number;
-    nearTimeoutMs: number;
-    noMovementIOUMax: number;
-    noMovementMsgTimeoutMs: number;
-    normalTimeoutMs: number;
-    numChannels: number;
-    numSectors: number;
-    pin: number[];
-    resizedFrameHeight: number;
-    resizedFrameWidth: number;
-};
-export declare type InitializedLivenessDetectionData = {
-    config: ConfigParams;
+import { ConfigLivenessParams } from '../types';
+declare type InitializedFaceLivenessData = {
+    config: ConfigLivenessParams;
     publicKey: string;
     schema: string;
     sessionId: string;
     transactionId: string;
     metadata: {
-        serverTime: string;
+        platform: string;
+        osVersion: string;
         sdkVersion: string;
         hostAppId: string;
         deviceModel: string;
-        camera: CameraModel;
-        deviceCameras: {
-            frontCameras: CameraModel[];
-            backCameras: CameraModel[];
-        };
+        currentCameraId: string;
+        cameraState: CameraModel[];
         ctx: {
             userIp: string;
         };
@@ -70,7 +35,7 @@ export declare type InitializedFaceCaptureData = {
         camera: CameraModel;
     };
 };
-declare type InitializeData = InitializedLivenessDetectionData | InitializedFaceCaptureData;
+declare type InitializeData = InitializedFaceLivenessData | InitializedFaceCaptureData;
 declare type ParamsData = {
     initializedData: InitializeData;
 };

package/lib/services/FaceService.d.ts

@@ -1,5 +1,4 @@
-import { FaceLivenessResultType } from '../types';
-import { InitializedLivenessDetectionData } from './FaceLivenessService';
+import { ConfigLivenessParams, FaceLivenessResultType } from '../types';
 import CameraModel from '../models/CameraModel';
 declare type GetLivenessDetectionResultOptions = {
     transactionId: string;
@@ -16,8 +15,21 @@ declare type DeviceMetadata = {
     currentCameraId: string;
     cameraState: CameraModel[];
 };
+declare type InitializedFaceLivenessDataResult = {
+    config: ConfigLivenessParams;
+    metadata: {
+        ctx: {
+            userIp: string;
+        };
+        serverTime: string;
+    };
+    publicKey: string;
+    schema: string;
+    sessionId: string;
+    transactionId: string;
+};
 declare function getLivenessDetectionResult(encryptedBody: Uint8Array, { transactionId, backendURL, headers, publicKey }: GetLivenessDetectionResultOptions): Promise<FaceLivenessResultType>;
-declare function getInitialisingData(deviceMetadata: DeviceMetadata, sessionId?: string, backendUrl?: string): Promise<InitializedLivenessDetectionData>;
+declare function getInitialisingData(deviceMetadata: DeviceMetadata, sessionId?: string, backendUrl?: string): Promise<InitializedFaceLivenessDataResult>;
 declare const _default: {
     getInitialisingData: typeof getInitialisingData;
     getLivenessDetectionResult: typeof getLivenessDetectionResult;

package/lib/types.d.ts

@@ -98,21 +98,61 @@ export declare type UserAgentType = {
     vendor: string;
     vendorSub: string;
 };
+export declare type ConfigLivenessParams = {
+    ballSmoothingWeight: number;
+    circleRadiusToMinDim: number;
+    compressDepthMap: boolean;
+    debugOutput: boolean | undefined;
+    depthMapBits: number;
+    distNormalMaxDeviation: number;
+    dontShowReadinessTimeoutMs: number;
+    faceBestHeight: number;
+    fitFaceMultNear: number;
+    frameHeight: number;
+    frameWidth: number;
+    holdStillNearTimeoutMs: number;
+    holdStillNormalTimeoutMs: number;
+    maxPitchNear: number;
+    maxPitchNormal: number;
+    maxRollNormal: number;
+    maxYawNear: number;
+    maxYawNormal: number;
+    minReadinessNear: number;
+    minReadinessNormal: number;
+    moveAwayMultNear: number;
+    moveCloserMultNear: number;
+    nearTimeoutMs: number;
+    normalTimeoutMs: number;
+    numChannels: number;
+    numSectors: number;
+    pin: number[];
+    resizedFrameHeight: number;
+    resizedFrameWidth: number;
+    scenario: number;
+    showGraySectors: boolean;
+    showHintDurationMs: number;
+    showHintTimeoutMs: number;
+    sizeNormalMaxDeviation: number;
+    targetSectorRelChange: number;
+};
 export declare type FaceLivenessResultType = {
     code: number;
-    elapsed: string;
+    config: ConfigLivenessParams;
+    elapsed: number;
     metadata: {
         ctx: {
             userIp: string;
         };
         serverTime: string;
     };
+    portrait: string;
+    sessionId: string;
     status: number;
+    transactionId: string;
+    video: string;
 };
 export declare type FaceLivenessResponseType = FaceLivenessResultType & {
     images: Array<string>;
-    transactionId: string;
-    sessionId: string;
 };
 export declare type FaceDetectionResponseType = {
     capture: Array<string>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@regulaforensics/vp-frontend-document-components",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "description": "Regula framework agnostic web components to work with webcamera",
   "types": "lib/types.d.ts",
   "main": "dist/main.js",
@@ -37,7 +37,7 @@
   },
   "dependencies": {
     "@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",