@regulaforensics/idv-gui 0.1.118-rc → 0.1.206-nightly

package/dist/index.d.ts

@@ -1,25 +1,117 @@
-declare enum ContentMode {
-    ASPECT_FILL = "ASPECT_FILL",
-    ASPECT_FIT = "ASPECT_FIT",
-    FILL = "FILL"
+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 const GuiIdv: React.FC<IdvModuleProps<GuiModuleProps, GuiModuleConfig>> & IdvModuleMethods;
+declare function BiometricIcon({ size }: {
+    size?: number;
+    color?: string;
+}): JSX_2.Element;
+
+declare const ContentMode: {
+    readonly ASPECT_FILL: "ASPECT_FILL";
+    readonly ASPECT_FIT: "ASPECT_FIT";
+    readonly FILL: "FILL";
+};
+
+declare type ContentMode = (typeof ContentMode)[keyof typeof ContentMode];
+
+declare const DATA_SOURCE_ANSWER_TYPE: {
+    readonly text: "text";
+    readonly selector: "selector";
+    readonly multiSelector: "multiSelector";
+};
+
+declare type DATA_SOURCE_ANSWER_TYPE = (typeof DATA_SOURCE_ANSWER_TYPE)[keyof typeof DATA_SOURCE_ANSWER_TYPE];
+
+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;
 
-declare const GuiIdvSteps: {
+export declare const GuiIdvReactComponent: React.FC<IdvModuleProps<GuiModuleProps | GuiModulePropsUnknown, GuiModuleConfig>>;
+
+export declare const GuiIdvSteps: {
     readonly INFO: "INFO";
     readonly INFO_DETAILS: "INFO_DETAILS";
     readonly STATUS: "STATUS";
     readonly PROGRESS: "PROGRESS";
+    readonly QUESTIONS: "QUESTIONS";
 };
 
+export declare type GuiIdvSteps = (typeof GuiIdvSteps)[keyof typeof GuiIdvSteps];
+
+export declare const GuiIdvStyleInjectionWrapper: React.FC<{
+    children: React.ReactNode;
+}>;
+
 declare type GuiModuleConfig = Record<string, any>;
 
-declare type GuiModuleProps = {
+export declare const GuiModuleError: {
+    readonly DECODING_FAILED: "DECODING_FAILED";
+};
+
+export declare type GuiModuleError = (typeof GuiModuleError)[keyof typeof GuiModuleError];
+
+export declare type GuiModuleProps = {
     [K in keyof GuiModulePropsMap]: {
-        templateId?: K;
-        templateLayout?: GuiModulePropsMap[K];
+        templateId: K;
+        templateLayout: GuiModulePropsMap[K];
+        dataSource?: QuestionsDataSource | null;
+        properties?: SessionPropertiesItem[];
+        sessionId?: string;
+        serviceToken?: string;
     };
 }[keyof GuiModulePropsMap];
 
@@ -28,40 +120,233 @@ declare type GuiModulePropsMap = {
     [GuiIdvSteps.INFO_DETAILS]: UIInfoDetailsScreenClientConfig;
     [GuiIdvSteps.PROGRESS]: UIProgressScreenClientConfig;
     [GuiIdvSteps.STATUS]: UIStatusScreenClientConfig;
+    [GuiIdvSteps.QUESTIONS]: UIQuestionsScreenClientConfig;
+};
+
+export declare type GuiModulePropsUnknown = {
+    templateId: string;
+    templateLayout?: Record<string, any>;
+    dataSource?: Record<string, unknown> | null;
+    sessionId?: string;
+    serviceToken?: string;
 };
 
-declare type IdvModuleMethods = {
-    isReady: () => boolean;
-    getSupportedTemplates: () => string[];
-    getIdentifier: () => string;
-    initialize: (modulesConfig: Record<string, any>) => void;
-    deinitialize?: () => void;
+export declare const IDV_UI_ICONS: {
+    readonly WARNING: "warning_icon";
+    readonly SPINNER: "spinner";
+    readonly ERROR: "failure";
+    readonly AGE: "age";
+    readonly ANDROID: "android";
+    readonly ARROW: "arrow";
+    readonly APPLE: "apple";
+    readonly BACK: "back";
+    readonly BIOMETRIC: "biometricIcon";
+    readonly INFO: "info";
+    readonly TO_MOBILE: "toMobile";
+    readonly UNDERAGE: "underage";
+    readonly CROSS: "cross";
+    readonly REGULA_LOGO: "regulaLogo";
+    readonly POWERED_BY: "signature";
+    readonly SUCCESS: "success";
+    readonly DEFAULT: "empty";
+    readonly ONBOARDING_SCAN_ID: "onboardingScanYourId";
+    readonly ONBOARDING_READ_RFID: "onboardingReadRfidChip";
+    readonly ONBOARDING_TAKE_SELFIE: "onboardgTakeASelfie";
+    readonly PREPARE_DOCUMENT_STEP: "prepareDocumentStep";
+    readonly PREPARE_LIVENESS_STEP: "prepareLivenessStep";
+    readonly CIRCLE_SELECTED: "radio_selected";
+    readonly CIRCLE_NORMAL: "radio_normal";
+    readonly SQUARE_SELECTED: "square_selected";
+    readonly SQUARE_NORMAL: "square_normal";
+    readonly SELECTED: "selected";
+    readonly CHEVRON_DOWN: "chevronDown";
+    readonly CLOSE_ICON: "close_icon";
+};
+
+export declare type IDV_UI_ICONS = (typeof IDV_UI_ICONS)[keyof typeof IDV_UI_ICONS];
+
+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<T, R> = {
+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;
 };
 
-export declare const MODULE_NAME = "GUI";
+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;
+    text: string;
+    answerType: DATA_SOURCE_ANSWER_TYPE;
+    required: boolean | null;
+    property: {
+        id: string;
+    };
+    validators: Array<Validator>;
+    options: Array<{
+        id: number | string;
+        text: string;
+    }>;
+};
+
+declare type QuestionItem = {
+    answerType: DATA_SOURCE_ANSWER_TYPE;
+    questionIds?: string[];
+    title?: UILabel;
+    validationMessage: UILabel;
+    backgroundColor?: string;
+    cornerRadius?: number;
+    validationBorderColor?: string;
+    validationBorderWidth?: number;
+};
+
+declare const QUESTIONS_DISPLAY_TYPES: {
+    readonly TEXT_EXPANDABLE: "text_expandable";
+    readonly TEXT_SINGLE_LINE: "text_single_line";
+    readonly SELECTOR_OPTIONS: "selector_options";
+    readonly SELECTOR_BUTTONS: "selector_buttons";
+    readonly SELECTOR_DROPDOWN: "selector_dropdown";
+    readonly MULTI_SELECTOR_BUTTONS: "multi_selector_buttons";
+    readonly MULTI_SELECTOR_OPTIONS: "multi_selector_options";
+    readonly MULTI_SELECTOR_DROPDOWN: "multi_selector_dropdown";
+};
+
+declare type QUESTIONS_DISPLAY_TYPES = (typeof QUESTIONS_DISPLAY_TYPES)[keyof typeof QUESTIONS_DISPLAY_TYPES];
+
+declare type QuestionsDataSource = {
+    static: boolean;
+    questions: QuestionDataSource[];
+};
+
+declare type QuestionsItemTypes = Array<UITextQuestion | UISelectorQuestion | UIMultiSelectorQuestion>;
+
+declare type SessionPropertiesItem = {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    createdBy: unknown;
+    updatedBy: unknown;
+    action: unknown;
+    step: string;
+    name: string;
+    path: unknown;
+    string: string;
+    array?: string[];
+    integer: unknown;
+    decimal: unknown;
+    object: unknown;
+};
+
+declare const TEXT_INPUT_TYPES: {
+    readonly FREE_TEXT: "FREE_TEXT";
+    readonly EMAIL: "EMAIL";
+    readonly NUMBER: "NUMBER";
+    readonly SECURE: "SECURE";
+};
+
+declare type TEXT_INPUT_TYPES = (typeof TEXT_INPUT_TYPES)[keyof typeof TEXT_INPUT_TYPES];
 
 /** Common UI elements types */
-declare enum TextAlignment {
-    LEFT = "LEFT",
-    CENTER = "CENTER",
-    RIGHT = "RIGHT"
-}
+declare const TextAlignment: {
+    readonly LEFT: "LEFT";
+    readonly CENTER: "CENTER";
+    readonly RIGHT: "RIGHT";
+};
+
+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;
+    responseBody?: JsonObject;
     backgroundColor?: string;
     cornerRadius?: number;
     highlightColor?: string;
+    borderColor?: string;
+    borderWidth?: number;
+};
+
+declare type UIButtonOption = UIButton;
+
+declare type UIChip = {
+    title?: UILabel;
+    removeImage?: UIImage;
+    cornerRadius?: number;
+    backgroundColor?: string;
 };
 
 declare type UIDetailsItem = {
@@ -78,6 +363,25 @@ declare type UIDetailsList = {
     cornerRadius: number;
 };
 
+declare type UIDropdownControl = DropdownControl & {
+    title: UILabel;
+};
+
+declare type UIDropdownOption = {
+    title?: UILabel;
+    image?: UIImage;
+    backgroundColor?: string;
+    cornerRadius?: number;
+    highlightColor?: string;
+};
+
+declare type UIDropdownPicker = {
+    backgroundColor?: string;
+    cornerRadius?: number;
+    borderWidth?: number;
+    borderColor?: string;
+};
+
 declare type UIImage = {
     imageURL?: string;
     base64?: string;
@@ -117,13 +421,25 @@ declare type UIInfoScreenClientConfig = {
 declare type UILabel = {
     text?: string;
     fontName?: string;
-    fontSize?: string;
+    fontSize?: string | number;
     fontColor?: string;
     alignment?: TextAlignment;
     backgroundColor?: string;
     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 = {
     header?: UIInfoHeaderView;
     progressView?: UIProgressView;
@@ -132,17 +448,100 @@ declare type UIProgressScreenClientConfig = {
 };
 
 declare type UIProgressView = {
-    title?: UILabel;
     indicatorColor: string;
 };
 
+declare type UIQuestionsScreenClientConfig = {
+    header?: UIInfoHeaderView;
+    footer?: UIInfoFooterView;
+    title?: UILabel;
+    buttons?: UIButton[];
+    questions: {
+        itemTypes: QuestionsItemTypes;
+        backgroundColor?: string;
+    };
+    backgroundColor?: string;
+    cornerRadius?: number;
+};
+
+declare type UIRadioOption = {
+    image: UIImage;
+    title?: UILabel;
+    backgroundColor?: string;
+    cornerRadius?: number;
+    highlightColor?: string;
+};
+
+declare type UISelectorButtonsQuestion = QuestionItem & {
+    displayType: typeof QUESTIONS_DISPLAY_TYPES.SELECTOR_BUTTONS;
+    option: UIButtonOption;
+    optionSelected: UIButtonOption;
+};
+
+declare type UISelectorDropdownQuestion = QuestionItem & {
+    displayType: typeof QUESTIONS_DISPLAY_TYPES.SELECTOR_DROPDOWN;
+    option: UIDropdownOption;
+    optionSelected: UIDropdownOption;
+    dropdownControl: UIDropdownControl;
+    dropdownPicker: UIDropdownPicker;
+};
+
+declare type UISelectorOptionsQuestion = QuestionItem & {
+    displayType: typeof QUESTIONS_DISPLAY_TYPES.SELECTOR_OPTIONS;
+    option: UIRadioOption;
+    optionSelected: UIRadioOption;
+};
+
+declare type UISelectorQuestion = UISelectorOptionsQuestion | UISelectorButtonsQuestion | UISelectorDropdownQuestion;
+
 declare type UIStatusScreenClientConfig = {
     header?: UIInfoHeaderView;
     image?: UIImage;
     title?: UILabel;
+    description: UILabel;
     buttons?: UIButton[];
     footer?: UIInfoFooterView;
     backgroundColor?: string;
 };
 
+declare type UITextField = UILabel & {
+    placeholder?: UILabel;
+    inputType?: TEXT_INPUT_TYPES;
+    backgroundColor?: string;
+    cornerRadius?: number;
+    borderWidth?: number;
+    borderColor?: string;
+};
+
+declare type UITextQuestion = QuestionItem & {
+    displayType: typeof QUESTIONS_DISPLAY_TYPES.TEXT_EXPANDABLE | typeof QUESTIONS_DISPLAY_TYPES.TEXT_SINGLE_LINE;
+    textField?: UITextField;
+};
+
+declare function UnderageIcon({ size }: {
+    size?: number;
+    color?: string;
+}): JSX_2.Element;
+
+declare type Validator = {
+    type: typeof VALIDATOR_TYPE.NOT_EMPTY;
+    message: string;
+} | {
+    type: typeof VALIDATOR_TYPE.REGEX;
+    message: string;
+    regex: string;
+};
+
+declare const VALIDATOR_TYPE: {
+    readonly NOT_EMPTY: "notEmpty";
+    readonly REGEX: "regex";
+};
+
+declare type VALIDATOR_TYPE = (typeof VALIDATOR_TYPE)[keyof typeof VALIDATOR_TYPE];
+
+declare function WarningIcon({ size, color }: {
+    size?: number;
+    color?: string;
+}): JSX_2.Element;
+
 export { }