@regulaforensics/idv-gui 2.5.195 → 2.5.196-nightly

package/dist/index.d.ts

@@ -1,3 +1,35 @@
+import { JSX as JSX_2 } from 'react/jsx-runtime';
+
+declare function AgeIcon({ size }: {
+    size?: number;
+    color?: string;
+}): JSX_2.Element;
+
+declare function AndroidIcon({ size, color }: {
+    size?: number;
+    color?: string;
+}): JSX_2.Element;
+
+declare function ArrowIcon({ size }: {
+    size?: number;
+    color?: string;
+}): JSX_2.Element;
+
+declare function BackIcon({ size }: {
+    size?: number;
+    color?: string;
+}): JSX_2.Element;
+
+declare abstract class BaseModule<TModuleProps = unknown, TModulesConfig = unknown> extends HTMLElement {
+    abstract props: IdvModuleProps<TModuleProps, TModulesConfig> | null;
+    abstract setProps(config: IdvModuleProps<TModuleProps, TModulesConfig>): void;
+}
+
+declare function BiometricIcon({ size }: {
+    size?: number;
+    color?: string;
+}): JSX_2.Element;
+
 declare const ContentMode: {
     readonly ASPECT_FILL: "ASPECT_FILL";
     readonly ASPECT_FIT: "ASPECT_FIT";
@@ -14,9 +46,42 @@ declare const DATA_SOURCE_ANSWER_TYPE: {
 
 declare type DATA_SOURCE_ANSWER_TYPE = (typeof DATA_SOURCE_ANSWER_TYPE)[keyof typeof DATA_SOURCE_ANSWER_TYPE];
 
-declare const GuiIdv: React.FC<IdvModuleProps<GuiModuleProps | GuiModulePropsUnknown, GuiModuleConfig>> & IdvModuleMethods;
+declare type DropdownControl = {
+    backgroundColor?: string;
+    cornerRadius?: number;
+    borderWidth?: number;
+    borderColor?: string;
+    highlightBorderColor?: string;
+    clearButton?: UIImage;
+    expandButton?: UIImage;
+};
+
+declare function ErrorIcon({ size, color }: {
+    size?: number;
+    color?: string;
+}): JSX_2.Element;
+
+declare class GuiIdv extends BaseModule<GuiModuleProps, GuiModuleConfig> {
+    private _root;
+    private _mounted;
+    props: IdvModuleProps<GuiModuleProps, GuiModuleConfig> | null;
+    constructor();
+    static displayName: string;
+    setProps(props: IdvModuleProps<GuiModuleProps, GuiModuleConfig>): void;
+    connectedCallback(): void;
+    private render;
+    disconnectedCallback(): void;
+    static isReady(): boolean;
+    static getSupportedTemplates: () => ("INFO" | "INFO_DETAILS" | "STATUS" | "PROGRESS" | "QUESTIONS")[];
+    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 GuiIdvSteps: {
     readonly INFO: "INFO";
     readonly INFO_DETAILS: "INFO_DETAILS";
@@ -27,6 +92,10 @@ export declare const GuiIdvSteps: {
 
 export declare type GuiIdvSteps = (typeof GuiIdvSteps)[keyof typeof GuiIdvSteps];
 
+export declare const GuiIdvStyleInjectionWrapper: React.FC<{
+    children: React.ReactNode;
+}>;
+
 declare type GuiModuleConfig = Record<string, any>;
 
 export declare const GuiModuleError: {
@@ -96,22 +165,82 @@ export declare const IDV_UI_ICONS: {
 
 export declare type IDV_UI_ICONS = (typeof IDV_UI_ICONS)[keyof typeof IDV_UI_ICONS];
 
-declare type IdvModuleMethods = {
-    isReady: () => boolean;
-    getSupportedTemplates: () => string[];
-    getIdentifier: () => string;
-    initialize: (modulesConfig: Record<string, any>) => void;
-    deinitialize?: () => void;
-};
-
-declare type IdvModuleProps<T, R> = {
+export declare const idvIconComponents: {
+    warning_icon: typeof WarningIcon;
+    spinner: ({ indicatorColor }: {
+        indicatorColor?: string;
+    }) => JSX_2.Element;
+    failure: typeof ErrorIcon;
+    age: typeof AgeIcon;
+    android: typeof AndroidIcon;
+    arrow: typeof ArrowIcon;
+    apple: ({ size, color }: {
+        size?: number;
+        color?: string;
+    }) => JSX_2.Element;
+    back: typeof BackIcon;
+    biometricIcon: typeof BiometricIcon;
+    info: typeof InfoIcon;
+    toMobile: typeof ToMobileIcon;
+    underage: typeof UnderageIcon;
+    cross: ({ size, color }: {
+        size?: number;
+        color?: string;
+    }) => JSX_2.Element;
+    regulaLogo: ({ size, color }: {
+        size?: number;
+        color?: string;
+    }) => JSX_2.Element;
+    empty: () => JSX_2.Element;
+    signature: typeof PoweredByRegula;
+    success: ({ size, color }: {
+        size?: number;
+        color?: string;
+    }) => JSX_2.Element;
+    onboardingScanYourId: () => JSX_2.Element;
+    onboardingReadRfidChip: () => JSX_2.Element;
+    onboardgTakeASelfie: () => JSX_2.Element;
+    prepareDocumentStep: () => JSX_2.Element;
+    prepareLivenessStep: () => JSX_2.Element;
+    radio_selected: () => JSX_2.Element;
+    radio_normal: () => JSX_2.Element;
+    square_selected: () => JSX_2.Element;
+    square_normal: () => JSX_2.Element;
+    selected: ({ color }: {
+        color?: string | undefined;
+    }) => JSX_2.Element;
+    chevronDown: ({ color }: {
+        color?: string | undefined;
+    }) => JSX_2.Element;
+    close_icon: ({ size, color }: {
+        size?: number;
+        color?: string;
+    }) => JSX_2.Element;
+};
+
+declare type IdvModuleProps<TModuleProps, TModulesConfig> = {
     isProcessing?: (isProcessing: boolean) => void;
-    moduleProps: T;
-    modulesConfig?: R;
+    moduleProps: TModuleProps;
+    modulesConfig?: TModulesConfig;
     perform: (data: any) => void;
     idvEventListener: (module: string, data: any) => void;
 };
 
+declare function InfoIcon({ size, color }: {
+    size?: number;
+    color?: string;
+}): JSX_2.Element;
+
+declare type JsonArray = JsonValue[];
+
+declare type JsonObject = {
+    [key: string]: JsonValue;
+};
+
+declare type JsonValue = string | number | boolean | null | JsonObject | JsonArray;
+
+declare function PoweredByRegula(): JSX_2.Element;
+
 declare type QuestionDataSource = {
     id: string | number;
     placeholder?: string | null;
@@ -194,11 +323,16 @@ declare const TextAlignment: {
 
 declare type TextAlignment = (typeof TextAlignment)[keyof typeof TextAlignment];
 
+declare function ToMobileIcon({ size }: {
+    size?: number;
+    color?: string;
+}): JSX_2.Element;
+
 declare type UIButton = {
     type?: 'RESPONSE_BODY' | 'FORM';
     title?: UILabel;
     image?: UIImage;
-    responseBody?: string | Record<string, any>;
+    responseBody?: JsonObject;
     backgroundColor?: string;
     cornerRadius?: number;
     highlightColor?: string;
@@ -208,6 +342,13 @@ declare type UIButton = {
 
 declare type UIButtonOption = UIButton;
 
+declare type UIChip = {
+    title?: UILabel;
+    removeImage?: UIImage;
+    cornerRadius?: number;
+    backgroundColor?: string;
+};
+
 declare type UIDetailsItem = {
     title?: UILabel;
     description?: UILabel;
@@ -222,6 +363,10 @@ declare type UIDetailsList = {
     cornerRadius: number;
 };
 
+declare type UIDropdownControl = DropdownControl & {
+    title: UILabel;
+};
+
 declare type UIDropdownOption = {
     title?: UILabel;
     image?: UIImage;
@@ -230,6 +375,13 @@ declare type UIDropdownOption = {
     highlightColor?: string;
 };
 
+declare type UIDropdownPicker = {
+    backgroundColor?: string;
+    cornerRadius?: number;
+    borderWidth?: number;
+    borderColor?: string;
+};
+
 declare type UIImage = {
     imageURL?: string;
     base64?: string;
@@ -276,10 +428,16 @@ declare type UILabel = {
     cornerRadius?: number;
 };
 
+declare type UIMultiDropdownControl = DropdownControl & {
+    chip: UIChip;
+};
+
 declare type UIMultiSelectorQuestion = QuestionItem & {
     displayType: typeof QUESTIONS_DISPLAY_TYPES.MULTI_SELECTOR_DROPDOWN;
     option: UIDropdownOption;
     optionSelected: UIDropdownOption;
+    dropdownControl: UIMultiDropdownControl;
+    dropdownPicker: UIDropdownPicker;
 };
 
 declare type UIProgressScreenClientConfig = {
@@ -290,7 +448,6 @@ declare type UIProgressScreenClientConfig = {
 };
 
 declare type UIProgressView = {
-    title?: UILabel;
     indicatorColor: string;
 };
 
@@ -325,6 +482,8 @@ declare type UISelectorDropdownQuestion = QuestionItem & {
     displayType: typeof QUESTIONS_DISPLAY_TYPES.SELECTOR_DROPDOWN;
     option: UIDropdownOption;
     optionSelected: UIDropdownOption;
+    dropdownControl: UIDropdownControl;
+    dropdownPicker: UIDropdownPicker;
 };
 
 declare type UISelectorOptionsQuestion = QuestionItem & {
@@ -339,6 +498,7 @@ declare type UIStatusScreenClientConfig = {
     header?: UIInfoHeaderView;
     image?: UIImage;
     title?: UILabel;
+    description: UILabel;
     buttons?: UIButton[];
     footer?: UIInfoFooterView;
     backgroundColor?: string;
@@ -358,6 +518,11 @@ declare type UITextQuestion = QuestionItem & {
     textField?: UITextField;
 };
 
+declare function UnderageIcon({ size }: {
+    size?: number;
+    color?: string;
+}): JSX_2.Element;
+
 declare type Validator = {
     type: typeof VALIDATOR_TYPE.NOT_EMPTY;
     message: string;
@@ -374,4 +539,9 @@ declare const VALIDATOR_TYPE: {
 
 declare type VALIDATOR_TYPE = (typeof VALIDATOR_TYPE)[keyof typeof VALIDATOR_TYPE];
 
+declare function WarningIcon({ size, color }: {
+    size?: number;
+    color?: string;
+}): JSX_2.Element;
+
 export { }