idmission-web-sdk 2.1.34 → 2.1.36

package/dist/components/customer_flows/CustomerIdAndBiometricsEnrollment.d.ts

@@ -118,6 +118,10 @@ export interface CustomerEnrollmentProps extends PropsWithChildren {
     selfieCaptureModelLoadTimeoutMs?: number;
     /** Boolean to indicate whether to allow the user to capture the back of the ID card before capturing the front. Defaults to `false`. */
     allowIdCardBackToFrontCapture?: boolean;
+    /** Boolean to indicate whether to show the user a dialog to disable the wrong document type guidance after a configurable amount of time. Defaults to `false`. */
+    enableOverrideWrongDocumentTypeDialog?: boolean;
+    /** Number of milliseconds to wait before showing the user a dialog to disable the wrong document type guidance. Defaults to `8000`. */
+    allowOverrideWrongDocumentTypeAfterMs?: number;
     /** Callback function that fires immediately prior to each document upload, giving the client application an opportunity to specify custom asynchronous logic that captures the document contents before it is exchanged for a document token. The document content and metadata are passed in as parameters and a promise resolving to void or false should be returned. If the returned promise resolves to false, the document will not be uploaded. */
     onBeforeDocumentUpload?: OnBeforeDocumentUpload;
     /** Callback function that fires when progress information is available for a document upload. The progress info and metadata are passed in as parameters. */

package/dist/components/customer_flows/IdAndFaceValidation.d.ts

@@ -115,6 +115,10 @@ export interface IdAndFaceValidationProps extends PropsWithChildren {
     selfieCaptureModelLoadTimeoutMs?: number;
     /** Boolean to indicate whether to allow the user to capture the back of the ID card before capturing the front. Defaults to `false`. */
     allowIdCardBackToFrontCapture?: boolean;
+    /** Boolean to indicate whether to show the user a dialog to disable the wrong document type guidance after a configurable amount of time. Defaults to `false`. */
+    enableOverrideWrongDocumentTypeDialog?: boolean;
+    /** Number of milliseconds to wait before showing the user a dialog to disable the wrong document type guidance. Defaults to `8000`. */
+    allowOverrideWrongDocumentTypeAfterMs?: number;
     /** Callback function that fires immediately prior to each document upload, giving the client application an opportunity to specify custom asynchronous logic that captures the document contents before it is exchanged for a document token. The document content and metadata are passed in as parameters and a promise resolving to void or false should be returned. If the returned promise resolves to false, the document will not be uploaded. */
     onBeforeDocumentUpload?: OnBeforeDocumentUpload;
     /** Callback function that fires when progress information is available for a document upload. The progress info and metadata are passed in as parameters. */

package/dist/components/customer_flows/IdValidation.d.ts

@@ -100,6 +100,10 @@ export interface IdValidationProps extends PropsWithChildren {
     forceFallbackMode?: boolean;
     /** Boolean to indicate whether to allow the user to capture the back of the ID card before capturing the front. Defaults to `false`. */
     allowIdCardBackToFrontCapture?: boolean;
+    /** Boolean to indicate whether to show the user a dialog to disable the wrong document type guidance after a configurable amount of time. Defaults to `false`. */
+    enableOverrideWrongDocumentTypeDialog?: boolean;
+    /** Number of milliseconds to wait before showing the user a dialog to disable the wrong document type guidance. Defaults to `8000`. */
+    allowOverrideWrongDocumentTypeAfterMs?: number;
     /** Object to allow documents that have been previously captured to be submitted. Valid keys: `idCardFront`, `idCardBack`, `passport`.*/
     precapturedDocuments?: CapturedDocuments;
     /** Callback function that fires immediately prior to each document upload, giving the client application an opportunity to specify custom asynchronous logic that captures the document contents before it is exchanged for a document token. The document content and metadata are passed in as parameters and a promise resolving to void or false should be returned. If the returned promise resolves to false, the document will not be uploaded. */

package/dist/components/id_capture/IdCapture.d.ts

@@ -5,6 +5,7 @@ import { IdCaptureImagePreviewClassNames } from '../common/SelfieProgressPreview
 import { CustomerSuppliedVerbiage } from '../../lib/locales';
 import { CapturedDocumentType } from './CapturedDocuments';
 import { IdCaptureFitGuideClassNames } from './IdCaptureFitGuide';
+import { OverrideWrongDocumentTypeGuidanceDialogClassNames, OverrideWrongDocumentTypeGuidanceDialogVerbiage } from './OverrideWrongDocumentTypeGuidanceDialog';
 export type IdCaptureAssets = {
     portraitGuidesImageUrl?: string;
     landscapeGuidesImageUrl?: string;
@@ -16,6 +17,7 @@ export type IdCaptureClassNames = {
     guidanceMessage?: string;
     imagePreview?: IdCaptureImagePreviewClassNames;
     exitCaptureBtn?: string;
+    overrideWrongDocumentTypeGuidanceDialog?: OverrideWrongDocumentTypeGuidanceDialogClassNames;
 };
 export type IdCaptureColors = {
     guideBoxUnsatisfiedColor?: string;
@@ -37,6 +39,7 @@ export type IdCaptureVerbiage = {
     guidanceNotCenteredText?: CustomerSuppliedVerbiage;
     guidanceTooCloseText?: CustomerSuppliedVerbiage;
     guidanceNotDetectedText?: CustomerSuppliedVerbiage;
+    overrideWrongDocumentTypeGuidanceDialog?: OverrideWrongDocumentTypeGuidanceDialogVerbiage;
 };
 export type IdCaptureProps = {
     requiredDocumentType?: CapturedDocumentType;

package/dist/components/id_capture/IdCaptureStateProvider.d.ts

@@ -27,8 +27,10 @@ export type IdCaptureState = {
     documentTooClose: boolean;
     flipRequired: boolean;
     backDetectedFirst: boolean;
-    allowOverrideFlipRequirement: boolean;
-    overrideFlipRequirement: boolean;
+    enableOverrideWrongDocumentTypeDialog: boolean;
+    allowOverrideWrongDocumentTypeAfterMs: number;
+    allowOverrideWrongDocumentTypeGuidance: boolean;
+    overrideWrongDocumentTypeGuidance: boolean;
     wrongDocumentTypePredictions: number;
     idCardFrontDetectionScore: number;
     idCardFrontDetectionThresholdMet: boolean;
@@ -61,6 +63,8 @@ export type IdCaptureAction = {
         captureRequirement: IdCaptureRequirementOption;
         precapturedDocuments?: CapturedDocuments;
         allowIdCardBackToFrontCapture?: boolean;
+        enableOverrideWrongDocumentTypeDialog: boolean;
+        allowOverrideWrongDocumentTypeAfterMs: number;
     };
 } | {
     type: 'setRequiredDocumentType';

package/dist/components/id_capture/IdCaptureWizard.d.ts

@@ -65,10 +65,12 @@ export type IdCaptureWizardProps = {
     silentFallback?: boolean;
     forceFallbackMode?: boolean;
     allowIdCardBackToFrontCapture?: boolean;
+    enableOverrideWrongDocumentTypeDialog?: boolean;
+    allowOverrideWrongDocumentTypeAfterMs?: number;
     assets?: IdCaptureWizardAssets;
     classNames?: IdCaptureWizardClassNames;
     colors?: IdCaptureWizardColors;
     verbiage?: IdCaptureWizardVerbiage;
     debugMode?: boolean;
 };
-export declare const IdCaptureWizard: ({ onSuccess, onExitCapture, onUserCancel, loadingOverlayMode, precapturedDocuments, captureRequirement, separateIdCardCaptureSequence, thresholds, skipSuccessScreen, instructions, releaseCameraAccessOnExit, guideType, portraitGuidesOnMobile, rotateLoadingOverlayImageWhenPortrait, silentFallback, forceFallbackMode, allowIdCardBackToFrontCapture, assets, classNames, colors, verbiage, debugMode, }: IdCaptureWizardProps) => ReactElement;
+export declare const IdCaptureWizard: ({ onSuccess, onExitCapture, onUserCancel, loadingOverlayMode, precapturedDocuments, captureRequirement, separateIdCardCaptureSequence, thresholds, skipSuccessScreen, instructions, releaseCameraAccessOnExit, guideType, portraitGuidesOnMobile, rotateLoadingOverlayImageWhenPortrait, silentFallback, forceFallbackMode, allowIdCardBackToFrontCapture, enableOverrideWrongDocumentTypeDialog, allowOverrideWrongDocumentTypeAfterMs, assets, classNames, colors, verbiage, debugMode, }: IdCaptureWizardProps) => ReactElement;

package/dist/components/id_capture/OverrideWrongDocumentTypeGuidanceDialog.d.ts

@@ -0,0 +1,18 @@
+import React from 'react';
+import { CustomerSuppliedVerbiage } from '../../lib/locales';
+export type OverrideWrongDocumentTypeGuidanceDialogClassNames = {
+    container?: string;
+    inner?: string;
+    message?: string;
+    buttonContainer?: string;
+    button?: string;
+};
+export type OverrideWrongDocumentTypeGuidanceDialogVerbiage = {
+    messageText?: CustomerSuppliedVerbiage;
+    buttonText?: CustomerSuppliedVerbiage;
+};
+export type OverrideWrongDocumentTypeGuidanceDialogProps = {
+    classNames?: OverrideWrongDocumentTypeGuidanceDialogClassNames;
+    verbiage?: OverrideWrongDocumentTypeGuidanceDialogVerbiage;
+};
+export default function OverrideWrongDocumentTypeGuidanceDialog({ classNames, verbiage: rawVerbiage, }: OverrideWrongDocumentTypeGuidanceDialogProps): React.JSX.Element | null;

package/dist/lib/locales/es/translation.d.ts

@@ -99,5 +99,7 @@ declare const _default: {
     'Loading guided capture experience...': string;
     'Guided capture experience ready': string;
     "Let's Go!": string;
+    'We are having trouble identifying the correct side of your id, do you want to continue with capture anyway?': string;
+    OK: string;
 };
 export default _default;

package/dist/lib/locales/index.d.ts

@@ -107,6 +107,8 @@ export declare const resources: {
             'Loading guided capture experience...': string;
             'Guided capture experience ready': string;
             "Let's Go!": string;
+            'We are having trouble identifying the correct side of your id, do you want to continue with capture anyway?': string;
+            OK: string;
         };
     };
 };