@regulaforensics/idv-gui 3.1.239 → 3.2.3-nightly

package/README.md

@@ -1,5 +1,21 @@
-# Idv-gui module
+# Idv Gui Module
 
-Module which contains UI screens (Info screens , Instruction Screens, etc)
+The **idv-gui** module is an npm package plugin that renders client-side workflow steps according to predefined templates.
+
+
+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 **Preact** framework is used for rendering and component logic.
+## How It Works
+
+The module receives typed configuration data following the unified interface used by all **idv-capture-web** modules.  
+
+## 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.
 
-Module exports React Component which can be used in Idv-capture-web component, Idv Platform

package/dist/index.d.ts

@@ -1,24 +1,25 @@
-import { JSX as JSX_2 } from 'react/jsx-runtime';
+import { FunctionComponent } from 'preact';
+import { JSX } from 'preact';
 
 declare function AgeIcon({ size }: {
     size?: number;
     color?: string;
-}): JSX_2.Element;
+}): JSX.Element;
 
 declare function AndroidIcon({ size, color }: {
     size?: number;
     color?: string;
-}): JSX_2.Element;
+}): JSX.Element;
 
 declare function ArrowIcon({ size }: {
     size?: number;
     color?: string;
-}): JSX_2.Element;
+}): JSX.Element;
 
 declare function BackIcon({ size }: {
     size?: number;
     color?: string;
-}): JSX_2.Element;
+}): JSX.Element;
 
 declare abstract class BaseModule<TModuleProps = unknown, TModulesConfig = unknown> extends HTMLElement {
     abstract props: IdvModuleProps<TModuleProps, TModulesConfig> | null;
@@ -28,7 +29,7 @@ declare abstract class BaseModule<TModuleProps = unknown, TModulesConfig = unkno
 declare function BiometricIcon({ size }: {
     size?: number;
     color?: string;
-}): JSX_2.Element;
+}): JSX.Element;
 
 declare const ContentMode: {
     readonly ASPECT_FILL: "ASPECT_FILL";
@@ -59,11 +60,11 @@ declare type DropdownControl = {
 declare function ErrorIcon({ size, color }: {
     size?: number;
     color?: string;
-}): JSX_2.Element;
+}): JSX.Element;
 
-declare class GuiIdv extends BaseModule<GuiModuleProps, GuiModuleConfig> {
-    private _root;
+export declare class GuiIdv extends BaseModule<GuiModuleProps, GuiModuleConfig> {
     private _mounted;
+    private _shadowRoot;
     props: IdvModuleProps<GuiModuleProps, GuiModuleConfig> | null;
     constructor();
     static displayName: string;
@@ -72,15 +73,13 @@ declare class GuiIdv extends BaseModule<GuiModuleProps, GuiModuleConfig> {
     private render;
     disconnectedCallback(): void;
     static isReady(): boolean;
-    static getSupportedTemplates: () => ("INFO" | "INFO_DETAILS" | "STATUS" | "PROGRESS" | "QUESTIONS" | "CAMERA" | "GALLERY")[];
-    static initialize(modulesConfig: Record<string, unknown>): void;
+    static getSupportedTemplates: () => ("INFO" | "INFO_DETAILS" | "STATUS" | "PROGRESS" | "QUESTIONS" | "CAMERA" | "GALLERY" | "GEOLOCATION")[];
+    static initialize(_modulesConfig: Record<string, unknown>): void;
     static deinitialize(): void;
     static getIdentifier: () => string;
 }
-export { GuiIdv }
-export default GuiIdv;
 
-export declare const GuiIdvReactComponent: React.FC<IdvModuleProps<GuiModuleProps | GuiModulePropsUnknown, GuiModuleConfig>>;
+export declare const GuiIdvReactComponent: FunctionComponent<IdvModuleProps<GuiModuleProps | GuiModulePropsUnknown, GuiModuleConfig>>;
 
 export declare const GuiIdvSteps: {
     readonly INFO: "INFO";
@@ -90,13 +89,12 @@ export declare const GuiIdvSteps: {
     readonly QUESTIONS: "QUESTIONS";
     readonly CAMERA: "CAMERA";
     readonly GALLERY: "GALLERY";
+    readonly GEOLOCATION: "GEOLOCATION";
 };
 
 export declare type GuiIdvSteps = (typeof GuiIdvSteps)[keyof typeof GuiIdvSteps];
 
-export declare const GuiIdvStyleInjectionWrapper: React.FC<{
-    children: React.ReactNode;
-}>;
+export declare const GuiIdvStyleInjectionWrapper: FunctionComponent;
 
 declare type GuiModuleConfig = Record<string, any>;
 
@@ -127,6 +125,7 @@ declare type GuiModulePropsMap = {
     [GuiIdvSteps.QUESTIONS]: UIQuestionsScreenClientConfig;
     [GuiIdvSteps.CAMERA]: UICameraScreenClientConfig;
     [GuiIdvSteps.GALLERY]: UIGalleryScreenClientConfig;
+    [GuiIdvSteps.GEOLOCATION]: UIGeolocationScreenClientConfig;
 };
 
 export declare type GuiModulePropsUnknown = {
@@ -174,7 +173,7 @@ export declare const idvIconComponents: {
     warning_icon: typeof WarningIcon;
     spinner: ({ indicatorColor }: {
         indicatorColor?: string;
-    }) => JSX_2.Element;
+    }) => JSX.Element;
     failure: typeof ErrorIcon;
     age: typeof AgeIcon;
     android: typeof AndroidIcon;
@@ -182,7 +181,7 @@ export declare const idvIconComponents: {
     apple: ({ size, color }: {
         size?: number;
         color?: string;
-    }) => JSX_2.Element;
+    }) => JSX.Element;
     back: typeof BackIcon;
     biometricIcon: typeof BiometricIcon;
     info: typeof InfoIcon;
@@ -191,53 +190,53 @@ export declare const idvIconComponents: {
     cross: ({ size, color }: {
         size?: number;
         color?: string;
-    }) => JSX_2.Element;
+    }) => JSX.Element;
     regulaLogo: ({ size, color }: {
         size?: number;
         color?: string;
-    }) => JSX_2.Element;
-    empty: () => JSX_2.Element;
+    }) => JSX.Element;
+    empty: () => JSX.Element;
     signature: typeof PoweredByRegula;
     success: ({ size, color }: {
         size?: number;
         color?: string;
-    }) => JSX_2.Element;
-    radio_selected: () => JSX_2.Element;
-    radio_normal: () => JSX_2.Element;
-    square_selected: () => JSX_2.Element;
-    square_normal: () => JSX_2.Element;
+    }) => JSX.Element;
+    radio_selected: () => JSX.Element;
+    radio_normal: () => JSX.Element;
+    square_selected: () => JSX.Element;
+    square_normal: () => JSX.Element;
     selected: ({ color }: {
         color?: string | undefined;
-    }) => JSX_2.Element;
+    }) => JSX.Element;
     chevronDown: ({ color }: {
         color?: string | undefined;
-    }) => JSX_2.Element;
+    }) => JSX.Element;
     close_icon: ({ size, color }: {
         size?: number;
         color?: string;
-    }) => JSX_2.Element;
+    }) => JSX.Element;
     gallery: ({ size, color }: {
         size?: number;
         color?: string;
-    }) => JSX_2.Element;
+    }) => JSX.Element;
     camera: ({ size, color }: {
         size?: number;
         color?: string;
-    }) => JSX_2.Element;
+    }) => JSX.Element;
 };
 
 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 function InfoIcon({ size, color }: {
     size?: number;
     color?: string;
-}): JSX_2.Element;
+}): JSX.Element;
 
 declare type JsonArray = JsonValue[];
 
