idmission-web-sdk 2.1.49 → 2.1.50

package/dist/components/CompositeWizard.d.ts

@@ -1,13 +1,12 @@
 import { ReactElement } from 'react';
 import { IdCaptureWizardProps } from './id_capture/IdCaptureWizard';
 import { FaceLivenessWizardProps } from './face_liveness/FaceLivenessWizard';
-import { SubmissionAction, SubmissionResponse } from '../contexts/SubmissionContext';
 import { AdditionalDocumentCaptureWizardProps } from './additional_document_capture/AdditionalDocumentCaptureWizard';
 import { SignatureCaptureProps } from './signature_capture/SignatureCapture';
 import { VideoSignatureWizardProps } from './video_signature_capture/VideoSignatureWizard';
 import { VideoIdWizardProps } from './video_id/IdVideoCaptureWizard';
 export type CompositeWizardCheck = 'IdCapture' | 'FaceLiveness' | 'SignatureCapture' | 'VideoSignatureCapture' | 'AdditionalDocumentCapture' | 'VideoIdCapture';
-export type CompositeWizardComponentProps = {
+export type CompositeWizardProps = {
     checks: CompositeWizardCheck[];
     idCaptureProps?: IdCaptureWizardProps;
     faceLivenessProps?: FaceLivenessWizardProps;
@@ -21,12 +20,4 @@ export type CompositeWizardComponentProps = {
     onMicrophoneAccessDenied?: () => void;
     debugMode?: boolean;
 };
-export type CompositeWizardProps = CompositeWizardComponentProps & {
-    sessionId: string;
-    submissionAction?: SubmissionAction;
-    submissionUrl?: string;
-    authUrl?: string;
-    onComplete?: (submissionResponse: SubmissionResponse) => void;
-};
-export declare const CompositeWizard: (props: CompositeWizardProps) => ReactElement;
-export declare const CompositeWizardComponent: ({ checks: userChecks, idCaptureProps, faceLivenessProps, additionalDocumentCaptureProps, signatureCaptureProps, videoSignatureCaptureProps, videoIdCaptureProps, captureSignature, captureSignatureVideo, onCameraAccessDenied, onMicrophoneAccessDenied, debugMode, }: CompositeWizardComponentProps) => ReactElement;
+export declare function CompositeWizard({ checks: userChecks, idCaptureProps, faceLivenessProps, additionalDocumentCaptureProps, signatureCaptureProps, videoSignatureCaptureProps, videoIdCaptureProps, captureSignature, captureSignatureVideo, onCameraAccessDenied, onMicrophoneAccessDenied, debugMode, }: CompositeWizardProps): ReactElement;

package/dist/{contexts/GuideOrientationContext.d.ts → components/GuideOrientationContextProvider.d.ts}

@@ -1,4 +1,4 @@
-import { RefCallback, SyntheticEvent } from 'react';
+import React, { ReactElement, ReactNode, RefCallback, SyntheticEvent } from 'react';
 export type GuideOrientationState = {
     orientation: 'portrait' | 'landscape';
     wrapperWidth: number;
@@ -12,4 +12,8 @@ export type GuideOrientationState = {
     }) => void;
     onImageLoaded: (e: SyntheticEvent) => void;
 };
-export declare const GuideOrientationContext: import("react").Context<GuideOrientationState>;
+export declare const GuideOrientationContext: React.Context<GuideOrientationState>;
+export default function GuideOrientationContextProvider({ children, }: {
+    children: ReactNode;
+}): ReactElement;
+export declare function useGuideOrientationContext(): GuideOrientationState;

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

@@ -14,6 +14,7 @@ import { IdCaptureGuideType } from '../id_capture/IdCaptureGuides';
 import { SelfieCaptureLoadingOverlayMode } from '../selfie_capture/SelfieCaptureLoadingOverlay';
 import { IdCaptureLoadingOverlayMode } from '../id_capture/IdCaptureLoadingOverlay';
 import { IdCaptureThresholds } from '../id_capture/IdCaptureModelsProvider';
+import { IdCaptureGuideImages } from '../guide_images';
 export type CustomerEnrollmentAssets = {
     idCapture?: IdCaptureWizardAssets;
     faceLiveness?: FaceLivenessAssets;
@@ -108,6 +109,8 @@ export interface CustomerEnrollmentProps extends PropsWithChildren {
     idCaptureInstructions?: ReactNode;
     /** String to indicate what type of guides to use during capture. Using `fit` is highly recommended in order to capture the best quality image. Valid values: `fit`, `overlay`. Defaults to `fit`. */
     idCaptureGuideType?: IdCaptureGuideType;
+    /** Object containing any overrides for the guide overlay images during ID capture. Images must be supplied for in both portrait and landscape orientations for both sides of the ID card. Each image must include a url, width, and height -- this is due to some interesting behavior in Safari where the image measurements cannot be trusted. */
+    idCaptureGuideImages?: IdCaptureGuideImages;
     /** Boolean to indicate whether guide images should be rotated on mobile. Defaults to `true`. */
     idCapturePortraitGuidesOnMobile?: boolean;
     /** Boolean to indicate whether loading overlay image should be rotated on when mobile guides are rotated. Defaults to `true`. */

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

@@ -15,6 +15,7 @@ import { IdCaptureGuideType } from '../id_capture/IdCaptureGuides';
 import { SelfieCaptureLoadingOverlayMode } from '../selfie_capture/SelfieCaptureLoadingOverlay';
 import { IdCaptureLoadingOverlayMode } from '../id_capture/IdCaptureLoadingOverlay';
 import { IdCaptureThresholds } from '../id_capture/IdCaptureModelsProvider';
+import { IdCaptureGuideImages } from '../guide_images';
 export type IdAndFaceValidationAssets = {
     idCapture?: IdCaptureWizardAssets;
     faceLiveness?: FaceLivenessAssets;
@@ -105,6 +106,8 @@ export interface IdAndFaceValidationProps extends PropsWithChildren {
     idCaptureInstructions?: ReactNode;
     /** String to indicate what type of guides to use during capture. Using `fit` is highly recommended in order to capture the best quality image. Valid values: `fit`, `overlay`. Defaults to `fit`. */
     idCaptureGuideType?: IdCaptureGuideType;
+    /** Object containing any overrides for the guide overlay images during ID capture. Images must be supplied for in both portrait and landscape orientations for both sides of the ID card. Each image must include a url, width, and height -- this is due to some interesting behavior in Safari where the image measurements cannot be trusted. */
+    idCaptureGuideImages?: IdCaptureGuideImages;
     /** Boolean to indicate whether guide images should be rotated on mobile. Defaults to `true`. */
     idCapturePortraitGuidesOnMobile?: boolean;
     /** Boolean to indicate whether loading overlay image should be rotated on when mobile guides are rotated. Defaults to `true`. */

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

@@ -13,6 +13,7 @@ import { CapturedDocuments } from '../id_capture/CapturedDocuments';
 import { IdCaptureGuideType } from '../id_capture/IdCaptureGuides';
 import { IdCaptureLoadingOverlayMode } from '../id_capture/IdCaptureLoadingOverlay';
 import { IdCaptureThresholds } from '../id_capture/IdCaptureModelsProvider';
+import { IdCaptureGuideImages } from '../guide_images';
 export type IdValidationAssets = IdCaptureWizardAssets;
 export type IdValidationClassNames = IdCaptureWizardClassNames & {
     additionalDocumentCapture?: AdditionalDocumentCaptureWizardClassNames;
@@ -92,6 +93,8 @@ export interface IdValidationProps extends PropsWithChildren {
     instructions?: ReactNode;
     /** String to indicate what type of guides to use during capture. Using `fit` is highly recommended in order to capture the best quality image. Valid values: `fit`, `overlay`. Defaults to `fit`. */
     guideType?: IdCaptureGuideType;
+    /** Object containing any overrides for the guide overlay images during ID capture. Images must be supplied for in both portrait and landscape orientations for both sides of the ID card. Each image must include a url, width, and height -- this is due to some interesting behavior in Safari where the image measurements cannot be trusted. */
+    guideImages?: IdCaptureGuideImages;
     /** Boolean to indicate whether guide images should be rotated on mobile. Defaults to `true`. */
     portraitGuidesOnMobile?: boolean;
     /** Boolean to indicate whether loading overlay image should be rotated on when mobile guides are rotated. Defaults to `true`. */

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

@@ -14,6 +14,7 @@ import { IdCaptureGuideType } from '../id_capture/IdCaptureGuides';
 import { SelfieCaptureLoadingOverlayMode } from '../selfie_capture/SelfieCaptureLoadingOverlay';
 import { IdCaptureLoadingOverlayMode } from '../id_capture/IdCaptureLoadingOverlay';
 import { VideoIdCaptureThresholds } from '../video_id/IdVideoCapture';
+import { IdCaptureGuideImages } from '../guide_images';
 export type VideoIdValidationAssets = VideoIdWizardAssets;
 export type VideoIdValidationClassNames = VideoIdWizardClassNames & {
     additionalDocumentCapture?: AdditionalDocumentCaptureWizardClassNames;
@@ -135,6 +136,8 @@ export interface VideoIdValidationProps extends PropsWithChildren {
     idCaptureLoadingOverlayMode?: IdCaptureLoadingOverlayMode;
     /** String to indicate what type of guides to use during capture. Using `fit` is highly recommended in order to capture the best quality image. Valid values: `fit`, `overlay`. Defaults to `fit`. */
     idCaptureGuideType?: IdCaptureGuideType;
+    /** Object containing any overrides for the guide overlay images during ID capture. Images must be supplied for in both portrait and landscape orientations for both sides of the ID card. Each image must include a url, width, and height -- this is due to some interesting behavior in Safari where the image measurements cannot be trusted. */
+    idCaptureGuideImages?: IdCaptureGuideImages;
     /** Boolean to indicate whether guide images should be rotated on mobile. Defaults to `true`. */
     idCapturePortraitGuidesOnMobile?: boolean;
     /** Boolean to indicate whether loading overlay image should be rotated on when mobile guides are rotated. Defaults to `true`. */

package/dist/components/guide_images/backToFront.d.ts

@@ -0,0 +1,2 @@
+import { IdCaptureGuideImages } from './types';
+export declare function useImagesWithBackToFront(userSuppliedImages: IdCaptureGuideImages, isBackToFront: boolean): IdCaptureGuideImages;

package/dist/components/guide_images/byUrl.d.ts

@@ -0,0 +1,4 @@
+import { IdCaptureGuideImages } from './types';
+export declare function useGuideImagesByUrl(images: IdCaptureGuideImages): {
+    [k: string]: import("./types").IdCaptureGuideImage;
+};

package/dist/components/guide_images/defaults.d.ts

@@ -0,0 +1,36 @@
+export declare const defaultIdCaptureGuideImages: {
+    portrait: {
+        SHOW_ID_FRONT: {
+            url: string;
+            width: number;
+            height: number;
+        };
+        SHOW_ID_BACK: {
+            url: string;
+            width: number;
+            height: number;
+        };
+        SHOW_PASSPORT: {
+            url: string;
+            width: number;
+            height: number;
+        };
+    };
+    landscape: {
+        SHOW_ID_FRONT: {
+            url: string;
+            width: number;
+            height: number;
+        };
+        SHOW_ID_BACK: {
+            url: string;
+            width: number;
+            height: number;
+        };
+        SHOW_PASSPORT: {
+            url: string;
+            width: number;
+            height: number;
+        };
+    };
+};

package/dist/components/guide_images/index.d.ts

@@ -0,0 +1,6 @@
+export * from './types';
+export * from './defaults';
+export * from './merge';
+export * from './byUrl';
+export * from './backToFront';
+export * from './orientation';

package/dist/components/guide_images/merge.d.ts

@@ -0,0 +1,2 @@
+export declare function isObject(item: unknown): boolean;
+export default function mergeDeep<T extends object = object>(target: T, source: T): T;

package/dist/components/guide_images/orientation.d.ts

@@ -0,0 +1 @@
+export declare function getOrientation(allowPortraitOnMobile: boolean): 'portrait' | 'landscape';

package/dist/components/guide_images/types.d.ts

@@ -0,0 +1,14 @@
+export type IdCaptureGuideImages = {
+    portrait: IdCaptureGuidesForOrientation;
+    landscape: IdCaptureGuidesForOrientation;
+};
+export type IdCaptureGuidesForOrientation = {
+    SHOW_ID_FRONT: IdCaptureGuideImage;
+    SHOW_ID_BACK: IdCaptureGuideImage;
+    SHOW_PASSPORT: IdCaptureGuideImage;
+};
+export type IdCaptureGuideImage = {
+    url: string;
+    width: number;
+    height: number;
+};

package/dist/components/guide_images/useGuideImages.d.ts

@@ -0,0 +1,2 @@
+import { IdCaptureGuideImages } from './types';
+export declare function useGuideImages(userSuppliedImages: IdCaptureGuideImages): IdCaptureGuideImages;

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

@@ -1,11 +1,6 @@
 import { ReactElement } from 'react';
 import { CustomerSuppliedVerbiage } from '../../lib/locales';
-export type FlipIdPromptAssets = {
-    idCardFrontPortraitImageUrl?: string;
-    idCardFrontLandscapeImageUrl?: string;
-    idCardBackPortraitImageUrl?: string;
-    idCardBackLandscapeImageUrl?: string;
-};
+import { IdCaptureGuideImages } from '../guide_images';
 export type FlipIdPromptClassNames = {
     frontImageContainer?: string;
     backImageContainer?: string;
@@ -16,6 +11,7 @@ export type FlipIdPromptVerbiage = {
     instructionText?: CustomerSuppliedVerbiage;
 };
 export type FlipIdPromptProps = {
+    images?: IdCaptureGuideImages;
     width?: number;
     height?: number;
     padding?: number;
@@ -25,8 +21,7 @@ export type FlipIdPromptProps = {
     borderRadius?: number;
     isMirrored?: boolean;
     portraitGuidesOnMobile?: boolean;
-    assets?: FlipIdPromptAssets;
     classNames?: FlipIdPromptClassNames;
     verbiage?: FlipIdPromptVerbiage;
 };
-export declare const FlipIdPrompt: ({ width, height, borderWidth, borderColor, borderRadius, isMirrored, portraitGuidesOnMobile, assets, classNames, }: FlipIdPromptProps) => ReactElement;
+export declare const FlipIdPrompt: ({ images, width, height, borderWidth, borderColor, borderRadius, isMirrored, portraitGuidesOnMobile, classNames, }: FlipIdPromptProps) => ReactElement;

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

@@ -6,10 +6,6 @@ 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;
-};
 export type IdCaptureClassNames = {
     container?: string;
     guides?: IdCaptureFitGuideClassNames;
@@ -50,10 +46,9 @@ export type IdCaptureProps = {
     guidanceSatisfied?: boolean;
     onPrediction?: (prediction: IdCapturePrediction) => void;
     onCapture?: (frame: string, width: number, height: number, documentType: CapturedDocumentType, metadata: CaptureAttemptMetadata) => void;
-    assets?: IdCaptureAssets;
     classNames?: IdCaptureClassNames;
     colors?: IdCaptureColors;
     verbiage?: IdCaptureVerbiage;
     debugMode?: boolean;
 };
-export declare const IdCapture: ({ requiredDocumentType, thresholds, guidanceMessage, guidanceSatisfied, onCapture, assets, classNames, colors, verbiage: rawVerbiage, debugMode, }: IdCaptureProps) => React.ReactElement;
+export declare const IdCapture: ({ requiredDocumentType, thresholds, guidanceMessage, guidanceSatisfied, onCapture, classNames, colors, verbiage: rawVerbiage, debugMode, }: IdCaptureProps) => React.ReactElement;

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

@@ -1,7 +1,7 @@
 import React from 'react';
-import { IdCaptureGuideAction, IdCaptureGuideOverlayAssets, IdCaptureGuideOverlayClassNames } from './IdCaptureGuideOverlay';
+import { IdCaptureGuideAction, IdCaptureGuideOverlayClassNames } from './IdCaptureGuideOverlay';
 import { IdCardGuideStatus } from '../video_id/IdVideoCaptureGuidesCommon';
-export type IdCaptureFitGuideAssets = IdCaptureGuideOverlayAssets;
+import { IdCaptureGuideImages } from '../guide_images';
 export type IdCaptureFitGuideClassNames = IdCaptureGuideOverlayClassNames & {
     canvasWrapper?: string;
     canvas?: string;
@@ -21,7 +21,7 @@ export type IdCaptureFitGuideProps = {
     requestedAction?: IdCaptureGuideAction;
     status?: IdCardGuideStatus;
     progress?: number;
-    assets?: IdCaptureFitGuideAssets;
+    images?: IdCaptureGuideImages;
     classNames?: IdCaptureFitGuideClassNames;
 };
-export declare const IdCaptureFitGuide: ({ aspectRatio, maskColor, borderRadius, borderColor, borderWidth, padding, imageVisible, isMirrored, isBackToFront, portraitGuidesOnMobile, instruction, requestedAction, status, progress, assets, classNames, }: IdCaptureFitGuideProps) => React.JSX.Element;
+export declare const IdCaptureFitGuide: ({ aspectRatio, maskColor, borderRadius, borderColor, borderWidth, padding, imageVisible, isMirrored, isBackToFront, portraitGuidesOnMobile, instruction, requestedAction, status, progress, images, classNames, }: IdCaptureFitGuideProps) => React.JSX.Element;

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

@@ -1,15 +1,7 @@
 import React, { ReactElement } from 'react';
 import { IdCardGuideStatus } from '../video_id/IdVideoCaptureGuidesCommon';
-import { FlipIdPromptAssets, FlipIdPromptClassNames } from './FlipIdPrompt';
-export type IdCaptureGuideOverlayAssets = {
-    idCardFrontPortraitImageUrl?: string;
-    idCardFrontLandscapeImageUrl?: string;
-    idCardBackPortraitImageUrl?: string;
-    idCardBackLandscapeImageUrl?: string;
-    passportPortraitImageUrl?: string;
-    passportLandscapeImageUrl?: string;
-    flipIdPrompt?: FlipIdPromptAssets;
-};
+import { FlipIdPromptClassNames } from './FlipIdPrompt';
+import { IdCaptureGuideImages } from '../guide_images';
 export type IdCaptureGuideOverlayClassNames = {
     container?: string;
     inner?: string;
@@ -27,10 +19,8 @@ export type IdCaptureGuideOverlayClassNames = {
     flipIdPrompt?: FlipIdPromptClassNames;
 };
 export type IdCaptureGuideOverlayProps = {
-    assets?: IdCaptureGuideOverlayAssets;
     classNames?: IdCaptureGuideOverlayClassNames;
-    width?: number;
-    height?: number;
+    images?: IdCaptureGuideImages;
     padding?: number;
     imagePadding?: number;
     imageVisible?: boolean;
@@ -49,7 +39,7 @@ export type IdCaptureGuideOverlayProps = {
     onClick?: () => void;
 };
 export type IdCaptureGuideAction = 'SHOW_ID_FRONT' | 'FLIP_ID' | 'SHOW_ID_BACK' | 'SHOW_PASSPORT';
-export declare const IdCaptureGuideOverlay: ({ assets, classNames, width, height, padding: userSuppliedPadding, imagePadding: userSuppliedImagePadding, imageVisible, borderWidth, borderColor, idCardBorderWidth, idCardBorderColor, maskColor, isMirrored, isBackToFront, portraitGuidesOnMobile, instruction, requestedAction, progress, status, onClick, }: IdCaptureGuideOverlayProps) => ReactElement;
+export declare const IdCaptureGuideOverlay: ({ classNames, images: userSuppliedImages, padding: userSuppliedPadding, imagePadding: userSuppliedImagePadding, imageVisible, borderWidth, borderColor, idCardBorderWidth, idCardBorderColor, maskColor, isMirrored, isBackToFront, portraitGuidesOnMobile, instruction, requestedAction, progress, status, onClick, }: IdCaptureGuideOverlayProps) => ReactElement;
 export declare const GuidesContainer: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, never>> & string;
 export declare const GuideCenterRow: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, never>> & string;
 export declare const GuideRegion: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components/dist/types").Substitute<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {

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

@@ -1,10 +1,9 @@
-import { IdCaptureFitGuideAssets, IdCaptureFitGuideClassNames } from './IdCaptureFitGuide';
+import { IdCaptureFitGuideClassNames } from './IdCaptureFitGuide';
 import React from 'react';
 import { IdCaptureGuideAction } from './IdCaptureGuideOverlay';
 import { IdCaptureColors, IdCaptureVerbiage } from './IdCapture';
-import { FlipIdPromptAssets } from './FlipIdPrompt';
 import { IdCardGuideStatus } from '../video_id/IdVideoCaptureGuidesCommon';
-export type IdCaptureGuidesAssets = IdCaptureFitGuideAssets;
+import { IdCaptureGuideImages } from '../guide_images';
 export type IdCaptureGuidesClassNames = IdCaptureFitGuideClassNames;
 export type IdCaptureGuideType = 'fit' | 'overlay';
 export type IdCaptureGuidesProps = {
@@ -14,10 +13,9 @@ export type IdCaptureGuidesProps = {
     portraitGuidesOnMobile?: boolean;
     requestedAction?: IdCaptureGuideAction;
     isBackToFront?: boolean;
-    flipIdPromptAssets?: FlipIdPromptAssets;
-    assets?: IdCaptureGuidesAssets;
+    images?: IdCaptureGuideImages;
     classNames?: IdCaptureGuidesClassNames;
     colors?: IdCaptureColors;
     verbiage?: IdCaptureVerbiage;
 };
-export declare function IdCaptureGuides({ guideType, status, progress, portraitGuidesOnMobile, requestedAction, isBackToFront, assets, classNames, colors, verbiage: rawVerbiage, }: IdCaptureGuidesProps): React.JSX.Element;
+export declare function IdCaptureGuides({ guideType, status, progress, portraitGuidesOnMobile, requestedAction, isBackToFront, images, classNames, colors, verbiage: rawVerbiage, }: IdCaptureGuidesProps): React.JSX.Element;

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

@@ -1,21 +1,18 @@
 import { ReactElement, ReactNode } from 'react';
-import { IdCaptureAssets, IdCaptureClassNames, IdCaptureColors, IdCaptureVerbiage } from './IdCapture';
+import { IdCaptureClassNames, IdCaptureColors, IdCaptureVerbiage } from './IdCapture';
 import { IdCaptureLoadingOverlayAssets, IdCaptureLoadingOverlayClassNames, IdCaptureLoadingOverlayColors, IdCaptureLoadingOverlayMode, IdCaptureLoadingOverlayVerbiage } from './IdCaptureLoadingOverlay';
 import { FlipIdPromptVerbiage } from './FlipIdPrompt';
 import { CapturedDocuments } from './CapturedDocuments';
 import { IdCaptureSuccessClassNames, IdCaptureSuccessColors, IdCaptureSuccessVerbiage } from './IdCaptureSuccess';
 import { IdCaptureThresholds } from './IdCaptureModelsProvider';
 import { IdCaptureRequirementOption } from './IdCaptureRequirementOption';
-import { IdCaptureGuidesAssets, IdCaptureGuidesClassNames, IdCaptureGuideType } from './IdCaptureGuides';
+import { IdCaptureGuidesClassNames, IdCaptureGuideType } from './IdCaptureGuides';
 import { IdCaptureFallbackClassNames, IdCaptureFallbackColors, IdCaptureFallbackVerbiage } from '../fallback_flows/IdCapture';
+import { IdCaptureGuideImages } from '../guide_images';
 export type IdCaptureWizardAssets = {
     documentDetectionModelUrl?: string;
     focusModelUrl?: string;
     loadingOverlay?: IdCaptureLoadingOverlayAssets;
-    guides?: IdCaptureGuidesAssets;
-    idCardFront?: IdCaptureAssets;
-    idCardBack?: IdCaptureAssets;
-    passport?: IdCaptureAssets;
 };
 export type IdCaptureWizardClassNames = {
     container?: string;
@@ -69,10 +66,11 @@ export type IdCaptureWizardProps = {
     allowIdCardBackToFrontCapture?: boolean;
     enableOverrideWrongDocumentTypeDialog?: boolean;
     allowOverrideWrongDocumentTypeAfterMs?: number;
+    guideImages?: IdCaptureGuideImages;
     assets?: IdCaptureWizardAssets;
     classNames?: IdCaptureWizardClassNames;
     colors?: IdCaptureWizardColors;
     verbiage?: IdCaptureWizardVerbiage;
     debugMode?: boolean;
 };
-export declare const IdCaptureWizard: ({ onSuccess, onExitCapture, onUserCancel, loadingOverlayMode, customOverlayContent, onCustomOverlyDismissed, precapturedDocuments, captureRequirement, separateIdCardCaptureSequence, thresholds, skipSuccessScreen, instructions, releaseCameraAccessOnExit, guideType, portraitGuidesOnMobile, rotateLoadingOverlayImageWhenPortrait, silentFallback, forceFallbackMode, allowIdCardBackToFrontCapture, enableOverrideWrongDocumentTypeDialog, allowOverrideWrongDocumentTypeAfterMs, assets, classNames, colors, verbiage, debugMode, }: IdCaptureWizardProps) => ReactElement;
+export declare const IdCaptureWizard: ({ onSuccess, onExitCapture, onUserCancel, loadingOverlayMode, customOverlayContent, onCustomOverlyDismissed, precapturedDocuments, captureRequirement, separateIdCardCaptureSequence, thresholds, skipSuccessScreen, instructions, releaseCameraAccessOnExit, guideType, portraitGuidesOnMobile, rotateLoadingOverlayImageWhenPortrait, silentFallback, forceFallbackMode, allowIdCardBackToFrontCapture, enableOverrideWrongDocumentTypeDialog, allowOverrideWrongDocumentTypeAfterMs, guideImages, assets, classNames, colors, verbiage, debugMode, }: IdCaptureWizardProps) => ReactElement;

package/dist/components/video_id/IdVideoCapture.d.ts

@@ -1,13 +1,11 @@
 import { ReactElement } from 'react';
 import { IdCaptureThresholds } from '../id_capture/IdCaptureModelsProvider';
-import { IdVideoCaptureGuidesAssets, IdVideoCaptureGuidesClassNames, IdVideoCaptureGuidesVerbiage } from './IdVideoCaptureGuides';
+import { IdVideoCaptureGuidesClassNames, IdVideoCaptureGuidesVerbiage } from './IdVideoCaptureGuides';
 import { CustomerSuppliedVerbiage } from '../../lib/locales';
 import { LoaderButtonColors } from '../common/LoaderButton';
 import { ReadTextPromptClassNames, ReadTextPromptVerbiage } from '../read_text_prompt/ReadTextPrompt';
+import { IdCaptureGuideImages } from '../guide_images';
 export type Action = 'SHOW_ID_FRONT' | 'FLIP_ID' | 'SHOW_ID_BACK' | 'READ_TEXT';
-export type IdVideoCaptureAssets = {
-    guides?: IdVideoCaptureGuidesAssets;
-};
 export type IdVideoCaptureClassNames = {
     container?: string;
     cameraFeed?: string;
@@ -50,6 +48,7 @@ export type IdVideoCaptureProps = {
     onRecordingFailed?: () => void;
     onExitCapture?: () => void;
     idCaptureModelsEnabled?: boolean;
+    idCardCaptureGuideImages?: IdCaptureGuideImages;
     videoIdCaptureThresholds?: VideoIdCaptureThresholds;
     idCardFrontDelay?: number;
     skipShowIdCardBack?: boolean | (() => Promise<boolean>);
@@ -60,10 +59,9 @@ export type IdVideoCaptureProps = {
     disableFaceDetectionWhileAudioCapture: boolean;
     disableFaceDetectionWhileAudioCaptureMsDelay: number;
     mergeAVStreams?: boolean;
-    assets?: IdVideoCaptureAssets;
     classNames?: IdVideoCaptureClassNames;
     colors?: IdVideoCaptureColors;
     verbiage?: IdVideoCaptureVerbiage;
     debugMode?: boolean;
 };
-export declare const IdVideoCapture: ({ onComplete, onIdFrontImageCaptured, onIdBackImageCaptured, onFaceNotDetected, onRecordingFailed, onExitCapture, idCaptureModelsEnabled, idCardFrontDelay, videoIdCaptureThresholds, skipShowIdCardBack, captureCountdownSeconds, readTextPrompt, readTextTimeoutDurationMs, readTextMinReadingMs, disableFaceDetectionWhileAudioCapture, disableFaceDetectionWhileAudioCaptureMsDelay, mergeAVStreams, assets, classNames, colors, verbiage: rawVerbiage, debugMode, }: IdVideoCaptureProps) => ReactElement;
+export declare const IdVideoCapture: ({ onComplete, onIdFrontImageCaptured, onIdBackImageCaptured, onFaceNotDetected, onRecordingFailed, onExitCapture, idCaptureModelsEnabled, idCardCaptureGuideImages, idCardFrontDelay, videoIdCaptureThresholds, skipShowIdCardBack, captureCountdownSeconds, readTextPrompt, readTextTimeoutDurationMs, readTextMinReadingMs, disableFaceDetectionWhileAudioCapture, disableFaceDetectionWhileAudioCaptureMsDelay, mergeAVStreams, classNames, colors, verbiage: rawVerbiage, debugMode, }: IdVideoCaptureProps) => ReactElement;

package/dist/components/video_id/IdVideoCaptureFlipIdPrompt.d.ts

@@ -1,8 +1,5 @@
 import React, { CSSProperties, ReactElement } from 'react';
-export type IdVideoCaptureFlipIdPromptAssets = {
-    frontImageUrl?: string;
-    backImageUrl?: string;
-};
+import { IdCaptureGuideImages } from '../guide_images';
 export type IdVideoCaptureFlipIdPromptClassNames = {
     frontImageContainer?: string;
     backImageContainer?: string;
@@ -10,14 +7,14 @@ export type IdVideoCaptureFlipIdPromptClassNames = {
     backImage?: string;
 };
 export type IdVideoCaptureFlipIdPromptProps = {
+    idCaptureGuideImages?: IdCaptureGuideImages;
     classNames?: IdVideoCaptureFlipIdPromptClassNames;
-    assets?: IdVideoCaptureFlipIdPromptAssets;
     borderWidth?: number;
     borderColor?: string;
     borderRadius?: number;
     imageStyle?: CSSProperties;
 };
-export declare const IdVideoCaptureFlipIdPrompt: ({ assets, classNames, borderWidth, borderColor, borderRadius, imageStyle, }: IdVideoCaptureFlipIdPromptProps) => ReactElement;
+export declare const IdVideoCaptureFlipIdPrompt: ({ idCaptureGuideImages, classNames, borderWidth, borderColor, borderRadius, imageStyle, }: IdVideoCaptureFlipIdPromptProps) => ReactElement;
 export declare const FlipImageContainer: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components/dist/types").Substitute<import("styled-components").FastOmit<React.HTMLAttributes<HTMLDivElement> & {
     status?: import("./IdVideoCaptureGuidesCommon").IdCardGuideStatus;
     borderWidth?: number | string;

package/dist/components/video_id/IdVideoCaptureGuides.d.ts

@@ -3,11 +3,8 @@ import { IdVideoCaptureFlipIdPromptClassNames } from './IdVideoCaptureFlipIdProm
 import { CustomerSuppliedVerbiage } from '../../lib/locales';
 import { IdCardGuideStatus } from './IdVideoCaptureGuidesCommon';
 import { FaceGuideStatus } from '../face_liveness/FaceCaptureGuideOverlay';
+import { IdCaptureGuideImages } from '../guide_images';
 export type Action = 'SHOW_ID_FRONT' | 'FLIP_ID' | 'SHOW_ID_BACK' | 'VERIFY_LIVENESS';
-export type IdVideoCaptureGuidesAssets = {
-    frontImageUrl?: string;
-    backImageUrl?: string;
-};
 export type IdVideoCaptureGuidesClassNames = {
     container?: string;
     faceGuideContainer?: string;
@@ -36,11 +33,11 @@ export type IdVideoCaptureGuidesProps = {
     idCardGuideBorderWidth?: number;
     idCardGuideBorderColor?: string;
     idCardCaptureProgress?: number;
-    assets?: IdVideoCaptureGuidesAssets;
+    idCardCaptureGuideImages?: IdCaptureGuideImages;
     classNames?: IdVideoCaptureGuidesClassNames;
     verbiage?: IdVideoCaptureGuidesVerbiage;
 };
-export declare const IdVideoCaptureGuides: ({ requestedAction, satisfied, faceGuideStatus, faceGuideBorderWidth, faceGuideBorderColor, idCardGuideStatus, idCardGuideBorderWidth, idCardGuideBorderColor, idCardCaptureProgress, assets, classNames, verbiage: rawVerbiage, }: IdVideoCaptureGuidesProps) => ReactElement;
+export declare const IdVideoCaptureGuides: ({ requestedAction, satisfied, faceGuideStatus, faceGuideBorderWidth, faceGuideBorderColor, idCardGuideStatus, idCardGuideBorderWidth, idCardGuideBorderColor, idCardCaptureProgress, idCardCaptureGuideImages: userSuppliedImages, classNames, verbiage: rawVerbiage, }: IdVideoCaptureGuidesProps) => ReactElement;
 export declare const IdCardGuideInstructionsContainer: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, never>> & string;
 export declare const IdCardGuideInstructions: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<Omit<import("styled-components").FastOmit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "$textColor" | "$variant" | "$background"> & {
     $background?: string;

package/dist/components/video_id/IdVideoCaptureWizard.d.ts

@@ -1,17 +1,17 @@
 import { ReactElement, ReactNode } from 'react';
 import { IdCaptureWizardAssets, IdCaptureWizardClassNames, IdCaptureWizardColors, IdCaptureWizardProps, IdCaptureWizardVerbiage } from '../id_capture/IdCaptureWizard';
 import { FaceLivenessAssets, FaceLivenessClassNames, FaceLivenessColors, FaceLivenessVerbiage, FaceLivenessWizardProps } from '../face_liveness/FaceLivenessWizard';
-import { IdVideoCaptureAssets, IdVideoCaptureClassNames, IdVideoCaptureColors, IdVideoCaptureVerbiage, VideoIdCaptureThresholds } from './IdVideoCapture';
+import { IdVideoCaptureClassNames, IdVideoCaptureColors, IdVideoCaptureVerbiage, VideoIdCaptureThresholds } from './IdVideoCapture';
 import { IdVideoCaptureSuccessClassNames, IdVideoCaptureSuccessColors, IdVideoCaptureSuccessVerbiage } from './IdVideoCaptureSuccess';
 import { CustomerSuppliedVerbiage } from '../../lib/locales';
 import { LivenessCheckRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
 import { IdCaptureGuideType } from '../id_capture/IdCaptureGuides';
 import { IdCaptureLoadingOverlayMode } from '../id_capture/IdCaptureLoadingOverlay';
 import { SelfieCaptureLoadingOverlayMode } from '../selfie_capture/SelfieCaptureLoadingOverlay';
+import { IdCaptureGuideImages } from '../guide_images';
 export type VideoIdWizardAssets = {
     idCapture?: IdCaptureWizardAssets;
     faceLiveness?: FaceLivenessAssets;
-    idVideoCapture?: IdVideoCaptureAssets;
 };
 export type VideoIdWizardClassNames = {
     container?: string;
@@ -55,6 +55,7 @@ export type VideoIdWizardProps = {
     idCaptureLoadingOverlayMode?: IdCaptureLoadingOverlayMode;
     customOverlayContent?: () => ReactNode;
     idCaptureGuideType?: IdCaptureGuideType;
+    idCaptureGuideImages?: IdCaptureGuideImages;
     idCapturePortraitGuidesOnMobile?: boolean;
     idCaptureRotateLoadingOverlayImageWhenPortrait?: boolean;
     idCaptureModelLoadTimeoutMs?: number;
@@ -69,4 +70,4 @@ export type VideoIdWizardProps = {
     verbiage?: VideoIdWizardVerbiage;
     debugMode?: boolean;
 };
-export declare const VideoIdWizard: ({ onComplete, onExitCapture, onExitAfterFailure, onUserCancel, onIdCaptureModelError, onCameraAccessDenied, onMicrophoneAccessDenied, idCaptureProps, faceLivenessProps, idCaptureModelsEnabled, videoIdCaptureThresholds, readTextPrompt, readTextTimeoutDurationMs, readTextMinReadingMs, skipIdCapture, skipShowIdCardBack, skipSuccessScreen, idCaptureLoadingOverlayMode, customOverlayContent, onCustomOverlyDismissed, idCaptureGuideType, idCapturePortraitGuidesOnMobile, idCaptureRotateLoadingOverlayImageWhenPortrait, idCaptureModelLoadTimeoutMs, faceLivenessLoadingOverlayMode, disableFaceDetectionWhileAudioCapture, disableFaceDetectionWhileAudioCaptureMsDelay, silentFallback, mergeAVStreams, assets, classNames, colors, verbiage, debugMode, }: VideoIdWizardProps) => ReactElement;
+export declare const VideoIdWizard: ({ onComplete, onExitCapture, onExitAfterFailure, onUserCancel, onIdCaptureModelError, onCameraAccessDenied, onMicrophoneAccessDenied, idCaptureProps, faceLivenessProps, idCaptureModelsEnabled, videoIdCaptureThresholds, readTextPrompt, readTextTimeoutDurationMs, readTextMinReadingMs, skipIdCapture, skipShowIdCardBack, skipSuccessScreen, idCaptureLoadingOverlayMode, customOverlayContent, onCustomOverlyDismissed, idCaptureGuideType, idCaptureGuideImages, idCapturePortraitGuidesOnMobile, idCaptureRotateLoadingOverlayImageWhenPortrait, idCaptureModelLoadTimeoutMs, faceLivenessLoadingOverlayMode, disableFaceDetectionWhileAudioCapture, disableFaceDetectionWhileAudioCaptureMsDelay, silentFallback, mergeAVStreams, assets, classNames, colors, verbiage, debugMode, }: VideoIdWizardProps) => ReactElement;