idmission-web-sdk 1.0.139 → 1.0.140

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

@@ -313,7 +313,7 @@ export type DetectedObjectDebugBoxProps = {
     flipX?: boolean;
     color?: string;
 };
-export declare function IdCaptureDetectedObjectDebugBox({ obj, flipX, color, scaling: { horizontal, pageWidth, videoWidth, pageHeight, videoHeight }, }: DetectedObjectDebugBoxProps): ReactElement;
+export declare function IdCaptureDetectedObjectDebugBox({ obj, flipX, color, }: DetectedObjectDebugBoxProps): ReactElement;
 export type SelfieCaptureFaceDebugBoxProps = {
     face: Face;
     scaling: DebugScalingDetails;

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

@@ -9,7 +9,7 @@ import { VideoSignatureClassNames, VideoSignatureColors, VideoSignatureVerbiage
 import { ThemeInput } from '../../themes';
 import { IdCaptureRequirementOption } from '../id_capture/IdCaptureRequirementOption';
 import { CapturedDocuments } from '../id_capture/CapturedDocuments';
-import { IdCaptureGuideType } from '../id_capture/IdCapture';
+import { IdCaptureGuideType } from '../id_capture/IdCaptureGuides';
 export type IdValidationAssets = IdCaptureWizardAssets;
 export type IdValidationClassNames = IdCaptureWizardClassNames & {
     additionalDocumentCapture?: AdditionalDocumentCaptureWizardClassNames;

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

@@ -27,8 +27,9 @@ export type FlipIdPromptProps = {
     imagePadding?: number;
     borderWidth?: number;
     borderColor?: string;
+    maskColor?: string;
     assets?: FlipIdPromptAssets;
     classNames?: FlipIdPromptClassNames;
     verbiage?: FlipIdPromptVerbiage;
 };
-export declare const FlipIdPrompt: ({ padding: userSuppliedPadding, imagePadding: userSuppliedImagePadding, borderWidth, borderColor, assets, classNames, verbiage, }: FlipIdPromptProps) => ReactElement;
+export declare const FlipIdPrompt: ({ padding: userSuppliedPadding, imagePadding: userSuppliedImagePadding, borderWidth, borderColor, maskColor, assets, classNames, verbiage, }: FlipIdPromptProps) => ReactElement;

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

@@ -6,7 +6,6 @@ import { IdCaptureImagePreviewClassNames } from '../common/SelfieProgressPreview
 import { CustomerSuppliedVerbiage } from '../../lib/locales';
 import { CapturedDocumentType } from './CapturedDocuments';
 import { IdCaptureFitGuideClassNames } from './IdCaptureFitGuide';
-export type IdCaptureGuideType = 'fit' | 'overlay';
 export type IdCaptureAssets = {
     portraitGuidesImageUrl?: string;
     landscapeGuidesImageUrl?: string;
@@ -49,19 +48,16 @@ export type IdCaptureProps = {
     barcodeScanningEnabled?: boolean;
     maxBarcodeScanAttempts?: number;
     focusScoreThreshold?: number;
-    guideType?: IdCaptureGuideType;
     guidanceMessage?: string;
     guidanceSatisfied?: boolean;
     onPrediction?: (prediction: IdCapturePrediction) => void;
     onBarcodeScanned?: (result: PDF417DetectionResult) => void;
     onCapture?: (frame: string, width: number, height: number, metadata: CaptureAttemptMetadata) => void;
     onExit?: () => void;
-    processingScreen?: React.ReactElement;
-    processingDelay?: number;
     assets?: IdCaptureAssets;
     classNames?: IdCaptureClassNames;
     colors?: IdCaptureColors;
     verbiage?: IdCaptureVerbiage;
     debugMode?: boolean;
 };
-export declare const IdCapture: ({ requiredDocumentType, autoCaptureEnabled, autoCaptureScoreThreshold, autoCaptureGoodFramesRequired, autoCaptureBarcodeRequired, mrzDetectionScoreThreshold, passportPageDetectionThreshold, pdf417DetectionThreshold, focusScoreThreshold, barcodeScanningEnabled, maxBarcodeScanAttempts, guideType, guidanceMessage, guidanceSatisfied, onPrediction, onBarcodeScanned, onCapture, onExit, processingScreen, processingDelay, assets, classNames, colors, verbiage: rawVerbiage, debugMode, }: IdCaptureProps) => React.ReactElement;
+export declare const IdCapture: ({ requiredDocumentType, autoCaptureEnabled, autoCaptureScoreThreshold, autoCaptureGoodFramesRequired, autoCaptureBarcodeRequired, mrzDetectionScoreThreshold, passportPageDetectionThreshold, pdf417DetectionThreshold, focusScoreThreshold, barcodeScanningEnabled, maxBarcodeScanAttempts, guidanceMessage, guidanceSatisfied, onPrediction, onBarcodeScanned, onCapture, onExit, assets, classNames, colors, verbiage: rawVerbiage, debugMode, }: IdCaptureProps) => React.ReactElement;

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

@@ -12,8 +12,11 @@ export type IdCaptureFitGuideProps = {
     borderWidth?: number;
     padding?: number;
     imageUrl?: string;
+    frontImageUrl?: string;
+    backImageUrl?: string;
     isMirrored?: boolean;
     instruction?: string;
+    requestingFlip?: boolean;
     classNames?: IdCaptureFitGuideClassNames;
 };
-export declare const IdCaptureFitGuide: ({ aspectRatio, maskColor, borderRadius, borderColor, borderWidth, padding, imageUrl, isMirrored, instruction, classNames, }: IdCaptureFitGuideProps) => React.JSX.Element;
+export declare const IdCaptureFitGuide: ({ aspectRatio, maskColor, borderRadius, borderColor, borderWidth, padding, imageUrl, frontImageUrl, backImageUrl, isMirrored, instruction, requestingFlip, classNames, }: IdCaptureFitGuideProps) => React.JSX.Element;

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

@@ -0,0 +1,14 @@
+import { IdCaptureFitGuideClassNames } from './IdCaptureFitGuide';
+import React from 'react';
+import { IdCaptureAssets, IdCaptureColors, IdCaptureVerbiage } from './IdCapture';
+export type IdCaptureGuideType = 'fit' | 'overlay';
+export declare function IdCaptureGuides({ guideType, requestingFlip, frontImageUrl, backImageUrl, classNames, assets, colors, verbiage: rawVerbiage, }: {
+    guideType?: IdCaptureGuideType;
+    requestingFlip?: boolean;
+    frontImageUrl?: string;
+    backImageUrl?: string;
+    classNames?: IdCaptureFitGuideClassNames;
+    assets?: IdCaptureAssets;
+    colors?: IdCaptureColors;
+    verbiage?: IdCaptureVerbiage;
+}): React.JSX.Element;

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

@@ -1,4 +1,8 @@
 import React, { Dispatch, ReactNode } from 'react';
+import { CapturedDocumentType } from './CapturedDocuments';
+import { IdCapturePrediction } from './IdCaptureModelsProvider';
+import { PDF417DetectionResult } from '../../lib/barcode/Native';
+import { DetectedObject, DocumentType } from '../../lib/models/DocumentDetection';
 export type IdCaptureState = {
     initialDrawComplete: boolean;
     redrawing: boolean;
@@ -9,8 +13,55 @@ export type IdCaptureState = {
     guideRectOffsetTop: number;
     guideImageWidth: number;
     guideImageHeight: number;
+    pageWidth: number;
+    pageHeight: number;
+    videoWidth: number;
+    videoHeight: number;
+    detectedObjects: DetectedObject[];
+    bestDocument: DetectedObject | undefined;
+    bestMrz: DetectedObject | undefined;
+    bestPdf417: DetectedObject | undefined;
+    documentType: DocumentType;
+    requiredDocumentType?: CapturedDocumentType;
+    documentInBounds: boolean;
+    documentDetectionScore: number;
+    documentDetectionThresholdMet: boolean;
+    mrzDetectionScore: number;
+    mrzDetectionThresholdMet: boolean;
+    passportPageDetectionScore: number;
+    passportPageDetectionThresholdMet: boolean;
+    focusScore: number;
+    focusThresholdMet: boolean;
+    pdf417DetectionScore: number;
+    pdf417DetectionThresholdMet: boolean;
+    barcodeScanningEnabled: boolean;
+    barcodeResult: PDF417DetectionResult | null;
+    waitingForBarcodeScan: boolean;
+    shouldScanBarcode: boolean;
+    autoCaptureBarcodeRequired: boolean | 'mobile';
+    barcodeScanFailedAttempts: number;
+    maxBarcodeScanAttempts: number;
+    isGoodFrame: boolean;
+    goodFramesCount: number;
+    goodFramesThreshold: number;
+    goodFramesThresholdMet: boolean;
+    lastFrameCapturedAt: Date | null;
+    frameCaptureRate: number;
+    capturing: boolean;
+    captured: boolean;
+    captureFailed: boolean;
+    imageUrl: string | null;
 };
 export type IdCaptureAction = {
+    type: 'configure';
+    payload: {
+        requiredDocumentType?: CapturedDocumentType;
+        goodFramesThreshold: number;
+        autoCaptureBarcodeRequired: boolean | 'mobile';
+        barcodeScanningEnabled: boolean;
+        maxBarcodeScanAttempts: number;
+    };
+} | {
     type: 'redrawRequested';
 } | {
     type: 'redrawInProgress';
@@ -23,12 +74,41 @@ export type IdCaptureAction = {
         guideRectHeight: number;
         guideRectOffsetTop: number;
     };
+} | {
+    type: 'pageRendered';
+    payload: {
+        pageWidth: number;
+        pageHeight: number;
+    };
 } | {
     type: 'guideImageLoaded';
     payload: {
         width: number;
         height: number;
     };
+} | {
+    type: 'capturing';
+} | {
+    type: 'captured';
+} | {
+    type: 'captureFailed';
+} | {
+    type: 'frameCaptured';
+    payload: {
+        imageUrl: string;
+    };
+} | {
+    type: 'objectsDetected';
+    payload: {
+        prediction: IdCapturePrediction;
+    };
+} | {
+    type: 'barcodeScanned';
+    payload: {
+        result: PDF417DetectionResult;
+    };
+} | {
+    type: 'barcodeScanFailed';
 };
 export type IdCaptureDispatch = Dispatch<IdCaptureAction>;
 export declare const IdCaptureStateContext: React.Context<IdCaptureState>;

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

@@ -1,11 +1,12 @@
 import { ReactElement, ReactNode } from 'react';
-import { IdCaptureAssets, IdCaptureClassNames, IdCaptureColors, IdCaptureGuideType, IdCaptureVerbiage } from './IdCapture';
+import { IdCaptureAssets, IdCaptureClassNames, IdCaptureColors, IdCaptureVerbiage } from './IdCapture';
 import { IdCaptureLoadingOverlayAssets, IdCaptureLoadingOverlayClassNames, IdCaptureLoadingOverlayColors, IdCaptureLoadingOverlayVerbiage } from './IdCaptureLoadingOverlay';
 import { FlipIdPromptAssets, FlipIdPromptClassNames, FlipIdPromptVerbiage } from './FlipIdPrompt';
 import { CapturedDocuments } from './CapturedDocuments';
 import { IdCaptureSuccessClassNames, IdCaptureSuccessColors, IdCaptureSuccessVerbiage } from './IdCaptureSuccess';
 import { IdCaptureFallbackClassNames, IdCaptureFallbackColors, IdCaptureFallbackVerbiage } from '../fallback_flows/IdCapture';
 import { IdCaptureRequirementOption } from './IdCaptureRequirementOption';
+import { IdCaptureGuideType } from './IdCaptureGuides';
 export type IdCaptureWizardAssets = {
     documentDetectionModelUrl?: string;
     focusModelUrl?: string;