idmission-web-sdk 2.1.37 → 2.1.38

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' | 'outline';
+export type LoaderButtonVariant = 'primary' | 'secondary' | 'positive' | 'negative' | 'warning';
 export type LoaderButtonColors = {
     backgroundColor?: string;
     textColor?: string;

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

@@ -1,17 +1,13 @@
-import React, { ReactElement } from 'react';
+import { 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, status, borderWidth, borderColor, borderOpacity, }: FaceCaptureGuideOverlayProps) => ReactElement;
+export declare const FaceCaptureGuideOverlay: ({ classNames, variant, borderWidth, borderColor, }: FaceCaptureGuideOverlayProps) => ReactElement;

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

@@ -1,8 +1,7 @@
-import { ComponentType, ReactElement } from 'react';
+import { 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;
 };
@@ -12,8 +11,6 @@ export type FaceLivenessCaptureVerbiage = SelfieCaptureVerbiage & {
     guidanceRemoveHeadCoveringsText?: CustomerSuppliedVerbiage;
     guidanceRemoveMaskText?: CustomerSuppliedVerbiage;
     progressPreviewText?: CustomerSuppliedVerbiage;
-    guidanceLivenessCheckFailedText?: CustomerSuppliedVerbiage;
-    guidanceLivenessCheckErrorText?: CustomerSuppliedVerbiage;
 };
 export type FaceLivenessCaptureProps = {
     onCapture?: () => void;
@@ -22,12 +19,9 @@ 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, guidesComponent, disableCapturePreview, requireVerticalFaceCentering, classNames, colors, verbiage: rawVerbiage, debugMode, }: FaceLivenessCaptureProps) => ReactElement;
+export declare const FaceLivenessCapture: ({ onCapture, onSuccess, onTimeout, onExit, timeoutDurationMs, silentFallback, classNames, colors, verbiage: rawVerbiage, debugMode, }: FaceLivenessCaptureProps) => ReactElement;

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

@@ -1,4 +1,4 @@
-import React, { ReactElement } from 'react';
+import { ReactElement } from 'react';
 import { LoaderButtonColors } from '../common/LoaderButton';
 import { CustomerSuppliedVerbiage } from '../../lib/locales';
 export type FaceLivenessFailureAssets = {
@@ -33,4 +33,3 @@ 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,10 +1,9 @@
-import { ComponentType, ReactElement } from 'react';
+import { 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;
@@ -41,13 +40,10 @@ 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, guidesComponent, disableCapturePreview, requireVerticalFaceCentering, assets, classNames, colors, verbiage, debugMode, }: FaceLivenessWizardProps) => ReactElement;
+export declare const FaceLivenessWizard: ({ onComplete, onSuccess, onTimeout, onExitCapture, onExitAfterFailure, onUserCancel, loadingOverlayMode, timeoutDurationMs, maxRetries, skipSuccessScreen, renderCameraFeed, releaseCameraAccessOnExit, silentFallback, assets, classNames, colors, verbiage, debugMode, }: FaceLivenessWizardProps) => ReactElement;

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

@@ -38,6 +38,8 @@ export type IdCaptureState = {
     idCardBackDetectionThresholdMet: boolean;
     passportDetectionScore: number;
     passportDetectionThresholdMet: boolean;
+    singlePageDetectionScore: number;
+    singlePageDetectionThresholdMet: boolean;
     focusScore: number;
     focusThresholdMet: boolean;
     isGoodFrame: boolean;

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

@@ -1,5 +1,5 @@
-import { ComponentType, ReactElement } from 'react';
-import { FaceCaptureGuideOverlayClassNames, FaceCaptureGuideOverlayProps } from '../face_liveness/FaceCaptureGuideOverlay';
+import { ReactElement } from 'react';
+import { FaceCaptureGuideOverlayClassNames } from '../face_liveness/FaceCaptureGuideOverlay';
 import { CustomerSuppliedVerbiage } from '../../lib/locales';
 import { SelfieCaptureFallbackClassNames } from '../fallback_flows/SelfieCapture';
 import { Face } from '../../lib/models/FaceDetection';
@@ -26,24 +26,19 @@ 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, onSelfieCaptureStarted, onSelfieCaptured, onTimeout, onExit, timeoutDurationMs, guidanceMessage, guidanceSatisfied, guidesComponent, requireVerticalFaceCentering, shouldCapture, classNames, colors, verbiage: rawVerbiage, debugMode, }: SelfieCaptureProps) => ReactElement;
+export declare const SelfieCapture: ({ onGuidanceSatisfied, onGuidanceNotSatisfied, onSelfieCaptured, onTimeout, onExit, timeoutDurationMs, guidanceMessage, guidanceSatisfied, classNames, colors, verbiage: rawVerbiage, debugMode, }: SelfieCaptureProps) => ReactElement;

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

