@regulaforensics/idv-gui 3.10.597-rc → 3.10.598-nightly

package/dist/index.d.ts

@@ -1,10 +1,16 @@
+import { BaseModule } from '../../interfaces-idv/src';
+import { FailedAssets } from '../../interfaces-idv/src';
 import { FunctionComponent } from 'preact';
+import { IdvModuleProps } from '../../interfaces-idv/src';
+import { ImageBase } from '../../interfaces-idv/src';
 import { JSX } from 'preact';
 
-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 CLIENT_VALIDATOR_TYPE: {
+    readonly NOT_EMPTY: "notEmpty";
+    readonly REGEX: "regex";
+};
+
+declare type CLIENT_VALIDATOR_TYPE = (typeof CLIENT_VALIDATOR_TYPE)[keyof typeof CLIENT_VALIDATOR_TYPE];
 
 declare const ContentMode: {
     readonly ASPECT_FILL: "ASPECT_FILL";
@@ -32,12 +38,6 @@ declare type DropdownControl = {
     expandButton?: UIImage;
 };
 
-declare type FailedAssets = {
-    imageURL: Set<string>;
-    base64: Set<string>;
-    blockingAssets: Set<string>;
-};
-
 declare const FontWeight: {
     readonly NORMAL: "NORMAL";
     readonly BOLD: "BOLD";
@@ -45,6 +45,11 @@ declare const FontWeight: {
 
 declare type FontWeight = (typeof FontWeight)[keyof typeof FontWeight];
 
+declare type GenericPopup = {
+    rootElement: UIRootElement;
+    reason: string;
+};
+
 export declare class GuiIdv extends BaseModule<GuiModuleProps, GuiModuleConfig> {
     private _mounted;
     private _shadowRoot;
@@ -58,16 +63,17 @@ export declare class GuiIdv extends BaseModule<GuiModuleProps, GuiModuleConfig>
         devSettings?: GuiModuleDevSettings;
     }): void;
     connectedCallback(): void;
+    static cancel(): void;
     private render;
     disconnectedCallback(): void;
     static isReady(): boolean;
-    static getSupportedTemplates: () => ("INFO" | "INFO_DETAILS" | "STATUS" | "PROGRESS" | "QUESTIONS" | "CAMERA" | "GALLERY" | "GEOLOCATION" | "DEVICE_TRANSFER" | "GENERIC" | "UPLOAD_FILES")[];
+    static getSupportedTemplates: () => ("INFO" | "INFO_DETAILS" | "STATUS" | "PROGRESS" | "QUESTIONS" | "CAMERA" | "GALLERY" | "GEOLOCATION" | "DEVICE_TRANSFER" | "GENERIC" | "GENERIC_LOCATION" | "GENERIC_PROGRESS" | "UPLOAD_FILES")[];
     static initialize(_modulesConfig: Record<string, unknown>): void;
     static deinitialize(): void;
     static getIdentifier: () => string;
 }
 
-export declare const GuiIdvReactComponent: ({ isProcessing: setIsProcessingCallback, moduleProps, perform, devSettings, }: IdvModuleProps<GuiModuleProps, GuiModuleConfig> & {
+export declare const GuiIdvReactComponent: ({ isProcessing: setIsProcessingCallback, moduleProps, perform, devSettings, idvEventListener, }: IdvModuleProps<GuiModuleProps, GuiModuleConfig> & {
     devSettings?: GuiModuleDevSettings;
 }) => JSX.Element;
 
@@ -82,6 +88,8 @@ export declare const GuiIdvSteps: {
     readonly GEOLOCATION: "GEOLOCATION";
     readonly DEVICE_TRANSFER: "DEVICE_TRANSFER";
     readonly GENERIC: "GENERIC";
+    readonly GENERIC_LOCATION: "GENERIC_LOCATION";
+    readonly GENERIC_PROGRESS: "GENERIC_PROGRESS";
     readonly UPLOAD_FILES: "UPLOAD_FILES";
 };
 
@@ -105,6 +113,7 @@ export declare type GuiModuleDevSettings = {
                 progressBarRange?: number;
                 name?: string;
                 serverError?: string;
+                size?: number;
             }[];
         };
     };
@@ -146,6 +155,7 @@ export declare type GuiModuleProps = {
     templateId: typeof GuiIdvSteps.GEOLOCATION;
     templateLayout: UIGeolocationScreenClientConfig;
     getLocationTimeout?: number;
+    locationAccuracy?: LocationAccuracy;
 } | {
     templateId: typeof GuiIdvSteps.QUESTIONS;
     templateLayout: UIQuestionsScreenClientConfig;
@@ -158,6 +168,12 @@ export declare type GuiModuleProps = {
 } | {
     templateId: typeof GuiIdvSteps.GENERIC;
     templateLayout: UIGenericScreenClientConfig;
+} | {
+    templateId: typeof GuiIdvSteps.GENERIC_PROGRESS;
+    templateLayout: UIGenericProgressScreenClientConfig;
+} | {
+    templateId: typeof GuiIdvSteps.GENERIC_LOCATION;
+    templateLayout: UIGenericLocationScreenClientConfig;
 } | {
     templateId: typeof GuiIdvSteps.UPLOAD_FILES;
     templateLayout: UIUploadFilesScreenClientConfig;
@@ -203,26 +219,6 @@ export declare type IDV_UI_ICONS = (typeof IDV_UI_ICONS)[keyof typeof IDV_UI_ICO
 
 export declare const idvIconDataUrlMap: Record<IDV_UI_ICONS, (color?: string) => string>;
 
-declare type IdvModuleProps<TModuleProps, TModulesConfig> = {
-    isProcessing?: (isProcessing: boolean) => void;
-    moduleProps: TModuleProps;
-    modulesConfig?: TModulesConfig;
-    perform: (data: any, type?: PerformType) => void;
-    idvEventListener: (module: string, data: any) => void;
-    nonce?: string;
-};
-
-declare type ImageBase = {
-    imageURL?: string;
-    imageId?: string;
-    base64?: string;
-    prepareRequired?: boolean;
-    failurePolicy?: ImageFailurePolicy;
-    timeout?: number;
-};
-
-declare type ImageFailurePolicy = 'ignore' | 'placeholderImage' | 'error';
-
 declare type JsonArray = JsonValue[];
 
 declare type JsonObject = {
@@ -231,11 +227,17 @@ declare type JsonObject = {
 
 declare type JsonValue = string | number | boolean | null | JsonObject | JsonArray;
 
-declare type PerformType = (typeof PerformTypes)[keyof typeof PerformTypes] | undefined;
+declare enum LocationAccuracy {
+    HIGH = "HIGH",
+    BALANCED = "BALANCED",
+    LOW = "LOW",
+    PASSIVE = "PASSIVE"
+}
 
-declare const PerformTypes: {
-    readonly FORM: "form";
-    readonly DATA: "data";
+declare type LocationSettings = {
+    askEveryTime: boolean;
+    getLocationTimeout: number;
+    locationAccuracy: LocationAccuracy;
 };
 
 declare type PopupActionButton = {
@@ -299,7 +301,7 @@ declare type QuestionsDataSource = {
     questions: QuestionDataSource[];
 };
 
-declare type QuestionsItemTypes = Array<UITextQuestion | UISelectorQuestion | UIMultiSelectorQuestion | UIMultiSelectorButtonsQuestion | UIMultiSelectorOptionsQuestion>;
+declare type QuestionsItem = UITextQuestion | UISelectorQuestion | UIMultiSelectorQuestion | UIMultiSelectorButtonsQuestion | UIMultiSelectorOptionsQuestion;
 
 declare const RootElementTypes: {
     readonly SCAFFOLD: "scaffold";
@@ -351,6 +353,7 @@ declare type UIButton = {
     backgroundColor?: string;
     cornerRadius?: number;
     highlightColor?: string;
+    hoverColor?: string;
     borderColor?: string;
     borderWidth?: number;
     paddings?: UIPaddings;
@@ -362,6 +365,7 @@ declare type UICameraScreenClientConfig = {
     header?: UIInfoHeaderView;
     footer?: UIInfoFooterView;
     backgroundColor?: string;
+    backgroundImage?: UIImage;
     buttons?: UIButton[];
     selectionLimit?: number;
 };
@@ -403,6 +407,7 @@ declare type UIDeviceTransferScreenClientConfig = {
     buttons?: UIButton[];
     footer?: UIInfoFooterView;
     backgroundColor?: string;
+    backgroundImage?: UIImage;
     qr?: {
         color?: string;
     };
@@ -448,6 +453,9 @@ declare type UIElement = {
 } | {
     type: typeof UIElementTypes.SPACER;
     content: WithWeightProp<WithWidthAndHeightProps<UISpacer>>;
+} | {
+    type: typeof UIElementTypes.PROGRESS_VIEW;
+    content: WithWidthAndHeightProps<UIProgressView>;
 };
 
 declare const UIElementTypes: {
@@ -458,6 +466,7 @@ declare const UIElementTypes: {
     readonly COLUMN: "column";
     readonly ROW: "row";
     readonly SPACER: "spacer";
+    readonly PROGRESS_VIEW: "progressView";
 };
 
 declare type UIFileUploadPopupFilesLimitExceededOnly = UIPopup & {
@@ -472,10 +481,21 @@ declare type UIGalleryScreenClientConfig = {
     header?: UIInfoHeaderView;
     footer?: UIInfoFooterView;
     backgroundColor?: string;
+    backgroundImage?: UIImage;
     buttons?: UIButton[];
     selectionLimit?: number;
 };
 
+declare type UIGenericLocationScreenClientConfig = {
+    rootElement: UIRootElement;
+    popups: GenericPopup[];
+    settings: LocationSettings;
+};
+
+declare type UIGenericProgressScreenClientConfig = {
+    rootElement: UIRootElement;
+};
+
 declare type UIGenericScreenClientConfig = {
     rootElement: UIRootElement;
 };
@@ -492,6 +512,7 @@ declare type UIGeolocationScreenClientConfig = {
     buttons?: UIButton[];
     footer?: UIInfoFooterView;
     backgroundColor?: string;
+    backgroundImage?: UIImage;
     popups: [UIGeolocationPopupSystemRestrictedOnly];
     askEveryTime?: boolean;
 };
@@ -514,9 +535,15 @@ declare type UIImage = ImageBase & {
 };
 
 declare type UIImageButton = {
+    actionId?: string;
+    type?: 'DATA' | 'FORM';
     paddings?: UIPaddings;
     image: UIImage;
     responseBody?: JsonObject;
+    backgroundColor?: string;
+    highlightColor?: string;
+    hoverColor?: string;
+    cornerRadius?: number;
 };
 
 declare type UIInfoDetailsScreenClientConfig = {
@@ -526,6 +553,7 @@ declare type UIInfoDetailsScreenClientConfig = {
     buttons?: UIButton[];
     footer?: UIInfoFooterView;
     backgroundColor?: string;
+    backgroundImage?: UIImage;
 };
 
 declare type UIInfoFooterView = {
@@ -544,6 +572,7 @@ declare type UIInfoScreenClientConfig = {
     buttons?: UIButton[];
     footer?: UIInfoFooterView;
     backgroundColor?: string;
+    backgroundImage?: UIImage;
 };
 
 declare type UILabel = {
@@ -605,6 +634,7 @@ declare type UIProgressScreenClientConfig = {
     progressView?: UIProgressView;
     footer?: UIInfoFooterView;
     backgroundColor?: string;
+    backgroundImage?: UIImage;
 };
 
 declare type UIProgressView = {
@@ -617,10 +647,11 @@ declare type UIQuestionsScreenClientConfig = {
     title?: UILabel;
     buttons?: UIButton[];
     questions: {
-        itemTypes: QuestionsItemTypes;
+        itemTypes: QuestionsItem[];
         backgroundColor?: string;
     };
     backgroundColor?: string;
+    backgroundImage?: UIImage;
     cornerRadius?: number;
 };
 
@@ -651,6 +682,8 @@ declare type UIScaffoldContainer = {
     mainColumn?: UIColumn;
     bottomColumn?: UIColumn;
     backgroundColor?: string;
+    backgroundImage?: UIImage;
+    cornerRadius?: number;
 };
 
 declare type UISelectorButtonsQuestion = QuestionItem & {
@@ -688,6 +721,7 @@ declare type UIStatusScreenClientConfig = {
     buttons?: UIButton[];
     footer?: UIInfoFooterView;
     backgroundColor?: string;
+    backgroundImage?: UIImage;
 };
 
 declare type UITextField = UILabel & {
@@ -711,6 +745,7 @@ declare type UIUploadFilesScreenClientConfig = {
     buttons?: UIButton[];
     footer?: UIInfoFooterView;
     backgroundColor?: string;
+    backgroundImage?: UIImage;
     popups?: [UIFileUploadPopupNoFilesOnly, UIFileUploadPopupFilesLimitExceededOnly];
     settings: {
         supportedFileFormats: string[];
@@ -748,21 +783,18 @@ declare type UploadFileToTemp = (file: File, onProgress: (sentBytes: number, tot
 }>;
 
 declare type Validator = {
-    type: typeof VALIDATOR_TYPE.NOT_EMPTY;
+    type: typeof CLIENT_VALIDATOR_TYPE.NOT_EMPTY;
     message: string;
 } | {
-    type: typeof VALIDATOR_TYPE.REGEX;
+    type: typeof CLIENT_VALIDATOR_TYPE.REGEX;
     message: string;
     regex: string;
+} | {
+    type: string;
+    message: string;
+    passed?: boolean | null;
 };
 
-declare const VALIDATOR_TYPE: {
-    readonly NOT_EMPTY: "notEmpty";
-    readonly REGEX: "regex";
-};
-
-declare type VALIDATOR_TYPE = (typeof VALIDATOR_TYPE)[keyof typeof VALIDATOR_TYPE];
-
 declare type WithWeightProp<T> = T & {
     weight?: number;
 };