@regulaforensics/idv-gui 3.5.319-nightly → 3.5.320-nightly

package/dist/index.d.ts

@@ -38,6 +38,13 @@ declare type FailedAssets = {
     blockingAssets: Set<string>;
 };
 
+declare const FontWeight: {
+    readonly NORMAL: "NORMAL";
+    readonly BOLD: "BOLD";
+};
+
+declare type FontWeight = (typeof FontWeight)[keyof typeof FontWeight];
+
 export declare class GuiIdv extends BaseModule<GuiModuleProps, GuiModuleConfig> {
     private _mounted;
     private _shadowRoot;
@@ -54,7 +61,7 @@ export declare class GuiIdv extends BaseModule<GuiModuleProps, GuiModuleConfig>
     private render;
     disconnectedCallback(): void;
     static isReady(): boolean;
-    static getSupportedTemplates: () => ("INFO" | "INFO_DETAILS" | "STATUS" | "PROGRESS" | "QUESTIONS" | "CAMERA" | "GALLERY" | "GEOLOCATION" | "DEVICE_TRANSFER")[];
+    static getSupportedTemplates: () => ("INFO" | "INFO_DETAILS" | "STATUS" | "PROGRESS" | "QUESTIONS" | "CAMERA" | "GALLERY" | "GEOLOCATION" | "DEVICE_TRANSFER" | "GENERIC")[];
     static initialize(_modulesConfig: Record<string, unknown>): void;
     static deinitialize(): void;
     static getIdentifier: () => string;
@@ -74,6 +81,7 @@ export declare const GuiIdvSteps: {
     readonly GALLERY: "GALLERY";
     readonly GEOLOCATION: "GEOLOCATION";
     readonly DEVICE_TRANSFER: "DEVICE_TRANSFER";
+    readonly GENERIC: "GENERIC";
 };
 
 export declare type GuiIdvSteps = (typeof GuiIdvSteps)[keyof typeof GuiIdvSteps];
@@ -135,6 +143,9 @@ export declare type GuiModuleProps = {
     templateId: typeof GuiIdvSteps.DEVICE_TRANSFER;
     templateLayout: UIDeviceTransferScreenClientConfig;
     url?: string;
+} | {
+    templateId: typeof GuiIdvSteps.GENERIC;
+    templateLayout: UIGenericScreenClientConfig;
 });
 
 export declare const IDV_UI_ICONS: {
@@ -266,6 +277,10 @@ declare type QuestionsDataSource = {
 
 declare type QuestionsItemTypes = Array<UITextQuestion | UISelectorQuestion | UIMultiSelectorQuestion>;
 
+declare const RootElementTypes: {
+    readonly SCAFFOLD: "scaffold";
+};
+
 declare type SessionPropertiesItem = {
     id: string;
     createdAt: string;
@@ -294,9 +309,11 @@ declare type TEXT_INPUT_TYPES = (typeof TEXT_INPUT_TYPES)[keyof typeof TEXT_INPU
 
 /** Common UI elements types */
 declare const TextAlignment: {
+    readonly START: "START";
     readonly LEFT: "LEFT";
     readonly CENTER: "CENTER";
     readonly RIGHT: "RIGHT";
+    readonly END: "END";
 };
 
 declare type TextAlignment = (typeof TextAlignment)[keyof typeof TextAlignment];
@@ -311,6 +328,7 @@ declare type UIButton = {
     highlightColor?: string;
     borderColor?: string;
     borderWidth?: number;
+    paddings?: UIPaddings;
 };
 
 declare type UIButtonOption = UIButton;
@@ -330,6 +348,15 @@ declare type UIChip = {
     backgroundColor?: string;
 };
 
+declare type UIColumn = {
+    elements?: UIElement[];
+    horizontalAlignment?: UIHorizontalAlignment;
+    verticalAlignment?: UIVerticalAlignment;
+    backgroundColor?: string;
+    cornerRadius?: number;
+    paddings?: UIPaddings;
+};
+
 declare type UIDetailsItem = {
     title?: UILabel;
     description?: UILabel;
@@ -375,6 +402,39 @@ declare type UIDropdownPicker = {
     borderColor?: string;
 };
 
+declare type UIElement = {
+    type: typeof UIElementTypes.LABEL;
+    content: WithWeightProp<UILabel>;
+} | {
+    type: typeof UIElementTypes.IMAGE;
+    content: WithWeightProp<WithWidthAndHeightProps<UIImage>>;
+} | {
+    type: typeof UIElementTypes.IMAGE_BUTTON;
+    content: WithWeightProp<WithWidthAndHeightProps<UIImageButton>>;
+} | {
+    type: typeof UIElementTypes.BUTTON;
+    content: WithWeightProp<UIButton>;
+} | {
+    type: typeof UIElementTypes.COLUMN;
+    content: WithWeightProp<UIColumn>;
+} | {
+    type: typeof UIElementTypes.ROW;
+    content: WithWeightProp<UIRow>;
+} | {
+    type: typeof UIElementTypes.SPACER;
+    content: WithWeightProp<WithWidthAndHeightProps<UISpacer>>;
+};
+
+declare const UIElementTypes: {
+    readonly LABEL: "label";
+    readonly IMAGE: "image";
+    readonly IMAGE_BUTTON: "imageButton";
+    readonly BUTTON: "button";
+    readonly COLUMN: "column";
+    readonly ROW: "row";
+    readonly SPACER: "spacer";
+};
+
 declare type UIGalleryScreenClientConfig = {
     header?: UIInfoHeaderView;
     footer?: UIInfoFooterView;
@@ -383,6 +443,10 @@ declare type UIGalleryScreenClientConfig = {
     selectionLimit?: number;
 };
 
+declare type UIGenericScreenClientConfig = {
+    rootElement: UIRootElement;
+};
+
 declare type UIGeolocationPopupSystemRestrictedOnly = UIPopup & {
     reason: typeof PopupReason.SYSTEM_RESTRICTED;
 };
@@ -397,7 +461,16 @@ declare type UIGeolocationScreenClientConfig = {
     backgroundColor?: string;
     popups: [UIGeolocationPopupSystemRestrictedOnly];
     askEveryTime?: boolean;
-    getLocationTimeout?: number;
+};
+
+declare type UIHorizontalAlignment = (typeof UIHorizontalAlignments)[keyof typeof UIHorizontalAlignments];
+
+declare const UIHorizontalAlignments: {
+    readonly START: "START";
+    readonly LEFT: "LEFT";
+    readonly CENTER: "CENTER";
+    readonly RIGHT: "RIGHT";
+    readonly END: "END";
 };
 
 declare type UIImage = ImageBase & {
@@ -407,6 +480,12 @@ declare type UIImage = ImageBase & {
     cornerRadius?: number;
 };
 
+declare type UIImageButton = {
+    paddings?: UIPaddings;
+    image: UIImage;
+    responseBody?: JsonObject;
+};
+
 declare type UIInfoDetailsScreenClientConfig = {
     header?: UIInfoHeaderView;
     title?: UILabel;
@@ -442,6 +521,8 @@ declare type UILabel = {
     alignment?: TextAlignment;
     backgroundColor?: string;
     cornerRadius?: number;
+    paddings?: UIPaddings;
+    fontWeight?: FontWeight;
 };
 
 declare type UIMultiDropdownControl = DropdownControl & {
@@ -456,6 +537,13 @@ declare type UIMultiSelectorQuestion = QuestionItem & {
     dropdownPicker: UIDropdownPicker;
 };
 
+declare type UIPaddings = {
+    right?: number;
+    left?: number;
+    top?: number;
+    bottom?: number;
+};
+
 declare type UIPopup = {
     reason: PopupReason;
     actionButton1: PopupActionButton;
@@ -499,6 +587,27 @@ declare type UIRadioOption = {
     highlightColor?: string;
 };
 
+declare type UIRootElement = {
+    type: typeof RootElementTypes.SCAFFOLD;
+    content: UIScaffoldContainer;
+};
+
+declare type UIRow = {
+    elements?: UIElement[];
+    horizontalAlignment?: UIHorizontalAlignment;
+    verticalAlignment?: UIVerticalAlignment;
+    backgroundColor?: string;
+    cornerRadius?: number;
+    paddings?: UIPaddings;
+};
+
+declare type UIScaffoldContainer = {
+    topColumn?: UIColumn;
+    mainColumn?: UIColumn;
+    bottomColumn?: UIColumn;
+    backgroundColor?: string;
+};
+
 declare type UISelectorButtonsQuestion = QuestionItem & {
     displayType: typeof QUESTIONS_DISPLAY_TYPES.SELECTOR_BUTTONS;
     option: UIButtonOption;
@@ -521,6 +630,11 @@ declare type UISelectorOptionsQuestion = QuestionItem & {
 
 declare type UISelectorQuestion = UISelectorOptionsQuestion | UISelectorButtonsQuestion | UISelectorDropdownQuestion;
 
+declare type UISpacer = {
+    backgroundColor?: string;
+    cornerRadius?: number;
+};
+
 declare type UIStatusScreenClientConfig = {
     header?: UIInfoHeaderView;
     image?: UIImage;
@@ -545,6 +659,14 @@ declare type UITextQuestion = QuestionItem & {
     textField?: UITextField;
 };
 
+declare type UIVerticalAlignment = (typeof UIVerticalAlignments)[keyof typeof UIVerticalAlignments];
+
+declare const UIVerticalAlignments: {
+    readonly TOP: "TOP";
+    readonly CENTER: "CENTER";
+    readonly BOTTOM: "BOTTOM";
+};
+
 declare type Validator = {
     type: typeof VALIDATOR_TYPE.NOT_EMPTY;
     message: string;
@@ -561,4 +683,13 @@ declare const VALIDATOR_TYPE: {
 
 declare type VALIDATOR_TYPE = (typeof VALIDATOR_TYPE)[keyof typeof VALIDATOR_TYPE];
 
+declare type WithWeightProp<T> = T & {
+    weight?: number;
+};
+
+declare type WithWidthAndHeightProps<T> = T & {
+    width?: number;
+    height?: number;
+};
+
 export { }