@@ -1,19 +1,6 @@
-import React, { SVGProps } from 'react';
-import { FaceGuideStatus } from '../face_liveness/FaceCaptureGuideOverlay';
+import React from 'react';
 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';
-export type SelfieGuidancePredictionHandler = (prediction: Face[]) => Promise<void> | void;
+type PredictionHandler = (prediction: Face[]) => void;
 type SelfieGuidanceModelsState = {
     start: () => void;
     stop: () => void;
-    onPredictionMade: (handler: SelfieGuidancePredictionHandler) => void;
+    onPredictionMade: (handler: PredictionHandler) => void;
     canvasRef: MutableRefObject<HTMLCanvasElement | null>;
     ready: boolean;
     error: Error | null;

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

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

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

@@ -1,45 +1,37 @@
 import React, { ReactElement } from 'react';
-import { IdVideoCaptureFlipIdPromptClassNames } from './IdVideoCaptureFlipIdPrompt';
 import { CustomerSuppliedVerbiage } from '../../lib/locales';
-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 Action = 'SHOW_ID_FRONT' | 'FLIP_ID' | 'SHOW_ID_BACK' | 'READ_TEXT';
 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;
-    flipIdPrompt?: IdVideoCaptureFlipIdPromptClassNames;
+    flipIdPromptImage?: string;
 };
 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, faceGuideStatus, faceGuideBorderWidth, faceGuideBorderColor, idCardGuideStatus, idCardGuideBorderWidth, idCardGuideBorderColor, assets, classNames, verbiage: rawVerbiage, }: IdVideoCaptureGuidesProps) => ReactElement;
+export declare const IdVideoCaptureGuides: ({ requestedAction, satisfied, faceGuideBorderWidth, faceGuideBorderColor, 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/lib/locales/es/translation.d.ts

@@ -54,8 +54,6 @@ 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;

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

@@ -62,8 +62,6 @@ 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;

package/dist/lib/models/DocumentDetection.d.ts

@@ -1,16 +1,17 @@
 import { ObjectDetector, ObjectDetectorResult } from '@mediapipe/tasks-vision';
-export declare const defaultDocumentDetectorModelPath = "https://websdk-cdn-dev.idmission.com/assets/models/docdetectmp20240825/model_fp16.tflite";
+export declare const defaultDocumentDetectorModelPath = "https://websdk-cdn-dev.idmission.com/assets/models/docdetectmp20240830/model_fp16.tflite";
 export declare const defaultDocumentDetectionScoreThreshold = 0.1;
 export declare const defaultDocumentDetectionModelLoadTimeoutMs = 45000;
 export declare const defaultDocumentDetectionThresholds: DocumentDetectionThresholds;
-export type DocumentType = 'none' | 'idCardFront' | 'idCardBack' | 'passport';
+export type DocumentType = 'none' | 'idCardFront' | 'idCardBack' | 'passport' | 'singlePage';
 export declare const documentTypeDisplayNames: {
     idCardFront: string;
     idCardBack: string;
     passport: string;
+    singlePage: string;
     none: string;
 };
-export type Label = 'Document' | 'Document back' | 'MRZ' | 'PDF417' | 'Primary face' | 'Secondary face' | 'Glare' | 'Punch Hole' | 'Passport page';
+export type Label = 'Document' | 'Document back' | 'MRZ' | 'PDF417' | 'Primary face' | 'Secondary face' | 'Glare' | 'Punch Hole' | 'Passport page' | 'Single page';
 export type DetectedObjectBox = {
     xMin: number;
     xMax: number;
@@ -28,6 +29,7 @@ export type DocumentDetectionThresholds = {
     idCardFront?: number;
     idCardBack?: number;
     passport?: number;
+    singlePage?: number;
 };
 export declare function loadDocumentDetector(modelAssetPath?: string, scoreThreshold?: number): Promise<ObjectDetector>;
 export declare function useLoadDocumentDetector({ modelPath, modelLoadTimeoutMs, scoreThreshold, onModelError, }: {
@@ -54,6 +56,8 @@ export type DocumentDetectionPrediction = {
     idCardBackDetectionThresholdMet: boolean;
     passportDetectionScore: number;
     passportDetectionThresholdMet: boolean;
+    singlePageDetectionScore: number;
+    singlePageDetectionThresholdMet: boolean;
     bestDocument: DetectedObject | undefined;
     documentInBounds: boolean;
     documentTooClose: boolean;

package/dist/lib/models/Focus.d.ts

@@ -20,6 +20,10 @@ export type FocusThresholds = {
         desktop?: number;
         mobile?: number;
     };
+    singlePage?: {
+        desktop?: number;
+        mobile?: number;
+    };
 };
 export declare const defaultFocusThresholds: FocusThresholds;
 export declare function loadFocusModel(modelAssetPath: string): Promise<ImageClassifier>;