@regulaforensics/idv-document 3.1.239 → 3.2.3-nightly

package/README.md

@@ -1,5 +1,57 @@
-# Document-idv module
+# Document Reader IDV Module
 
-Module which works with document web component.
+The **idv-document** module is an npm package plugin designed to work with **DocreaderSDK** via a Web Component:  
+https://www.npmjs.com/package/@regulaforensics/vp-frontend-document-components
+
+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.
+
+## DocreaderSDK Versioning
+
+This module declares a **peerDependency** on:  
+https://www.npmjs.com/package/@regulaforensics/vp-frontend-document-components  
+to ensure compatibility with specific versions of DocreaderSDK.
+
+- If the root project already has a version of `vp-frontend-document-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 Docreader IDV module configuration are located inside this package.
+
+The Web Component then interacts with `vp-frontend-document-components`, which communicates with the **DocreaderSDK 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.
+
+
+## Important Note: Licensing
+
+Licensing for this module is **domain-based**.  
+However, you may also provide a **development license (`devLicense`)**, encoded in **Base64**.
+
+### Providing a devLicense in Ready for Production mode
+
+When running in a production environment, you can pass a development license to the module via `moduleProps` in the parent component service of **idv-capture-web**.
+
+### Providing a devLicense for Development
+
+If the module is used **for development purposes**, the license can be supplied using:
+
+```ts
+modulesConfig: {
+    docreader: {
+        devLicense: string;
+    };
+}
+```
 
-Exports React component which can be used in Idv-capture-web-components and IDV Platform

package/dist/index.d.ts

@@ -1,47 +1,60 @@
-import { DocumentReaderDetailType } from '@regulaforensics/vp-frontend-document-components';
-import { DocumentReaderWebComponent } from '@regulaforensics/vp-frontend-document-components';
 import { InternalScenarios } from '@regulaforensics/vp-frontend-document-components';
+import { LitElement } from 'lit';
 import { MirrorType } from '@regulaforensics/vp-frontend-document-components';
-import { TransactionEvent } from '@regulaforensics/vp-frontend-document-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 DocumentIdv extends BaseModule<DocumentModuleProps, DocumentModulesConfig> {
+declare type DocumentGalleryProps = {
+    processParam?: {
+        multipageProcessing?: boolean;
+        scenario: string;
+        internalScenario: string | InternalScenarios;
+        backendProcessing?: {
+            serviceURL?: string;
+            rfidServerSideChipVerification?: boolean;
+        };
+    };
+    selectionLimit: number;
+    templateId: typeof DocumentIdvSteps.DOC_READER_GALLERY;
+    backgroundColor: string;
+    tag?: string;
+    sessionId?: string;
+    serviceToken?: string;
+    locale?: string;
+};
+
+export declare class DocumentIdv extends LitElement implements BaseModule<DocumentModuleProps, DocumentModulesConfig> {
     props: IdvModuleProps<DocumentModuleProps, DocumentModulesConfig> | null;
-    webComponent: DocumentReaderWebComponent | null;
-    constructor();
-    static displayName: string;
-    listener: (data: CustomEvent<DocumentReaderDetailType | TransactionEvent>) => void;
-    private prepareStyles;
-    private injectStyles;
-    private prepareSettings;
     setProps(props: IdvModuleProps<DocumentModuleProps, DocumentModulesConfig>): void;
-    setDocReaderProps(props: IdvModuleProps<DocumentModuleProps, DocumentModulesConfig>): void;
-    setDocReaderGalleryProps(props: IdvModuleProps<DocumentModuleProps, DocumentModulesConfig>): void;
-    connectedCallback(): void;
-    private getFilesAndProcess;
-    private render;
-    private renderDocReader;
-    private renderDocReaderGallery;
-    disconnectedCallback(): void;
     static isReady(): boolean;
-    static getSupportedTemplates: () => DocumentIdvSteps[];
+    static getSupportedTemplates(): ("DOC_READER" | "DOC_READER_GALLERY")[];
     static initialize(modulesConfig: DocumentModulesConfig): void;
     static deinitialize(): void;
-    static getIdentifier: () => string;
+    static getIdentifier(): string;
+    static displayName: string;
+    render(): TemplateResult<1>;
 }
-export { DocumentIdv }
-export default DocumentIdv;
 
-declare enum DocumentIdvSteps {
-    DOC_READER = "DOC_READER",
-    DOC_READER_GALLERY = "DOC_READER_GALLERY"
-}
+declare const DocumentIdvSteps: {
+    readonly DOC_READER: "DOC_READER";
+    readonly DOC_READER_GALLERY: "DOC_READER_GALLERY";
+};
+
+declare type DocumentIdvSteps = (typeof DocumentIdvSteps)[keyof typeof DocumentIdvSteps];
+
+declare type DocumentModuleProps = DocumentGalleryProps | DocumentReaderProps;
+
+declare type DocumentModulesConfig = {
+    docreader: {
+        devLicense: string;
+    };
+};
 
-declare type DocumentModuleProps = {
+declare type DocumentReaderProps = {
     processParam?: {
         multipageProcessing?: boolean;
         scenario: string;
@@ -79,7 +92,7 @@ declare type DocumentModuleProps = {
         maxImageSize?: number;
         maxResolutionSize?: number;
     };
-    customization: {
+    customization?: {
         cameraFrameWidthOffset?: number;
         backgroundMaskAlpha?: number;
         backgroundMaskColor?: string;
@@ -118,26 +131,26 @@ declare type DocumentModuleProps = {
     };
     copyright?: boolean;
     tag?: string;
-    templateId: string;
+    templateId: typeof DocumentIdvSteps.DOC_READER;
     sessionId?: string;
     serviceToken?: string;
     locale?: string;
     backgroundColor?: string;
-    selectionLimit?: number;
-};
-
-declare type DocumentModulesConfig = {
-    docreader: {
-        devLicense: string;
-    };
 };
 
 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";
+};
+
 export { }