@regulaforensics/idv-gui 3.3.308 → 3.4.70-nightly

package/dist/index.d.ts

@@ -32,6 +32,12 @@ declare type DropdownControl = {
     expandButton?: UIImage;
 };
 
+declare type FailedAssets = {
+    imageURL: Set<string>;
+    base64: Set<string>;
+    blockingAssets: Set<string>;
+};
+
 export declare class GuiIdv extends BaseModule<GuiModuleProps, GuiModuleConfig> {
     private _mounted;
     private _shadowRoot;
@@ -47,7 +53,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")[];
+    static getSupportedTemplates: () => ("INFO" | "INFO_DETAILS" | "STATUS" | "PROGRESS" | "QUESTIONS" | "CAMERA" | "GALLERY" | "GEOLOCATION" | "DEVICE_TRANSFER")[];
     static initialize(_modulesConfig: Record<string, unknown>): void;
     static deinitialize(): void;
     static getIdentifier: () => string;
@@ -66,6 +72,7 @@ export declare const GuiIdvSteps: {
     readonly CAMERA: "CAMERA";
     readonly GALLERY: "GALLERY";
     readonly GEOLOCATION: "GEOLOCATION";
+    readonly DEVICE_TRANSFER: "DEVICE_TRANSFER";
 };
 
 export declare type GuiIdvSteps = (typeof GuiIdvSteps)[keyof typeof GuiIdvSteps];
@@ -83,13 +90,15 @@ export declare type GuiModuleDevSettings = {
 };
 
 export declare const GuiModuleError: {
-    readonly DECODING_FAILED: "DECODING_FAILED";
+    readonly DECODING_FAILED: 0;
+    readonly IMAGE_LOADING_FAILED: 1;
 };
 
 export declare type GuiModuleError = (typeof GuiModuleError)[keyof typeof GuiModuleError];
 
 export declare type GuiModuleProps = {
     locale: string;
+    failedAssets?: FailedAssets;
 } & ({
     templateId: typeof GuiIdvSteps.INFO;
     templateLayout: UIInfoScreenClientConfig;
@@ -121,6 +130,10 @@ export declare type GuiModuleProps = {
     templateLayout: UIQuestionsScreenClientConfig;
     dataSource?: QuestionsDataSource | null;
     properties?: SessionPropertiesItem[];
+} | {
+    templateId: typeof GuiIdvSteps.DEVICE_TRANSFER;
+    templateLayout: UIDeviceTransferScreenClientConfig;
+    url?: string;
 });
 
 export declare const IDV_UI_ICONS: {
@@ -165,6 +178,16 @@ declare type IdvModuleProps<TModuleProps, TModulesConfig> = {
     nonce?: string;
 };
 
+declare type ImageBase = {
+    imageURL?: string;
+    imageId?: string;
+    base64?: string;
+    prepareRequired?: boolean;
+    failurePolicy?: ImageFailurePolicy;
+};
+
+declare type ImageFailurePolicy = 'ignore' | 'placeholderImage' | 'error';
+
 declare type JsonArray = JsonValue[];
 
 declare type JsonObject = {
@@ -319,6 +342,18 @@ declare type UIDetailsList = {
     cornerRadius: number;
 };
 
+declare type UIDeviceTransferScreenClientConfig = {
+    header?: UIInfoHeaderView;
+    title?: UILabel;
+    description?: UILabel;
+    buttons?: UIButton[];
+    footer?: UIInfoFooterView;
+    backgroundColor?: string;
+    qr?: {
+        color?: string;
+    };
+};
+
 declare type UIDropdownControl = DropdownControl & {
     title: UILabel;
 };
@@ -363,10 +398,8 @@ declare type UIGeolocationScreenClientConfig = {
     getLocationTimeout?: number;
 };
 
-declare type UIImage = {
-    imageURL?: string;
-    base64?: string;
-    imageId?: string;
+declare type UIImage = ImageBase & {
+    placeholderImage?: UIImage;
     contentMode?: ContentMode;
     backgroundColor?: string;
     cornerRadius?: number;