@regulaforensics/idv-gui 2.3.128-nightly → 2.3.129-nightly

package/dist/index.d.ts

@@ -4,7 +4,15 @@ declare const ContentMode: {
     readonly FILL: "FILL";
 };
 
-declare type ContentMode = keyof typeof ContentMode;
+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 const GuiIdv: React.FC<IdvModuleProps<GuiModuleProps | GuiModulePropsUnknown, GuiModuleConfig>> & IdvModuleMethods;
 export default GuiIdv;
@@ -17,14 +25,21 @@ export declare const GuiIdvSteps: {
     readonly QUESTIONS: "QUESTIONS";
 };
 
-export declare type GuiIdvSteps = keyof typeof GuiIdvSteps;
+export declare type GuiIdvSteps = (typeof GuiIdvSteps)[keyof typeof GuiIdvSteps];
 
 declare type GuiModuleConfig = Record<string, any>;
 
+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];
+        templateLayout: GuiModulePropsMap[K];
+        dataSource?: QuestionsDataSource | null;
         sessionId?: string;
         serviceToken?: string;
     };
@@ -35,11 +50,13 @@ 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;
 };
@@ -67,9 +84,15 @@ export declare const IDV_UI_ICONS: {
     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";
 };
 
-export declare type IDV_UI_ICONS = keyof typeof IDV_UI_ICONS;
+export declare type IDV_UI_ICONS = (typeof IDV_UI_ICONS)[keyof typeof IDV_UI_ICONS];
 
 declare type IdvModuleMethods = {
     isReady: () => boolean;
@@ -87,7 +110,61 @@ declare type IdvModuleProps<T, R> = {
     idvEventListener: (module: string, data: any) => void;
 };
 
-export declare const MODULE_NAME = "GUI";
+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 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 const TextAlignment: {
@@ -96,17 +173,22 @@ declare const TextAlignment: {
     readonly RIGHT: "RIGHT";
 };
 
-declare type TextAlignment = keyof typeof TextAlignment;
+declare type TextAlignment = (typeof TextAlignment)[keyof typeof TextAlignment];
 
 declare type UIButton = {
+    type?: 'RESPONSE_BODY' | 'FORM';
     title?: UILabel;
     image?: UIImage;
     responseBody?: string | Record<string, any>;
     backgroundColor?: string;
     cornerRadius?: number;
     highlightColor?: string;
+    borderColor?: string;
+    borderWidth?: number;
 };
 
+declare type UIButtonOption = UIButton;
+
 declare type UIDetailsItem = {
     title?: UILabel;
     description?: UILabel;
@@ -121,6 +203,14 @@ declare type UIDetailsList = {
     cornerRadius: number;
 };
 
+declare type UIDropdownOption = {
+    title?: UILabel;
+    image?: UIImage;
+    backgroundColor?: string;
+    cornerRadius?: number;
+    highlightColor?: string;
+};
+
 declare type UIImage = {
     imageURL?: string;
     base64?: string;
@@ -167,6 +257,12 @@ declare type UILabel = {
     cornerRadius?: number;
 };
 
+declare type UIMultiSelectorQuestion = QuestionItem & {
+    displayType: typeof QUESTIONS_DISPLAY_TYPES.MULTI_SELECTOR_DROPDOWN;
+    option: UIDropdownOption;
+    optionSelected: UIDropdownOption;
+};
+
 declare type UIProgressScreenClientConfig = {
     header?: UIInfoHeaderView;
     progressView?: UIProgressView;
@@ -179,6 +275,47 @@ declare type UIProgressView = {
     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;
+};
+
+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;
@@ -188,4 +325,34 @@ declare type UIStatusScreenClientConfig = {
     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 type Validator = {
+    type: typeof VALIDATOR_TYPE.REQUIRED;
+    message: string;
+} | {
+    type: typeof VALIDATOR_TYPE.REGEX;
+    message: string;
+    regex: string;
+};
+
+declare const VALIDATOR_TYPE: {
+    readonly REQUIRED: "required";
+    readonly REGEX: "regex";
+};
+
+declare type VALIDATOR_TYPE = (typeof VALIDATOR_TYPE)[keyof typeof VALIDATOR_TYPE];
+
 export { }