@@ -247,7 +246,14 @@ declare type JsonObject = {
 
 declare type JsonValue = string | number | boolean | null | JsonObject | JsonArray;
 
-declare function PoweredByRegula(): JSX_2.Element;
+declare type PerformType = (typeof performType)[keyof typeof performType] | undefined;
+
+declare const performType: {
+    readonly FORM: "form";
+    readonly DATA: "data";
+};
+
+declare function PoweredByRegula(): JSX.Element;
 
 declare type QuestionDataSource = {
     id: string | number;
@@ -334,7 +340,7 @@ declare type TextAlignment = (typeof TextAlignment)[keyof typeof TextAlignment];
 declare function ToMobileIcon({ size }: {
     size?: number;
     color?: string;
-}): JSX_2.Element;
+}): JSX.Element;
 
 declare type UIButton = {
     type?: 'RESPONSE_BODY' | 'FORM';
@@ -406,6 +412,18 @@ declare type UIGalleryScreenClientConfig = {
     selectionLimit?: number;
 };
 
+declare type UIGeolocationScreenClientConfig = {
+    header?: UIInfoHeaderView;
+    title?: UILabel;
+    image?: UIImage;
+    description?: UILabel;
+    buttons?: UIButton[];
+    footer?: UIInfoFooterView;
+    backgroundColor?: string;
+    popups: UIPopup[];
+    askEveryTime?: boolean;
+};
+
 declare type UIImage = {
     imageURL?: string;
     base64?: string;
@@ -464,6 +482,20 @@ declare type UIMultiSelectorQuestion = QuestionItem & {
     dropdownPicker: UIDropdownPicker;
 };
 
+declare type UIPopup = {
+    reason: 'system_restricted';
+    actionButton1: {
+        title?: UILabel;
+        type: 'FORM';
+        backgroundColor?: string;
+        cornerRadius?: number;
+    };
+    title?: UILabel;
+    message?: UILabel;
+    backgroundColor?: string;
+    cornerRadius?: number;
+};
+
 declare type UIProgressScreenClientConfig = {
     header?: UIInfoHeaderView;
     progressView?: UIProgressView;
@@ -545,7 +577,7 @@ declare type UITextQuestion = QuestionItem & {
 declare function UnderageIcon({ size }: {
     size?: number;
     color?: string;
-}): JSX_2.Element;
+}): JSX.Element;
 
 declare type Validator = {
     type: typeof VALIDATOR_TYPE.NOT_EMPTY;
@@ -566,6 +598,6 @@ declare type VALIDATOR_TYPE = (typeof VALIDATOR_TYPE)[keyof typeof VALIDATOR_TYP
 declare function WarningIcon({ size, color }: {
     size?: number;
     color?: string;
-}): JSX_2.Element;
+}): JSX.Element;
 
 export { }