@regulaforensics/idv-gui 2.3.123 → 2.3.126-nightly

package/dist/index.d.ts

@@ -1,10 +1,12 @@
-declare enum ContentMode {
-    ASPECT_FILL = "ASPECT_FILL",
-    ASPECT_FIT = "ASPECT_FIT",
-    FILL = "FILL"
-}
+declare const ContentMode: {
+    readonly ASPECT_FILL: "ASPECT_FILL";
+    readonly ASPECT_FIT: "ASPECT_FIT";
+    readonly FILL: "FILL";
+};
+
+declare type ContentMode = keyof typeof ContentMode;
 
-declare const GuiIdv: React.FC<IdvModuleProps<GuiModuleProps, GuiModuleConfig>> & IdvModuleMethods;
+declare const GuiIdv: React.FC<IdvModuleProps<GuiModuleProps | GuiModulePropsUnknown, GuiModuleConfig>> & IdvModuleMethods;
 export default GuiIdv;
 
 declare const GuiIdvSteps: {
@@ -14,12 +16,16 @@ declare const GuiIdvSteps: {
     readonly PROGRESS: "PROGRESS";
 };
 
+declare type GuiIdvSteps = keyof typeof GuiIdvSteps;
+
 declare type GuiModuleConfig = Record<string, any>;
 
-declare type GuiModuleProps = {
+export declare type GuiModuleProps = {
     [K in keyof GuiModulePropsMap]: {
-        templateId?: K;
+        templateId: K;
         templateLayout?: GuiModulePropsMap[K];
+        sessionId?: string;
+        serviceToken?: string;
     };
 }[keyof GuiModulePropsMap];
 
@@ -30,6 +36,40 @@ declare type GuiModulePropsMap = {
     [GuiIdvSteps.STATUS]: UIStatusScreenClientConfig;
 };
 
+export declare type GuiModulePropsUnknown = {
+    templateId: string;
+    templateLayout?: Record<string, any>;
+    sessionId?: string;
+    serviceToken?: string;
+};
+
+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";
+};
+
+export declare type IDV_UI_ICONS = keyof typeof IDV_UI_ICONS;
+
 declare type IdvModuleMethods = {
     isReady: () => boolean;
     getSupportedTemplates: () => string[];
@@ -49,16 +89,18 @@ declare type IdvModuleProps<T, R> = {
 export declare const MODULE_NAME = "GUI";
 
 /** 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 = keyof typeof TextAlignment;
 
 declare type UIButton = {
     title?: UILabel;
     image?: UIImage;
-    responseBody?: string;
+    responseBody?: string | Record<string, any>;
     backgroundColor?: string;
     cornerRadius?: number;
     highlightColor?: string;
@@ -117,7 +159,7 @@ declare type UIInfoScreenClientConfig = {
 declare type UILabel = {
     text?: string;
     fontName?: string;
-    fontSize?: string;
+    fontSize?: string | number;
     fontColor?: string;
     alignment?: TextAlignment;
     backgroundColor?: string;