@regulaforensics/idv-face 3.1.239 → 3.2.3-nightly

package/README.md

@@ -1,6 +1,35 @@
-# Face-idv module
+# Face-IDV Module
 
+The **idv-face** module is an npm package plugin designed to work with **FaceSDK** via a Web Component:  
+https://www.npmjs.com/package/@regulaforensics/vp-frontend-face-components
 
-Module which works with face web component.
+It is delivered as part of the **IDV Capturing** solution and has a version synchronized with **idv-capture-web**. Currently, compatibility is guaranteed at the **major.minor** version level.
+
+## What the Module Is
+
+The module is an **npm package** that **exports a Web Component**, inside which the **Lit** framework (LitJS) is used for rendering and component logic.
+
+## FaceSDK Versioning
+
+This module declares a **peerDependency** on:  
+https://www.npmjs.com/package/@regulaforensics/vp-frontend-face-components  
+to ensure compatibility with specific versions of FaceSDK.
+
+- If the root project already has a version of `vp-frontend-face-components` installed and it matches the allowed versions in `peerDependencies`, that version will be used.
+- If the installed version does **not** match, then starting from **npm v7+**, npm will automatically install a suitable version.
+- In earlier versions of npm, the application developer must manually install the required compatible version.
+
+## How It Works
+
+The module receives typed configuration data following the unified interface used by all **idv-capture-web** modules.  
+The type definitions for the Face-IDV module configuration are located inside this package.
+
+The Web Component then interacts with `vp-frontend-face-components`, which communicates with the **FaceSDK service**.
+
+## Module Output
+
+The result of execution can be either:
+
+- **Data** for submission to the platform, or  
+- A typed **BaseError**, which contains detailed information explaining why the module failed.
 
-Exports React component which can be used in Idv-capture-web-components and IDV Platform

package/dist/index.d.ts

@@ -1,38 +1,31 @@
-import { FaceLivenessDetailType } from '@regulaforensics/vp-frontend-face-components';
-import { FaceLivenessWebComponent } from '@regulaforensics/vp-frontend-face-components';
+import { LitElement } from 'lit';
 import { RecordingProcess } from '@regulaforensics/vp-frontend-face-components';
+import { TemplateResult } from 'lit-html';
 
 declare abstract class BaseModule<TModuleProps = unknown, TModulesConfig = unknown> extends HTMLElement {
     abstract props: IdvModuleProps<TModuleProps, TModulesConfig> | null;
     abstract setProps(config: IdvModuleProps<TModuleProps, TModulesConfig>): void;
 }
 
-declare class FaceIdv extends BaseModule<FaceIdvProps, FaceIdvModulesConfig> {
-    props: IdvModuleProps<FaceIdvProps, FaceIdvModulesConfig> | null;
-    webComponent: FaceLivenessWebComponent | null;
-    private _mounted;
-    private _isFinishWithExitOnce;
-    constructor();
-    static displayName: string;
-    listener: (data: CustomEvent<FaceLivenessDetailType>) => void;
-    setProps(props: IdvModuleProps<FaceIdvProps, FaceIdvModulesConfig>): void;
-    connectedCallback(): void;
-    render(): void;
-    disconnectedCallback(): void;
+export declare class FaceIdv extends LitElement implements BaseModule<FaceModuleProps, object> {
+    props: IdvModuleProps<FaceModuleProps, object> | null;
+    setProps(props: IdvModuleProps<FaceModuleProps, object>): void;
     static isReady(): boolean;
     static getSupportedTemplates: () => FaceIdvSteps[];
-    static initialize(modulesConfig: Record<string, unknown>): void;
+    static initialize(_modulesConfig: Record<string, unknown>): void;
     static deinitialize(): void;
     static getIdentifier: () => string;
+    static displayName: string;
+    render(): TemplateResult<1>;
 }
-export { FaceIdv }
-export default FaceIdv;
 
-declare type FaceIdvModulesConfig = object;
+declare enum FaceIdvSteps {
+    LIVENESS = "LIVENESS"
+}
 
-declare type FaceIdvProps = {
+declare type FaceModuleProps = {
     config?: {
-        skipSteps?: ['ONBOARDING_STEP' | 'SUCCESS_STEP'];
+        skipSteps?: Array<'ONBOARDING_STEP' | 'SUCCESS_STEP'>;
         attemptsCount?: number;
         copyright?: boolean;
         recordingProcess?: RecordingProcessKeys;
@@ -44,6 +37,44 @@ declare type FaceIdvProps = {
         workerPath?: string;
         detectOcclusion?: boolean;
         metadata?: Record<string, unknown>;
+        nonce?: string;
+    };
+    customization?: {
+        onboardingScreenStartButtonBackground?: string;
+        onboardingScreenStartButtonTitle?: string;
+        onboardingScreenIllumination?: string;
+        onboardingScreenAccessories?: string;
+        onboardingScreenCameraLevel?: string;
+        cameraScreenFrontHintLabelText?: string;
+        cameraScreenFrontHintLabelBackground?: string;
+        cameraScreenStrokeNormal?: string;
+        cameraScreenSectorTarget?: string;
+        cameraScreenSectorActive?: string;
+        processingScreenProgress?: string;
+        successScreenImage?: string;
+        retryScreenRetryButtonTitle?: string;
+        retryScreenRetryButtonBackground?: string;
+        retryScreenHintSubject?: string;
+        retryScreenHintEnvironment?: string;
+        onboardingScreenStartButton?: string;
+        onboardingScreenTitleLabelText?: string;
+        onboardingScreenTitleLabel?: string;
+        onboardingScreenSubtitleLabelText?: string;
+        onboardingScreenSubtitleLabel?: string;
+        cameraScreenHintLabel?: string;
+        retryScreenTitleLabelText?: string;
+        retryScreenTitleLabel?: string;
+        retryScreenSubtitleLabelText?: string;
+        retryScreenSubtitleLabel?: string;
+        retryScreenHintLabelsText?: string;
+        retryScreenHintLabels?: string;
+        retryScreenRetryButton?: string;
+        fontSize?: string;
+        fontFamily?: string;
+        onboardingScreenStartButtonBackgroundHover?: string;
+        onboardingScreenStartButtonTitleHover?: string;
+        retryScreenRetryButtonTitleHover?: string;
+        retryScreenRetryButtonBackgroundHover?: string;
     };
     copyright: boolean;
     serviceURL?: string;
@@ -54,18 +85,21 @@ declare type FaceIdvProps = {
     serviceToken?: string;
 };
 
-declare enum FaceIdvSteps {
-    LIVENESS = "LIVENESS"
-}
-
 declare type IdvModuleProps<TModuleProps, TModulesConfig> = {
     isProcessing?: (isProcessing: boolean) => void;
     moduleProps: TModuleProps;
     modulesConfig?: TModulesConfig;
-    perform: (data: any) => void;
+    perform: (data: any, type?: PerformType) => void;
     idvEventListener: (module: string, data: any) => void;
 };
 
+declare type PerformType = (typeof performType)[keyof typeof performType] | undefined;
+
+declare const performType: {
+    readonly FORM: "form";
+    readonly DATA: "data";
+};
+
 declare type RecordingProcessKeys = keyof typeof RecordingProcess;
 
 export { }