idmission-web-sdk 2.1.35 → 2.1.37

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

@@ -1,5 +1,5 @@
 import React, { CSSProperties, ReactNode } from 'react';
-export type LoaderButtonVariant = 'primary' | 'secondary' | 'positive' | 'negative' | 'warning';
+export type LoaderButtonVariant = 'primary' | 'secondary' | 'positive' | 'negative' | 'warning' | 'outline';
 export type LoaderButtonColors = {
     backgroundColor?: string;
     textColor?: string;

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

@@ -1,13 +1,17 @@
-import { ReactElement } from 'react';
+import React, { ReactElement } from 'react';
 export type FaceCaptureGuideOverlayVariant = 'satisfied' | 'unsatisfied';
+export declare const FaceCaptureGuideContainer: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, never>> & string;
 export type FaceCaptureGuideOverlayClassNames = {
     container?: string;
     oval?: string;
 };
+export type FaceGuideStatus = 'ready' | 'processing' | 'success' | 'failure';
 export type FaceCaptureGuideOverlayProps = {
     classNames?: FaceCaptureGuideOverlayClassNames;
     variant?: FaceCaptureGuideOverlayVariant;
+    status?: FaceGuideStatus;
     borderWidth?: number;
     borderColor?: string;
+    borderOpacity?: number;
 };
-export declare const FaceCaptureGuideOverlay: ({ classNames, variant, borderWidth, borderColor, }: FaceCaptureGuideOverlayProps) => ReactElement;
+export declare const FaceCaptureGuideOverlay: ({ classNames, status, borderWidth, borderColor, borderOpacity, }: FaceCaptureGuideOverlayProps) => ReactElement;

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

@@ -1,7 +1,8 @@
-import { ReactElement } from 'react';
+import { ComponentType, ReactElement } from 'react';
 import { SelfieCaptureClassNames, SelfieCaptureColors, SelfieCaptureVerbiage } from '../selfie_capture/SelfieCapture';
 import { SelfieProgressPreviewClassNames } from '../common/SelfieProgressPreview';
 import { CustomerSuppliedVerbiage } from '../../lib/locales';
+import { FaceCaptureGuideOverlayProps } from './FaceCaptureGuideOverlay';
 export type FaceLivenessCaptureClassNames = SelfieCaptureClassNames & {
     imagePreview?: SelfieProgressPreviewClassNames;
 };
@@ -11,6 +12,8 @@ export type FaceLivenessCaptureVerbiage = SelfieCaptureVerbiage & {
     guidanceRemoveHeadCoveringsText?: CustomerSuppliedVerbiage;
     guidanceRemoveMaskText?: CustomerSuppliedVerbiage;
     progressPreviewText?: CustomerSuppliedVerbiage;
+    guidanceLivenessCheckFailedText?: CustomerSuppliedVerbiage;
+    guidanceLivenessCheckErrorText?: CustomerSuppliedVerbiage;
 };
 export type FaceLivenessCaptureProps = {
     onCapture?: () => void;
@@ -19,9 +22,12 @@ export type FaceLivenessCaptureProps = {
     onExit?: () => void;
     timeoutDurationMs?: number;
     silentFallback?: boolean;
+    guidesComponent?: ComponentType<FaceCaptureGuideOverlayProps>;
+    disableCapturePreview?: boolean;
+    requireVerticalFaceCentering?: boolean;
     classNames?: FaceLivenessCaptureClassNames;
     colors?: FaceLivenessCaptureColors;
     verbiage?: FaceLivenessCaptureVerbiage;
     debugMode?: boolean;
 };
-export declare const FaceLivenessCapture: ({ onCapture, onSuccess, onTimeout, onExit, timeoutDurationMs, silentFallback, classNames, colors, verbiage: rawVerbiage, debugMode, }: FaceLivenessCaptureProps) => ReactElement;
+export declare const FaceLivenessCapture: ({ onCapture, onSuccess, onTimeout, onExit, timeoutDurationMs, silentFallback, guidesComponent, disableCapturePreview, requireVerticalFaceCentering, classNames, colors, verbiage: rawVerbiage, debugMode, }: FaceLivenessCaptureProps) => ReactElement;

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

@@ -1,4 +1,4 @@
-import { ReactElement } from 'react';
+import React, { ReactElement } from 'react';
 import { LoaderButtonColors } from '../common/LoaderButton';
 import { CustomerSuppliedVerbiage } from '../../lib/locales';
 export type FaceLivenessFailureAssets = {
@@ -33,3 +33,4 @@ export type FaceLivenessFailureProps = {
     verbiage?: FaceLivenessFailureVerbiage;
 };
 export declare const FaceLivenessFailure: ({ canRetry, onRetryClick, onExitClick, assets, classNames, colors, verbiage: rawVerbiage, }: FaceLivenessFailureProps) => ReactElement;
+export declare const ButtonsRow: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, never>> & string;

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

@@ -1,9 +1,10 @@
-import { ReactElement } from 'react';
+import { ComponentType, ReactElement } from 'react';
 import { FaceLivenessCaptureClassNames, FaceLivenessCaptureColors, FaceLivenessCaptureVerbiage } from './FaceLivenessCapture';
 import { FaceLivenessSuccessClassNames, FaceLivenessSuccessColors, FaceLivenessSuccessVerbiage } from './FaceLivenessSuccess';
 import { FaceLivenessFailureAssets, FaceLivenessFailureClassNames, FaceLivenessFailureColors, FaceLivenessFailureVerbiage } from './FaceLivenessFailure';
 import { LivenessCheckRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
 import { SelfieCaptureLoadingOverlayMode, SelfieCaptureLoadingOverlayAssets, SelfieCaptureLoadingOverlayClassNames, SelfieCaptureLoadingOverlayColors, SelfieCaptureLoadingOverlayVerbiage } from '../selfie_capture/SelfieCaptureLoadingOverlay';
+import { FaceCaptureGuideOverlayProps } from './FaceCaptureGuideOverlay';
 export type FaceLivenessAssets = {
     loadingOverlay?: SelfieCaptureLoadingOverlayAssets;
     failure?: FaceLivenessFailureAssets;
@@ -40,10 +41,13 @@ export type FaceLivenessWizardProps = {
     renderCameraFeed?: boolean;
     releaseCameraAccessOnExit?: boolean;
     silentFallback?: boolean;
+    guidesComponent?: ComponentType<FaceCaptureGuideOverlayProps>;
+    disableCapturePreview?: boolean;
+    requireVerticalFaceCentering?: boolean;
     assets?: FaceLivenessAssets;
     classNames?: FaceLivenessClassNames;
     colors?: FaceLivenessColors;
     verbiage?: FaceLivenessVerbiage;
     debugMode?: boolean;
 };
-export declare const FaceLivenessWizard: ({ onComplete, onSuccess, onTimeout, onExitCapture, onExitAfterFailure, onUserCancel, loadingOverlayMode, timeoutDurationMs, maxRetries, skipSuccessScreen, renderCameraFeed, releaseCameraAccessOnExit, silentFallback, assets, classNames, colors, verbiage, debugMode, }: FaceLivenessWizardProps) => ReactElement;
+export declare const FaceLivenessWizard: ({ onComplete, onSuccess, onTimeout, onExitCapture, onExitAfterFailure, onUserCancel, loadingOverlayMode, timeoutDurationMs, maxRetries, skipSuccessScreen, renderCameraFeed, releaseCameraAccessOnExit, silentFallback, guidesComponent, disableCapturePreview, requireVerticalFaceCentering, assets, classNames, colors, verbiage, debugMode, }: FaceLivenessWizardProps) => ReactElement;

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

@@ -29,8 +29,8 @@ export type IdCaptureState = {
     backDetectedFirst: boolean;
     enableOverrideWrongDocumentTypeDialog: boolean;
     allowOverrideWrongDocumentTypeAfterMs: number;
-    allowOverrideFlipRequirement: boolean;
-    overrideFlipRequirement: boolean;
+    allowOverrideWrongDocumentTypeGuidance: boolean;
+    overrideWrongDocumentTypeGuidance: boolean;
     wrongDocumentTypePredictions: number;
     idCardFrontDetectionScore: number;
     idCardFrontDetectionThresholdMet: boolean;

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/components/selfie_capture/SelfieCapture.d.ts

@@ -1,5 +1,5 @@
-import { ReactElement } from 'react';
-import { FaceCaptureGuideOverlayClassNames } from '../face_liveness/FaceCaptureGuideOverlay';
+import { ComponentType, ReactElement } from 'react';
+import { FaceCaptureGuideOverlayClassNames, FaceCaptureGuideOverlayProps } from '../face_liveness/FaceCaptureGuideOverlay';
 import { CustomerSuppliedVerbiage } from '../../lib/locales';
 import { SelfieCaptureFallbackClassNames } from '../fallback_flows/SelfieCapture';
 import { Face } from '../../lib/models/FaceDetection';
@@ -26,19 +26,24 @@ export type SelfieCaptureVerbiage = {
     guidanceMoveBackText?: CustomerSuppliedVerbiage;
     guidanceMoveForwardText?: CustomerSuppliedVerbiage;
     guidanceMoveToCenterText?: CustomerSuppliedVerbiage;
+    guidanceNoFaceDetectedText?: CustomerSuppliedVerbiage;
 };
 export type SelfieCaptureProps = {
     onGuidanceSatisfied?: () => void;
     onGuidanceNotSatisfied?: () => void;
+    onSelfieCaptureStarted?: () => void;
     onSelfieCaptured?: (frame: ImageData, face: Face) => void;
     onTimeout?: () => void;
     onExit?: () => void;
     timeoutDurationMs?: number;
     guidanceMessage?: string;
     guidanceSatisfied?: boolean;
+    guidesComponent?: ComponentType<FaceCaptureGuideOverlayProps>;
+    requireVerticalFaceCentering?: boolean;
+    shouldCapture?: boolean;
     classNames?: SelfieCaptureClassNames;
     colors?: SelfieCaptureColors;
     verbiage?: SelfieCaptureVerbiage;
     debugMode?: boolean;
 };
-export declare const SelfieCapture: ({ onGuidanceSatisfied, onGuidanceNotSatisfied, onSelfieCaptured, onTimeout, onExit, timeoutDurationMs, guidanceMessage, guidanceSatisfied, classNames, colors, verbiage: rawVerbiage, debugMode, }: SelfieCaptureProps) => ReactElement;
+export declare const SelfieCapture: ({ onGuidanceSatisfied, onGuidanceNotSatisfied, onSelfieCaptureStarted, onSelfieCaptured, onTimeout, onExit, timeoutDurationMs, guidanceMessage, guidanceSatisfied, guidesComponent, requireVerticalFaceCentering, shouldCapture, classNames, colors, verbiage: rawVerbiage, debugMode, }: SelfieCaptureProps) => ReactElement;

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

@@ -1,6 +1,19 @@
-import React from 'react';
+import React, { SVGProps } from 'react';
+import { FaceGuideStatus } from '../face_liveness/FaceCaptureGuideOverlay';
 export declare function SelfieCaptureLoadingGraphic({ width, height, className, }: {
     width?: number;
     height?: number;
     className?: string;
 }): React.JSX.Element;
+export type SelfieCaptureAnimatedMaskProps = SVGProps<SVGSVGElement> & {
+    frame?: number;
+    borderWidth?: number;
+    borderColor?: string;
+    borderOpacity?: number;
+    verticalAlign?: 'center' | 'top' | 'bottom';
+    status?: FaceGuideStatus;
+};
+export declare function SelfieCaptureAnimatedMask({ frame, borderWidth, borderColor, borderOpacity, verticalAlign, status, ...props }: SelfieCaptureAnimatedMaskProps): React.JSX.Element;
+export declare function SelfieCaptureAnimatedMaskWithStatus({ status, ...props }: SelfieCaptureAnimatedMaskProps & {
+    status?: FaceGuideStatus;
+}): React.JSX.Element;

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

@@ -1,11 +1,11 @@
 import * as React from 'react';
 import { MutableRefObject, ReactElement, ReactNode } from 'react';
 import { Face } from '../../lib/models/FaceDetection';
-type PredictionHandler = (prediction: Face[]) => void;
+export type SelfieGuidancePredictionHandler = (prediction: Face[]) => Promise<void> | void;
 type SelfieGuidanceModelsState = {
     start: () => void;
     stop: () => void;
-    onPredictionMade: (handler: PredictionHandler) => void;
+    onPredictionMade: (handler: SelfieGuidancePredictionHandler) => void;
     canvasRef: MutableRefObject<HTMLCanvasElement | null>;
     ready: boolean;
     error: Error | null;

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

@@ -3,11 +3,16 @@ export type IdVideoCaptureFlipIdPromptAssets = {
     frontImageUrl?: string;
     backImageUrl?: string;
 };
+export type IdVideoCaptureFlipIdPromptClassNames = {
+    frontImageContainer?: string;
+    backImageContainer?: string;
+    frontImage?: string;
+    backImage?: string;
+};
 export type IdVideoCaptureFlipIdPromptProps = {
-    className?: string;
-    imageWidth?: number;
-    imageHeight?: number;
-    borderWidth?: number;
+    classNames?: IdVideoCaptureFlipIdPromptClassNames;
     assets?: IdVideoCaptureFlipIdPromptAssets;
+    borderWidth?: number;
+    borderColor?: string;
 };
-export declare const IdVideoCaptureFlipIdPrompt: ({ className, imageWidth, imageHeight, borderWidth, assets, }: IdVideoCaptureFlipIdPromptProps) => ReactElement;
+export declare const IdVideoCaptureFlipIdPrompt: ({ assets, classNames, borderWidth, borderColor, }: IdVideoCaptureFlipIdPromptProps) => ReactElement;

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

@@ -1,37 +1,45 @@
 import React, { ReactElement } from 'react';
+import { IdVideoCaptureFlipIdPromptClassNames } from './IdVideoCaptureFlipIdPrompt';
 import { CustomerSuppliedVerbiage } from '../../lib/locales';
-export type Action = 'SHOW_ID_FRONT' | 'FLIP_ID' | 'SHOW_ID_BACK' | 'READ_TEXT';
+import { IdCardGuideStatus } from './IdVideoCaptureGuidesCommon';
+import { FaceGuideStatus } from '../face_liveness/FaceCaptureGuideOverlay';
+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;
     faceGuide?: string;
     idCardGuideContainer?: string;
+    idCardGuideInner?: string;
     idCardGuideInstructionsContainer?: string;
     idCardGuideInstructions?: string;
     idCardGuideImageContainer?: string;
     idCardGuideImage?: string;
-    flipIdPromptImage?: string;
+    flipIdPrompt?: IdVideoCaptureFlipIdPromptClassNames;
 };
 export type IdVideoCaptureGuidesVerbiage = {
     idFrontInstructionText?: CustomerSuppliedVerbiage;
     idBackInstructionText?: CustomerSuppliedVerbiage;
     flipIdInstructionText?: CustomerSuppliedVerbiage;
+    verifyLivenessInstructionText?: CustomerSuppliedVerbiage;
 };
 export type IdVideoCaptureGuidesProps = {
     requestedAction?: Action;
     satisfied?: boolean;
+    faceGuideStatus?: FaceGuideStatus;
     faceGuideBorderWidth?: number;
     faceGuideBorderColor?: string;
+    idCardGuideStatus?: IdCardGuideStatus;
     idCardGuideBorderWidth?: number;
     idCardGuideBorderColor?: string;
     assets?: IdVideoCaptureGuidesAssets;
     classNames?: IdVideoCaptureGuidesClassNames;
     verbiage?: IdVideoCaptureGuidesVerbiage;
 };
-export declare const IdVideoCaptureGuides: ({ requestedAction, satisfied, faceGuideBorderWidth, faceGuideBorderColor, idCardGuideBorderWidth, idCardGuideBorderColor, assets, classNames, verbiage: rawVerbiage, }: IdVideoCaptureGuidesProps) => ReactElement;
+export declare const IdVideoCaptureGuides: ({ requestedAction, satisfied, faceGuideStatus, faceGuideBorderWidth, faceGuideBorderColor, idCardGuideStatus, idCardGuideBorderWidth, idCardGuideBorderColor, assets, 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/IdVideoCaptureGuidesCommon.d.ts

@@ -0,0 +1,20 @@
+import React from 'react';
+export declare const IdCardGuideImageContainer: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components/dist/types").Substitute<React.HTMLAttributes<HTMLDivElement> & {
+    status?: IdCardGuideStatus;
+    borderWidth?: number;
+    borderRadius?: number;
+    borderColor?: string;
+}, {
+    $isVisible?: boolean;
+}>> & string & Omit<typeof IdCardBorder, keyof React.Component<any, {}, any>>;
+export declare const IdCardGuideImage: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components/dist/types").Substitute<React.DetailedHTMLProps<React.ImgHTMLAttributes<HTMLImageElement>, HTMLImageElement>, {
+    $isMirrored?: boolean;
+}>> & string;
+export type IdCardGuideStatus = 'disabled' | 'ready' | 'capturing';
+declare function IdCardBorder({ children, status, borderWidth, borderRadius, borderColor, ...props }: React.HTMLAttributes<HTMLDivElement> & {
+    status?: IdCardGuideStatus;
+    borderWidth?: number;
+    borderRadius?: number;
+    borderColor?: string;
+}): React.JSX.Element;
+export {};

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

@@ -54,6 +54,8 @@ declare const _default: {
     Exit: string;
     'Face liveness has been verified!': string;
     Done: string;
+    'Could not verify your face.': string;
+    'An error occurred while verifying your face.': string;
     'Customer has been identified!': string;
     'Customer not found': string;
     'Additional document capture': string;
@@ -99,5 +101,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

@@ -62,6 +62,8 @@ export declare const resources: {
             Exit: string;
             'Face liveness has been verified!': string;
             Done: string;
+            'Could not verify your face.': string;
+            'An error occurred while verifying your face.': string;
             'Customer has been identified!': string;
             'Customer not found': string;
             'Additional document capture': string;
@@ -107,6 +109,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;
         };
     };
 };