idmission-web-sdk 0.0.71 → 0.0.73

package/README.md

@@ -602,3 +602,27 @@ onBeforeSubmit: (req) => new Promise((resolve) => {
 Note that you will receive the request as a parameter to `onBeforeSubmit`, and must `resolve` with the altered version in order for your changes to be committed.
 
 If the promise is rejected or an error is thrown, that rejection value or error will be printed to the logs and the request will be not be sent. The `onRequestFailure` hook will be fired with the error that came from your code.
+
+### Providing multi-language verbiage overrides
+
+Each customer flow documented above includes an optional `verbiage` prop, bearing the type signature `{ [key: string]: CustomerSuppliedVerbiage }`. The `CustomerSuppliedVerbiage` can be a `string` (which overrides all locales), or a `{ [key: string]: string }` containing verbiage overrides in multiple i18n locales.
+
+The level of specificity in locale codes can be controlled by supplying or omitting suffixes, for example, `en-UK` would target only systems configured for British English, which `en` would target all English-speaking locales. Specifying both would show your `en-UK` translation for British users and your `en` translation for everyone else.
+
+For example, if we want to override the header text on the loading overlay of the FaceValidation flow:
+
+```
+verbiage: {
+  loadingOverlay: {
+    headerText: {
+      'en-US': 'Use your device camera to capture your American face',
+      'en-UK': 'Use your device camera to capture your British face',
+      'en': 'Use your device camera to capture your generally English-speaking face'
+    }
+  }
+}
+```
+
+Leaving a locale out of your translation object will result in the default text being shown for that locale, with the rest of your provided translations being honored. This functionality can be leveraged to define translations for languages that the IDmission Web SDK does not yet support. If you end up creating full translations for new languages, feel free to send your translations our way at https://www.idmission.com/company/contact-us/, and we will try to get them added to the main SDK translation set!
+
+The full list of i18n locales can be found here: https://github.com/ladjs/i18n-locales.

package/dist/components/additional_document_capture/AdditionalDocumentCapture.d.ts

@@ -1,4 +1,5 @@
 import { ReactElement } from 'react';
+import { CustomerSuppliedVerbiage } from '../../lib/locales';
 export type AdditionalDocument = {
     name: string;
     description?: string;
@@ -8,10 +9,13 @@ export type UploadedDocument = {
     documentName: string;
     additionalDocument: string | Record<string, string>;
 };
+export type AdditionalDocumentCaptureVerbiage = {
+    headingText?: CustomerSuppliedVerbiage;
+    nextBtnText?: CustomerSuppliedVerbiage;
+};
 export type AdditionalDocumentCaptureProps = {
     document: AdditionalDocument;
     onComplete?: (uploadedDocument: UploadedDocument) => void;
-    headingText?: string;
-    nextBtnText?: string;
+    verbiage?: AdditionalDocumentCaptureVerbiage;
 };
-export declare const AdditionalDocumentCapture: ({ document, onComplete, headingText, nextBtnText, }: AdditionalDocumentCaptureProps) => ReactElement;
+export declare const AdditionalDocumentCapture: ({ document, onComplete, verbiage: rawVerbiage, }: AdditionalDocumentCaptureProps) => ReactElement;

package/dist/components/additional_document_capture/AdditionalDocumentCaptureWizard.d.ts

@@ -1,12 +1,9 @@
 import { ReactElement } from 'react';
-import { AdditionalDocument, UploadedDocument } from './AdditionalDocumentCapture';
-export type AdditionalDocumentCaptureVerbiage = {
-    headingText?: string;
-    nextBtnText?: string;
-};
+import { AdditionalDocument, AdditionalDocumentCaptureVerbiage, UploadedDocument } from './AdditionalDocumentCapture';
+export type AdditionalDocumentCaptureWizardVerbiage = AdditionalDocumentCaptureVerbiage;
 export type AdditionalDocumentCaptureWizardProps = {
     documents: AdditionalDocument[];
     onComplete?: (uploadedDocuments: UploadedDocument[]) => void;
-    verbiage?: AdditionalDocumentCaptureVerbiage;
+    verbiage?: AdditionalDocumentCaptureWizardVerbiage;
 };
 export declare const AdditionalDocumentCaptureWizard: ({ documents, onComplete, verbiage, }: AdditionalDocumentCaptureWizardProps) => ReactElement;

package/dist/components/camera/CameraAccessDeniedOverlay.d.ts

@@ -1,5 +1,6 @@
 import { ReactElement } from 'react';
 import { LoaderButtonColors } from '../common/LoaderButton';
+import { CustomerSuppliedVerbiage } from '../../lib/locales';
 export type CameraAccessDeniedOverlayAssets = {
     imageUrl?: string;
 };
@@ -7,13 +8,13 @@ export type CameraAccessDeniedOverlayColors = {
     retryBtn?: LoaderButtonColors;
 };
 export type CameraAccessDeniedOverlayVerbiage = {
-    headingText?: string;
-    descriptionText?: string;
-    retryBtnText?: string;
+    headingText?: CustomerSuppliedVerbiage;
+    descriptionText?: CustomerSuppliedVerbiage;
+    retryBtnText?: CustomerSuppliedVerbiage;
 };
 export type CameraAccessDeniedOverlayProps = {
     assets?: CameraAccessDeniedOverlayAssets;
     colors?: CameraAccessDeniedOverlayColors;
     verbiage?: CameraAccessDeniedOverlayVerbiage;
 };
-export declare const CameraAccessDeniedOverlay: ({ assets, colors, verbiage, }: CameraAccessDeniedOverlayProps) => ReactElement;
+export declare const CameraAccessDeniedOverlay: ({ assets, colors, verbiage: rawVerbiage, }: CameraAccessDeniedOverlayProps) => ReactElement;

package/dist/components/common/SelfieProgressPreview.d.ts

@@ -1,4 +1,8 @@
 /// <reference types="react" />
+export declare const IdCaptureImagePreview: ({ text, imageUrl, }: {
+    text?: string | undefined;
+    imageUrl: string;
+}) => JSX.Element;
 export declare const SelfieProgressPreview: ({ imageUrl }: {
     imageUrl: string;
 }) => JSX.Element;

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

@@ -1,7 +1,7 @@
 import { ReactElement } from 'react';
 import { SubmissionEnvironment, SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
 import { FaceLivenessAssets, FaceLivenessColors, FaceLivenessVerbiage } from '../face_liveness/FaceLivenessWizard';
-import { AdditionalDocumentCaptureVerbiage } from '../additional_document_capture/AdditionalDocumentCaptureWizard';
+import { AdditionalDocumentCaptureWizardVerbiage } from '../additional_document_capture/AdditionalDocumentCaptureWizard';
 import { AdditionalDocument } from '../additional_document_capture/AdditionalDocumentCapture';
 import { LangOption } from '../../lib/locales';
 import { SignatureCaptureVerbiage } from '../signature_capture/SignatureCapture';
@@ -15,7 +15,7 @@ export type CustomerBiometricsEnrollmentColors = {
 };
 export type CustomerBiometricsEnrollmentVerbiage = {
     faceLiveness?: FaceLivenessVerbiage;
-    additionalDocumentCapture?: AdditionalDocumentCaptureVerbiage;
+    additionalDocumentCapture?: AdditionalDocumentCaptureWizardVerbiage;
     signatureCapture?: SignatureCaptureVerbiage;
     videoSignatureCapture?: VideoSignatureVerbiage;
 };

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

@@ -2,7 +2,7 @@ import { ReactElement } from 'react';
 import { CardData, PersonalData, SubmissionEnvironment, SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
 import { FaceLivenessAssets, FaceLivenessColors, FaceLivenessVerbiage } from '../face_liveness/FaceLivenessWizard';
 import { IdCaptureWizardAssets, IdCaptureWizardColors, IdCaptureWizardVerbiage } from '../id_capture/IdCaptureWizard';
-import { AdditionalDocumentCaptureVerbiage } from '../additional_document_capture/AdditionalDocumentCaptureWizard';
+import { AdditionalDocumentCaptureWizardVerbiage } from '../additional_document_capture/AdditionalDocumentCaptureWizard';
 import { AdditionalDocument } from '../additional_document_capture/AdditionalDocumentCapture';
 import { LangOption } from '../../lib/locales';
 import { SignatureCaptureVerbiage } from '../signature_capture/SignatureCapture';
@@ -19,7 +19,7 @@ export type CustomerEnrollmentColors = {
 export type CustomerEnrollmentVerbiage = {
     idCapture?: IdCaptureWizardVerbiage;
     faceLiveness?: FaceLivenessVerbiage;
-    additionalDocumentCapture?: AdditionalDocumentCaptureVerbiage;
+    additionalDocumentCapture?: AdditionalDocumentCaptureWizardVerbiage;
     signatureCapture?: SignatureCaptureVerbiage;
     videoSignatureCapture?: VideoSignatureVerbiage;
 };

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

@@ -2,7 +2,7 @@ import { ReactElement } from 'react';
 import { CardData, PersonalData, SubmissionEnvironment, SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
 import { FaceLivenessAssets, FaceLivenessColors, FaceLivenessVerbiage } from '../face_liveness/FaceLivenessWizard';
 import { IdCaptureWizardAssets, IdCaptureWizardColors, IdCaptureWizardVerbiage } from '../id_capture/IdCaptureWizard';
-import { AdditionalDocumentCaptureVerbiage } from '../additional_document_capture/AdditionalDocumentCaptureWizard';
+import { AdditionalDocumentCaptureWizardVerbiage } from '../additional_document_capture/AdditionalDocumentCaptureWizard';
 import { AdditionalDocument } from '../additional_document_capture/AdditionalDocumentCapture';
 import { LangOption } from '../../lib/locales';
 import { SignatureCaptureVerbiage } from '../signature_capture/SignatureCapture';
@@ -19,7 +19,7 @@ export type IdAndFaceValidationColors = {
 export type IdAndFaceValidationVerbiage = {
     idCapture?: IdCaptureWizardVerbiage;
     faceLiveness?: FaceLivenessVerbiage;
-    additionalDocumentCapture?: AdditionalDocumentCaptureVerbiage;
+    additionalDocumentCapture?: AdditionalDocumentCaptureWizardVerbiage;
     signatureCapture?: SignatureCaptureVerbiage;
     videoSignatureCapture?: VideoSignatureVerbiage;
 };

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

@@ -1,7 +1,7 @@
 import { ReactElement } from 'react';
 import { CardData, PersonalData, SubmissionEnvironment, SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
 import { IdCaptureWizardAssets, IdCaptureWizardColors, IdCaptureWizardVerbiage } from '../id_capture/IdCaptureWizard';
-import { AdditionalDocumentCaptureVerbiage } from '../additional_document_capture/AdditionalDocumentCaptureWizard';
+import { AdditionalDocumentCaptureWizardVerbiage } from '../additional_document_capture/AdditionalDocumentCaptureWizard';
 import { AdditionalDocument } from '../additional_document_capture/AdditionalDocumentCapture';
 import { LangOption } from '../../lib/locales';
 import { SignatureCaptureVerbiage } from '../signature_capture/SignatureCapture';
@@ -11,7 +11,7 @@ export type IdValidationColors = IdCaptureWizardColors & {
     videoSignatureCapture?: VideoSignatureColors;
 };
 export type IdValidationVerbiage = IdCaptureWizardVerbiage & {
-    additionalDocumentCapture?: AdditionalDocumentCaptureVerbiage;
+    additionalDocumentCapture?: AdditionalDocumentCaptureWizardVerbiage;
     signatureCapture?: SignatureCaptureVerbiage;
     videoSignatureCapture?: VideoSignatureVerbiage;
 };

package/dist/components/customer_identification/CustomerIdentificationFailure.d.ts

@@ -1,5 +1,6 @@
 import { ReactElement } from 'react';
 import { LoaderButtonColors } from '../common/LoaderButton';
+import { CustomerSuppliedVerbiage } from '../../lib/locales';
 export type CustomerIdentificationFailureAssets = {
     imageUrl?: string;
 };
@@ -8,9 +9,9 @@ export type CustomerIdentificationFailureColors = {
     exitBtn?: LoaderButtonColors;
 };
 export type CustomerIdentificationFailureVerbiage = {
-    headingText?: string;
-    retryBtnText?: string;
-    exitBtnText?: string;
+    headingText?: CustomerSuppliedVerbiage;
+    retryBtnText?: CustomerSuppliedVerbiage;
+    exitBtnText?: CustomerSuppliedVerbiage;
 };
 export type CustomerIdentificationFailureProps = {
     canRetry?: boolean;
@@ -20,4 +21,4 @@ export type CustomerIdentificationFailureProps = {
     colors?: CustomerIdentificationFailureColors;
     verbiage?: CustomerIdentificationFailureVerbiage;
 };
-export declare const CustomerIdentificationFailure: ({ canRetry, onRetryClick, onExitClick, assets, colors, verbiage, }: CustomerIdentificationFailureProps) => ReactElement;
+export declare const CustomerIdentificationFailure: ({ canRetry, onRetryClick, onExitClick, assets, colors, verbiage: rawVerbiage, }: CustomerIdentificationFailureProps) => ReactElement;

package/dist/components/customer_identification/CustomerIdentificationSuccess.d.ts

@@ -1,13 +1,14 @@
 import { ReactElement } from 'react';
 import { LoaderButtonColors } from '../common/LoaderButton';
+import { CustomerSuppliedVerbiage } from '../../lib/locales';
 export type CustomerIdentificationSuccessColors = {
     doneBtn?: LoaderButtonColors;
     retryBtn?: LoaderButtonColors;
 };
 export type CustomerIdentificationSuccessVerbiage = {
-    headingText?: string;
-    retryBtnText?: string;
-    doneBtnText?: string;
+    headingText?: CustomerSuppliedVerbiage;
+    retryBtnText?: CustomerSuppliedVerbiage;
+    doneBtnText?: CustomerSuppliedVerbiage;
 };
 export type CustomerIdentificationSuccessProps = {
     imageUrl: string;
@@ -16,4 +17,4 @@ export type CustomerIdentificationSuccessProps = {
     colors?: CustomerIdentificationSuccessColors;
     verbiage?: CustomerIdentificationSuccessVerbiage;
 };
-export declare const CustomerIdentificationSuccess: ({ imageUrl, onDoneClick, onRetryClick, colors, verbiage, }: CustomerIdentificationSuccessProps) => ReactElement;
+export declare const CustomerIdentificationSuccess: ({ imageUrl, onDoneClick, onRetryClick, colors, verbiage: rawVerbiage, }: CustomerIdentificationSuccessProps) => ReactElement;

package/dist/components/customer_verification/CustomerVerificationFailure.d.ts

@@ -1,5 +1,6 @@
 import { ReactElement } from 'react';
 import { LoaderButtonColors } from '../common/LoaderButton';
+import { CustomerSuppliedVerbiage } from '../../lib/locales';
 export type CustomerVerificationFailureAssets = {
     imageUrl?: string;
 };
@@ -8,9 +9,9 @@ export type CustomerVerificationFailureColors = {
     exitBtn?: LoaderButtonColors;
 };
 export type CustomerVerificationFailureVerbiage = {
-    headingText?: string;
-    retryBtnText?: string;
-    exitBtnText?: string;
+    headingText?: CustomerSuppliedVerbiage;
+    retryBtnText?: CustomerSuppliedVerbiage;
+    exitBtnText?: CustomerSuppliedVerbiage;
 };
 export type CustomerVerificationFailureProps = {
     canRetry?: boolean;
@@ -20,4 +21,4 @@ export type CustomerVerificationFailureProps = {
     colors?: CustomerVerificationFailureColors;
     verbiage?: CustomerVerificationFailureVerbiage;
 };
-export declare const CustomerVerificationFailure: ({ canRetry, onRetryClick, onExitClick, assets, colors, verbiage, }: CustomerVerificationFailureProps) => ReactElement;
+export declare const CustomerVerificationFailure: ({ canRetry, onRetryClick, onExitClick, assets, colors, verbiage: rawVerbiage, }: CustomerVerificationFailureProps) => ReactElement;

package/dist/components/customer_verification/CustomerVerificationSuccess.d.ts

@@ -1,13 +1,14 @@
 import { ReactElement } from 'react';
 import { LoaderButtonColors } from '../common/LoaderButton';
+import { CustomerSuppliedVerbiage } from '../../lib/locales';
 export type CustomerVerificationSuccessColors = {
     doneBtn?: LoaderButtonColors;
     retryBtn?: LoaderButtonColors;
 };
 export type CustomerVerificationSuccessVerbiage = {
-    headingText?: string;
-    retryBtnText?: string;
-    doneBtnText?: string;
+    headingText?: CustomerSuppliedVerbiage;
+    retryBtnText?: CustomerSuppliedVerbiage;
+    doneBtnText?: CustomerSuppliedVerbiage;
 };
 export type CustomerVerificationSuccessProps = {
     imageUrl: string;
@@ -16,4 +17,4 @@ export type CustomerVerificationSuccessProps = {
     colors?: CustomerVerificationSuccessColors;
     verbiage?: CustomerVerificationSuccessVerbiage;
 };
-export declare const CustomerVerificationSuccess: ({ imageUrl, onDoneClick, onRetryClick, colors, verbiage, }: CustomerVerificationSuccessProps) => ReactElement;
+export declare const CustomerVerificationSuccess: ({ imageUrl, onDoneClick, onRetryClick, colors, verbiage: rawVerbiage, }: CustomerVerificationSuccessProps) => ReactElement;

package/dist/components/face_liveness/FaceLivenessCapture.d.ts

@@ -1,10 +1,11 @@
 import { ReactElement } from 'react';
 import { SelfieCaptureColors, SelfieCaptureVerbiage } from '../selfie_capture/SelfieCapture';
+import { CustomerSuppliedVerbiage } from '../../lib/locales';
 export type FaceLivenessCaptureColors = SelfieCaptureColors;
 export type FaceLivenessCaptureVerbiage = SelfieCaptureVerbiage & {
-    guidanceRemoveEyeCoveringsText?: string;
-    guidanceRemoveHeadCoveringsText?: string;
-    guidanceRemoveMaskText?: string;
+    guidanceRemoveEyeCoveringsText?: CustomerSuppliedVerbiage;
+    guidanceRemoveHeadCoveringsText?: CustomerSuppliedVerbiage;
+    guidanceRemoveMaskText?: CustomerSuppliedVerbiage;
 };
 export type FaceLivenessCaptureProps = {
     onCapture?: () => void;
@@ -16,4 +17,4 @@ export type FaceLivenessCaptureProps = {
     verbiage?: FaceLivenessCaptureVerbiage;
     debugMode?: boolean;
 };
-export declare const FaceLivenessCapture: ({ onCapture, onSuccess, onTimeout, onExit, timeoutDurationMs, colors, verbiage, debugMode, }: FaceLivenessCaptureProps) => ReactElement;
+export declare const FaceLivenessCapture: ({ onCapture, onSuccess, onTimeout, onExit, timeoutDurationMs, colors, verbiage: rawVerbiage, debugMode, }: FaceLivenessCaptureProps) => ReactElement;

package/dist/components/face_liveness/FaceLivenessFailure.d.ts

@@ -1,5 +1,6 @@
 import { ReactElement } from 'react';
 import { LoaderButtonColors } from '../common/LoaderButton';
+import { CustomerSuppliedVerbiage } from '../../lib/locales';
 export type FaceLivenessFailureAssets = {
     imageUrl?: string;
 };
@@ -8,9 +9,9 @@ export type FaceLivenessFailureColors = {
     exitBtn?: LoaderButtonColors;
 };
 export type FaceLivenessFailureVerbiage = {
-    headingText?: string;
-    retryBtnText?: string;
-    exitBtnText?: string;
+    headingText?: CustomerSuppliedVerbiage;
+    retryBtnText?: CustomerSuppliedVerbiage;
+    exitBtnText?: CustomerSuppliedVerbiage;
 };
 export type FaceLivenessFailureProps = {
     canRetry?: boolean;
@@ -20,4 +21,4 @@ export type FaceLivenessFailureProps = {
     colors?: FaceLivenessFailureColors;
     verbiage?: FaceLivenessFailureVerbiage;
 };
-export declare const FaceLivenessFailure: ({ canRetry, onRetryClick, onExitClick, assets, colors, verbiage, }: FaceLivenessFailureProps) => ReactElement;
+export declare const FaceLivenessFailure: ({ canRetry, onRetryClick, onExitClick, assets, colors, verbiage: rawVerbiage, }: FaceLivenessFailureProps) => ReactElement;

package/dist/components/face_liveness/FaceLivenessSuccess.d.ts

@@ -1,13 +1,14 @@
 import { ReactElement } from 'react';
 import { LoaderButtonColors } from '../common/LoaderButton';
+import { CustomerSuppliedVerbiage } from '../../lib/locales';
 export type FaceLivenessSuccessColors = {
     doneBtn?: LoaderButtonColors;
     retryBtn?: LoaderButtonColors;
 };
 export type FaceLivenessSuccessVerbiage = {
-    headingText?: string;
-    retryBtnText?: string;
-    doneBtnText?: string;
+    headingText?: CustomerSuppliedVerbiage;
+    retryBtnText?: CustomerSuppliedVerbiage;
+    doneBtnText?: CustomerSuppliedVerbiage;
 };
 export type FaceLivenessSuccessProps = {
     imageUrl: string;
@@ -16,4 +17,4 @@ export type FaceLivenessSuccessProps = {
     colors?: FaceLivenessSuccessColors;
     verbiage?: FaceLivenessSuccessVerbiage;
 };
-export declare const FaceLivenessSuccess: ({ imageUrl, onDoneClick, onRetryClick, colors, verbiage, }: FaceLivenessSuccessProps) => ReactElement;
+export declare const FaceLivenessSuccess: ({ imageUrl, onDoneClick, onRetryClick, colors, verbiage: rawVerbiage, }: FaceLivenessSuccessProps) => ReactElement;

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

@@ -1,4 +1,5 @@
 import { ReactElement } from 'react';
+import { CustomerSuppliedVerbiage } from '../../lib/locales';
 export type FlipIdPromptAssets = {
     frontPortraitGuidesImageUrl?: string;
     frontLandscapeGuidesImageUrl?: string;
@@ -6,7 +7,7 @@ export type FlipIdPromptAssets = {
     backLandscapeGuidesImageUrl?: string;
 };
 export type FlipIdPromptVerbiage = {
-    instructionText?: string;
+    instructionText?: CustomerSuppliedVerbiage;
 };
 export type FlipIdPromptProps = {
     assets?: FlipIdPromptAssets;

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

@@ -4,6 +4,7 @@ import { DocumentType } from '../../lib/models/DocumentDetection';
 import { PDF417DetectionResult } from '../../lib/barcode/Native';
 import { CaptureAttemptMetadata } from '../../contexts/SubmissionContext';
 import { IdCapturePrediction } from './IdCaptureModelsProvider';
+import { CustomerSuppliedVerbiage } from '../../lib/locales';
 export type IdCaptureAssets = {
     portraitGuidesImageUrl?: string;
     landscapeGuidesImageUrl?: string;
@@ -13,9 +14,10 @@ export type IdCaptureColors = {
     guideBoxSatisfiedColor?: string;
 };
 export type IdCaptureVerbiage = {
-    instructionText?: string;
-    capturingText?: string;
-    captureFailedText?: string;
+    instructionText?: CustomerSuppliedVerbiage;
+    processingIdCardText?: CustomerSuppliedVerbiage;
+    capturingText?: CustomerSuppliedVerbiage;
+    captureFailedText?: CustomerSuppliedVerbiage;
 };
 export type IdCaptureProps = {
     requiredDocumentType?: DocumentType;
@@ -40,4 +42,4 @@ export type IdCaptureProps = {
     verbiage?: IdCaptureVerbiage;
     debugMode?: boolean;
 };
-export declare const IdCapture: ({ requiredDocumentType, autoCaptureEnabled, autoCaptureScoreThreshold, autoCaptureGoodFramesRequired, autoCaptureBarcodeRequired, mrzDetectionScoreThreshold, passportPageDetectionThreshold, pdf417DetectionThreshold, focusScoreThreshold, barcodeScanningEnabled, maxBarcodeScanAttempts, onPrediction, onBarcodeScanned, onCapture, onExit, processingScreen, processingDelay, assets, colors, verbiage, debugMode, }: IdCaptureProps) => React.ReactElement;
+export declare const IdCapture: ({ requiredDocumentType, autoCaptureEnabled, autoCaptureScoreThreshold, autoCaptureGoodFramesRequired, autoCaptureBarcodeRequired, mrzDetectionScoreThreshold, passportPageDetectionThreshold, pdf417DetectionThreshold, focusScoreThreshold, barcodeScanningEnabled, maxBarcodeScanAttempts, onPrediction, onBarcodeScanned, onCapture, onExit, processingScreen, processingDelay, assets, colors, verbiage: rawVerbiage, debugMode, }: IdCaptureProps) => React.ReactElement;

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

@@ -1,6 +1,7 @@
 import { ReactElement } from 'react';
 import { CameraAccessDeniedOverlayAssets, CameraAccessDeniedOverlayColors, CameraAccessDeniedOverlayVerbiage } from '../camera/CameraAccessDeniedOverlay';
 import { LoaderButtonColors } from '../common/LoaderButton';
+import { CustomerSuppliedVerbiage } from '../../lib/locales';
 export type IdCaptureLoadingOverlayAssets = {
     instructionImageUrl?: string;
     cameraAccessDenied?: CameraAccessDeniedOverlayAssets;
@@ -10,11 +11,11 @@ export type IdCaptureLoadingOverlayColors = {
     cameraAccessDenied?: CameraAccessDeniedOverlayColors;
 };
 export type IdCaptureLoadingOverlayVerbiage = {
-    headingText?: string;
-    useContinuityCameraText?: string;
-    modelsWarmingUpText?: string;
-    cameraInitializingText?: string;
-    continueText?: string;
+    headingText?: CustomerSuppliedVerbiage;
+    useContinuityCameraText?: CustomerSuppliedVerbiage;
+    modelsWarmingUpText?: CustomerSuppliedVerbiage;
+    cameraInitializingText?: CustomerSuppliedVerbiage;
+    continueText?: CustomerSuppliedVerbiage;
     cameraAccessDenied?: CameraAccessDeniedOverlayVerbiage;
 };
 export type IdCaptureLoadingOverlayProps = {
@@ -23,4 +24,4 @@ export type IdCaptureLoadingOverlayProps = {
     colors?: IdCaptureLoadingOverlayColors;
     verbiage?: IdCaptureLoadingOverlayVerbiage;
 };
-export declare const IdCaptureLoadingOverlay: ({ onDismissed, assets, colors, verbiage, }: IdCaptureLoadingOverlayProps) => ReactElement;
+export declare const IdCaptureLoadingOverlay: ({ onDismissed, assets, colors, verbiage: rawVerbiage, }: IdCaptureLoadingOverlayProps) => ReactElement;

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

@@ -2,15 +2,16 @@ import { ReactElement } from 'react';
 import { CapturedDocuments } from '../additional_document_capture/CapturedDocuments';
 import { PDF417DetectionResult } from '../../lib/barcode/Native';
 import { LoaderButtonColors } from '../common/LoaderButton';
+import { CustomerSuppliedVerbiage } from '../../lib/locales';
 export type IdCaptureSuccessVerbiage = {
-    headingText?: string;
-    idCardFrontText?: string;
-    idCardBackText?: string;
-    passportText?: string;
-    instructionText?: string;
-    retryText?: string;
-    submittingText?: string;
-    submitText?: string;
+    headingText?: CustomerSuppliedVerbiage;
+    idCardFrontText?: CustomerSuppliedVerbiage;
+    idCardBackText?: CustomerSuppliedVerbiage;
+    passportText?: CustomerSuppliedVerbiage;
+    instructionText?: CustomerSuppliedVerbiage;
+    retryText?: CustomerSuppliedVerbiage;
+    submittingText?: CustomerSuppliedVerbiage;
+    submitText?: CustomerSuppliedVerbiage;
 };
 export type IdCaptureSuccessColors = {
     doneBtn?: LoaderButtonColors;
@@ -24,4 +25,4 @@ export type IdCaptureSuccessProps = {
     colors?: IdCaptureSuccessColors;
     verbiage?: IdCaptureSuccessVerbiage;
 };
-export declare const IdCaptureSuccess: ({ capturedDocuments, onSubmitClick, onRetryClick, colors, verbiage, }: IdCaptureSuccessProps) => ReactElement;
+export declare const IdCaptureSuccess: ({ capturedDocuments, onSubmitClick, onRetryClick, colors, verbiage: rawVerbiage, }: IdCaptureSuccessProps) => ReactElement;

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

@@ -1,8 +1,8 @@
 import { ReactElement } from 'react';
 import { IdCaptureAssets, IdCaptureColors, IdCaptureVerbiage } from './IdCapture';
-import { IdCaptureLoadingOverlayAssets, IdCaptureLoadingOverlayVerbiage } from './IdCaptureLoadingOverlay';
+import { IdCaptureLoadingOverlayAssets, IdCaptureLoadingOverlayColors, IdCaptureLoadingOverlayVerbiage } from './IdCaptureLoadingOverlay';
 import { FlipIdPromptAssets, FlipIdPromptVerbiage } from './FlipIdPrompt';
-import { IdCaptureSuccessVerbiage } from './IdCaptureSuccess';
+import { IdCaptureSuccessColors, IdCaptureSuccessVerbiage } from './IdCaptureSuccess';
 export type IdCaptureWizardAssets = {
     documentDetectionModelUrl?: string;
     focusModelUrl?: string;
@@ -12,7 +12,10 @@ export type IdCaptureWizardAssets = {
     passport?: IdCaptureAssets;
     flipIdPrompt?: FlipIdPromptAssets;
 };
-export type IdCaptureWizardColors = IdCaptureColors;
+export type IdCaptureWizardColors = IdCaptureColors & {
+    loadingOverlay?: IdCaptureLoadingOverlayColors;
+    success?: IdCaptureSuccessColors;
+};
 export type IdCaptureWizardVerbiage = {
     loadingOverlay?: IdCaptureLoadingOverlayVerbiage;
     idCardFront?: IdCaptureVerbiage;

package/dist/components/selfie_capture/SelfieCapture.d.ts

@@ -1,5 +1,6 @@
 import { ReactElement } from 'react';
 import { Face } from './HighPerformanceSelfieGuidanceModelsProvider';
+import { CustomerSuppliedVerbiage } from '../../lib/locales';
 export type SelfieCaptureColors = {
     guidesUnsatisfiedColor?: string;
     guidesSatisfiedColor?: string;
@@ -9,11 +10,11 @@ export type SelfieCaptureColors = {
     guidanceMessagesUnsatisfiedTextColor?: string;
 };
 export type SelfieCaptureVerbiage = {
-    guidanceHoldStillText?: string;
-    guidanceLookStraightText?: string;
-    guidanceMoveBackText?: string;
-    guidanceMoveForwardText?: string;
-    guidanceMoveToCenterText?: string;
+    guidanceHoldStillText?: CustomerSuppliedVerbiage;
+    guidanceLookStraightText?: CustomerSuppliedVerbiage;
+    guidanceMoveBackText?: CustomerSuppliedVerbiage;
+    guidanceMoveForwardText?: CustomerSuppliedVerbiage;
+    guidanceMoveToCenterText?: CustomerSuppliedVerbiage;
 };
 export type SelfieCaptureProps = {
     onGuidanceSatisfied?: () => void;
@@ -23,8 +24,9 @@ export type SelfieCaptureProps = {
     onExit?: () => void;
     timeoutDurationMs?: number;
     guidanceMessage?: string;
+    guidanceSatisfied?: boolean;
     colors?: SelfieCaptureColors;
     verbiage?: SelfieCaptureVerbiage;
     debugMode?: boolean;
 };
-export declare const SelfieCapture: ({ onGuidanceSatisfied, onGuidanceNotSatisfied, onSelfieCaptured, onTimeout, onExit, timeoutDurationMs, guidanceMessage, colors, verbiage, debugMode, }: SelfieCaptureProps) => ReactElement;
+export declare const SelfieCapture: ({ onGuidanceSatisfied, onGuidanceNotSatisfied, onSelfieCaptured, onTimeout, onExit, timeoutDurationMs, guidanceMessage, guidanceSatisfied, colors, verbiage: rawVerbiage, debugMode, }: SelfieCaptureProps) => ReactElement;

package/dist/components/selfie_capture/SelfieCaptureLoadingOverlay.d.ts

@@ -1,6 +1,7 @@
 import { ReactElement } from 'react';
 import { CameraAccessDeniedOverlayAssets, CameraAccessDeniedOverlayColors, CameraAccessDeniedOverlayVerbiage } from '../camera/CameraAccessDeniedOverlay';
 import { LoaderButtonColors } from '../common/LoaderButton';
+import { CustomerSuppliedVerbiage } from '../../lib/locales';
 export type SelfieCaptureLoadingOverlayAssets = {
     instructionImageUrl?: string;
     cameraAccessDenied?: CameraAccessDeniedOverlayAssets;
@@ -10,12 +11,12 @@ export type SelfieCaptureLoadingOverlayColors = {
     cameraAccessDenied?: CameraAccessDeniedOverlayColors;
 };
 export type SelfieCaptureLoadingOverlayVerbiage = {
-    headingText?: string;
-    removeEyeCoveringsText?: string;
-    avoidExcessiveBacklightingText?: string;
-    continueText?: string;
-    cameraInitializingText?: string;
-    modelsWarmingUpText?: string;
+    headingText?: CustomerSuppliedVerbiage;
+    removeEyeCoveringsText?: CustomerSuppliedVerbiage;
+    avoidExcessiveBacklightingText?: CustomerSuppliedVerbiage;
+    continueText?: CustomerSuppliedVerbiage;
+    cameraInitializingText?: CustomerSuppliedVerbiage;
+    modelsWarmingUpText?: CustomerSuppliedVerbiage;
     cameraAccessDenied?: CameraAccessDeniedOverlayVerbiage;
 };
 export type SelfieCaptureLoadingOverlayProps = {
@@ -24,4 +25,4 @@ export type SelfieCaptureLoadingOverlayProps = {
     colors?: SelfieCaptureLoadingOverlayColors;
     verbiage?: SelfieCaptureLoadingOverlayVerbiage;
 };
-export declare const SelfieCaptureLoadingOverlay: ({ onDismissed, assets, colors, verbiage, }: SelfieCaptureLoadingOverlayProps) => ReactElement;
+export declare const SelfieCaptureLoadingOverlay: ({ onDismissed, assets, colors, verbiage: rawVerbiage, }: SelfieCaptureLoadingOverlayProps) => ReactElement;

package/dist/components/signature_capture/SignatureCapture.d.ts

@@ -1,13 +1,14 @@
 import React from 'react';
 import { SignatureData } from './data';
+import { CustomerSuppliedVerbiage } from '../../lib/locales';
 export type SignatureCaptureVerbiage = {
-    headingText?: string;
-    acceptBtnText?: string;
-    clearBtnText?: string;
+    headingText?: CustomerSuppliedVerbiage;
+    acceptBtnText?: CustomerSuppliedVerbiage;
+    clearBtnText?: CustomerSuppliedVerbiage;
 };
 export type SignatureCaptureProps = {
     onAccept?: (signatureData: SignatureData, imageData: string) => void;
     background?: string;
     verbiage?: SignatureCaptureVerbiage;
 };
-export declare const SignatureCapture: ({ onAccept, verbiage, }: SignatureCaptureProps) => React.ReactElement;
+export declare const SignatureCapture: ({ onAccept, verbiage: rawVerbiage, }: SignatureCaptureProps) => React.ReactElement;

package/dist/components/video_signature_capture/VideoSignatureCapture.d.ts

@@ -1,13 +1,14 @@
 import React from 'react';
 import { SignatureData } from '../signature_capture/data';
+import { CustomerSuppliedVerbiage } from '../../lib/locales';
 export type VideoSignatureCaptureColors = {
     guidanceMessageBackgroundColor?: string;
     guidanceMessageTextColor?: string;
 };
 export type VideoSignatureCaptureVerbiage = {
-    guidanceMessageText?: string;
-    acceptBtnText?: string;
-    clearBtnText?: string;
+    guidanceMessageText?: CustomerSuppliedVerbiage;
+    acceptBtnText?: CustomerSuppliedVerbiage;
+    clearBtnText?: CustomerSuppliedVerbiage;
 };
 export type VideoSignatureCaptureProps = {
     onVideoCaptured?: (videoData: Blob, signatureData: SignatureData, signatureImageData: string) => void;
@@ -17,4 +18,4 @@ export type VideoSignatureCaptureProps = {
     verbiage?: VideoSignatureCaptureVerbiage;
     debugMode?: boolean;
 };
-export declare const VideoSignatureCapture: ({ onVideoCaptured, onFaceNotDetected, onExit, colors, verbiage, debugMode, }: VideoSignatureCaptureProps) => React.ReactElement;
+export declare const VideoSignatureCapture: ({ onVideoCaptured, onFaceNotDetected, onExit, colors, verbiage: rawVerbiage, debugMode, }: VideoSignatureCaptureProps) => React.ReactElement;

package/dist/components/video_signature_capture/VideoSignatureSuccess.d.ts

@@ -1,13 +1,14 @@
 import { ReactElement } from 'react';
 import { LoaderButtonColors } from '../common/LoaderButton';
+import { CustomerSuppliedVerbiage } from '../../lib/locales';
 export type VideoSignatureSuccessColors = {
     retryBtn?: LoaderButtonColors;
     doneBtn?: LoaderButtonColors;
 };
 export type VideoSignatureSuccessVerbiage = {
-    headingText?: string;
-    retryBtnText?: string;
-    doneBtnText?: string;
+    headingText?: CustomerSuppliedVerbiage;
+    retryBtnText?: CustomerSuppliedVerbiage;
+    doneBtnText?: CustomerSuppliedVerbiage;
 };
 export type VideoSignatureSuccessProps = {
     videoUrl: string;
@@ -16,4 +17,4 @@ export type VideoSignatureSuccessProps = {
     colors?: VideoSignatureSuccessColors;
     verbiage?: VideoSignatureSuccessVerbiage;
 };
-export declare const VideoSignatureSuccess: ({ videoUrl, onDoneClick, onRetryClick, colors, verbiage, }: VideoSignatureSuccessProps) => ReactElement;
+export declare const VideoSignatureSuccess: ({ videoUrl, onDoneClick, onRetryClick, colors, verbiage: rawVerbiage, }: VideoSignatureSuccessProps) => ReactElement;

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

@@ -20,6 +20,7 @@ declare const _default: {
     'Capturing...': string;
     'Capture failed!': string;
     'Please flip your ID card...': string;
+    'ID card front captured.': string;
     'ID Capture Successful': string;
     'Verify the entire ID was captured clearly with no glare.': string;
     Submit: string;