idmission-web-sdk 1.0.138 → 1.0.139

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

@@ -1,4 +1,4 @@
-import React, { ReactElement } from 'react';
+import React, { ReactElement, ReactNode } from 'react';
 import { DetectedObject } from '../../lib/models/DocumentDetection';
 import { Face, FaceKeypoint } from '../selfie_capture/HighPerformanceSelfieGuidanceModelsProvider';
 export declare const DebugStatsPane: import("styled-components").IStyledComponent<"web", {
@@ -273,7 +273,7 @@ export declare const DebugStatsPane: import("styled-components").IStyledComponen
     onTransitionEnd?: React.TransitionEventHandler<HTMLSpanElement> | undefined;
     onTransitionEndCapture?: React.TransitionEventHandler<HTMLSpanElement> | undefined;
 }>;
-export declare const ObjectDetectionDebugOverlay: import("styled-components").IStyledComponent<"web", import("styled-components/dist/types").Substitute<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {
+export declare const ObjectDetectionDebugOverlayDiv: import("styled-components").IStyledComponent<"web", import("styled-components/dist/types").Substitute<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {
     $flipX?: boolean | undefined;
 }>>;
 export declare const ObjectDetectionDebugBox: import("styled-components").IStyledComponent<"web", import("styled-components/dist/types").Substitute<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {
@@ -302,13 +302,18 @@ export declare function useDebugScalingDetails({ enabled, pageWidth, pageHeight,
     videoWidth: number;
     videoHeight: number;
 }): DebugScalingDetails;
+export declare const DebugBoundingBoxOverlay: ({ scaling, $flipX, children, }: {
+    scaling?: DebugScalingDetails | undefined;
+    $flipX?: boolean | undefined;
+    children: ReactNode;
+}) => React.JSX.Element;
 export type DetectedObjectDebugBoxProps = {
     obj: DetectedObject;
     scaling: DebugScalingDetails;
     flipX?: boolean;
     color?: string;
 };
-export declare function IdCaptureDetectedObjectDebugBox({ obj, flipX, color, scaling: { horizontal, pageWidth, pageHeight, scaledWidth, scaledHeight, xOffset, yOffset, }, }: DetectedObjectDebugBoxProps): ReactElement;
+export declare function IdCaptureDetectedObjectDebugBox({ obj, flipX, color, scaling: { horizontal, pageWidth, videoWidth, pageHeight, videoHeight }, }: DetectedObjectDebugBoxProps): ReactElement;
 export type SelfieCaptureFaceDebugBoxProps = {
     face: Face;
     scaling: DebugScalingDetails;

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

@@ -3,7 +3,7 @@ import { ThemeInput } from '../../themes';
 import { LangOption } from '../../lib/locales';
 import { SubmissionRequest } from '../../contexts/SubmissionContext';
 import { DocumentCaptureWizardClassNames } from '../document_capture/DocumentCaptureWizard';
-import { CameraFeedMode } from '../document_capture/DocumentCaptureScreen';
+import { CameraFeedMode } from '../../lib/camera/CameraFeedWrapper';
 export type DocumentCaptureClassNames = DocumentCaptureWizardClassNames;
 export interface DocumentCaptureProps extends PropsWithChildren {
     /** Language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto. */

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

@@ -9,6 +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';
 export type IdValidationAssets = IdCaptureWizardAssets;
 export type IdValidationClassNames = IdCaptureWizardClassNames & {
     additionalDocumentCapture?: AdditionalDocumentCaptureWizardClassNames;
@@ -76,6 +77,8 @@ export interface IdValidationProps extends PropsWithChildren {
     skipSuccessScreen?: boolean | (() => Promise<boolean>);
     /** React element or string to render on the instructions screen. */
     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 to allow documents that have been previously captured to be submitted. Valid keys: `idCardFront`, `idCardBack , `passport`.*/
     precapturedDocuments?: CapturedDocuments;
     /** Callback function that fires immediately prior to submission, giving the client application an opportunity to specify custom asynchronous logic that mutates the request before it executes. The submission request is passed in as a parameter and a promise resolving to the updated request should be returned. */

package/dist/components/document_capture/DocumentCaptureScreen.d.ts

@@ -1,5 +1,5 @@
 import React, { ReactNode } from 'react';
-export type CameraFeedMode = 'snapToGuides' | 'fullscreen';
+import { CameraFeedMode } from '../../lib/camera/CameraFeedWrapper';
 export type DocumentCaptureScreenClassNames = {
     container?: string;
     cameraFeed?: string;

package/dist/components/document_capture/DocumentCaptureWizard.d.ts

@@ -1,5 +1,6 @@
 import React, { ReactNode } from 'react';
-import { CameraFeedMode, DocumentCaptureScreenClassNames } from './DocumentCaptureScreen';
+import { DocumentCaptureScreenClassNames } from './DocumentCaptureScreen';
+import { CameraFeedMode } from '../../lib/camera/CameraFeedWrapper';
 export type DocumentCaptureWizardClassNames = DocumentCaptureScreenClassNames;
 export type DocumentCaptureWizardProps = {
     onSuccess?: () => void;

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

@@ -1,18 +1,19 @@
 import React from 'react';
-import { IdCaptureGuideOverlayClassNames } from './IdCaptureGuideOverlay';
 import { PDF417DetectionResult } from '../../lib/barcode/Native';
 import { CaptureAttemptMetadata } from '../../contexts/SubmissionContext';
 import { IdCapturePrediction } from './IdCaptureModelsProvider';
 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;
 };
 export type IdCaptureClassNames = {
     container?: string;
-    guides?: IdCaptureGuideOverlayClassNames;
+    guides?: IdCaptureFitGuideClassNames;
     guidanceMessageContainer?: string;
     guidanceMessage?: string;
     imagePreview?: IdCaptureImagePreviewClassNames;
@@ -48,6 +49,7 @@ export type IdCaptureProps = {
     barcodeScanningEnabled?: boolean;
     maxBarcodeScanAttempts?: number;
     focusScoreThreshold?: number;
+    guideType?: IdCaptureGuideType;
     guidanceMessage?: string;
     guidanceSatisfied?: boolean;
     onPrediction?: (prediction: IdCapturePrediction) => void;
@@ -62,4 +64,4 @@ export type IdCaptureProps = {
     verbiage?: IdCaptureVerbiage;
     debugMode?: boolean;
 };
-export declare const IdCapture: ({ requiredDocumentType, autoCaptureEnabled, autoCaptureScoreThreshold, autoCaptureGoodFramesRequired, autoCaptureBarcodeRequired, mrzDetectionScoreThreshold, passportPageDetectionThreshold, pdf417DetectionThreshold, focusScoreThreshold, barcodeScanningEnabled, maxBarcodeScanAttempts, 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, guideType, guidanceMessage, guidanceSatisfied, onPrediction, onBarcodeScanned, onCapture, onExit, processingScreen, processingDelay, assets, classNames, colors, verbiage: rawVerbiage, debugMode, }: IdCaptureProps) => React.ReactElement;

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

@@ -0,0 +1,19 @@
+import React from 'react';
+import { IdCaptureGuideOverlayClassNames } from './IdCaptureGuideOverlay';
+export type IdCaptureFitGuideClassNames = IdCaptureGuideOverlayClassNames & {
+    canvasWrapper?: string;
+    canvas?: string;
+};
+export type IdCaptureFitGuideProps = {
+    aspectRatio?: number;
+    maskColor?: string;
+    borderRadius?: number;
+    borderColor?: string;
+    borderWidth?: number;
+    padding?: number;
+    imageUrl?: string;
+    isMirrored?: boolean;
+    instruction?: string;
+    classNames?: IdCaptureFitGuideClassNames;
+};
+export declare const IdCaptureFitGuide: ({ aspectRatio, maskColor, borderRadius, borderColor, borderWidth, padding, imageUrl, isMirrored, instruction, classNames, }: IdCaptureFitGuideProps) => React.JSX.Element;

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

@@ -546,6 +546,7 @@ export declare const GuideCenterRow: import("styled-components").IStyledComponen
 export declare const GuideRegion: import("styled-components").IStyledComponent<"web", import("styled-components/dist/types").Substitute<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {
     $minWidth?: number | undefined;
     $minHeight?: number | undefined;
+    $maskColor?: string | undefined;
 }>>;
 export declare const GuideCenterRegion: import("styled-components").IStyledComponent<"web", import("styled-components/dist/types").Substitute<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {
     $isMirrored?: boolean | undefined;
@@ -853,10 +854,11 @@ export type IdCaptureGuideOverlayProps = {
     imagePadding?: number;
     borderWidth?: number;
     borderColor?: string;
+    maskColor?: string;
     isMirrored?: boolean;
     instruction?: string;
     portraitGuidesImageUrl?: string;
     landscapeGuidesImageUrl?: string;
     onClick?: () => void;
 };
-export declare const IdCaptureGuideOverlay: ({ classNames, width, height, padding: userSuppliedPadding, imagePadding: userSuppliedImagePadding, borderWidth, borderColor, isMirrored, instruction, portraitGuidesImageUrl, landscapeGuidesImageUrl, onClick, }: IdCaptureGuideOverlayProps) => ReactElement;
+export declare const IdCaptureGuideOverlay: ({ classNames, width, height, padding: userSuppliedPadding, imagePadding: userSuppliedImagePadding, borderWidth, borderColor, maskColor, isMirrored, instruction, portraitGuidesImageUrl, landscapeGuidesImageUrl, onClick, }: IdCaptureGuideOverlayProps) => ReactElement;

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

@@ -0,0 +1,39 @@
+import React, { Dispatch, ReactNode } from 'react';
+export type IdCaptureState = {
+    initialDrawComplete: boolean;
+    redrawing: boolean;
+    guideRectX: number;
+    guideRectY: number;
+    guideRectWidth: number;
+    guideRectHeight: number;
+    guideRectOffsetTop: number;
+    guideImageWidth: number;
+    guideImageHeight: number;
+};
+export type IdCaptureAction = {
+    type: 'redrawRequested';
+} | {
+    type: 'redrawInProgress';
+} | {
+    type: 'redrawCompleted';
+    payload: {
+        guideRectX: number;
+        guideRectY: number;
+        guideRectWidth: number;
+        guideRectHeight: number;
+        guideRectOffsetTop: number;
+    };
+} | {
+    type: 'guideImageLoaded';
+    payload: {
+        width: number;
+        height: number;
+    };
+};
+export type IdCaptureDispatch = Dispatch<IdCaptureAction>;
+export declare const IdCaptureStateContext: React.Context<IdCaptureState>;
+export declare const IdCaptureDispatchContext: React.Context<IdCaptureDispatch>;
+export declare const IdCaptureStateProvider: ({ children, }: {
+    children: ReactNode;
+}) => React.JSX.Element;
+export declare const useIdCaptureState: () => [IdCaptureState, IdCaptureDispatch];

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

@@ -1,5 +1,5 @@
 import { ReactElement, ReactNode } from 'react';
-import { IdCaptureAssets, IdCaptureClassNames, IdCaptureColors, IdCaptureVerbiage } from './IdCapture';
+import { IdCaptureAssets, IdCaptureClassNames, IdCaptureColors, IdCaptureGuideType, IdCaptureVerbiage } from './IdCapture';
 import { IdCaptureLoadingOverlayAssets, IdCaptureLoadingOverlayClassNames, IdCaptureLoadingOverlayColors, IdCaptureLoadingOverlayVerbiage } from './IdCaptureLoadingOverlay';
 import { FlipIdPromptAssets, FlipIdPromptClassNames, FlipIdPromptVerbiage } from './FlipIdPrompt';
 import { CapturedDocuments } from './CapturedDocuments';
@@ -61,10 +61,11 @@ export type IdCaptureWizardProps = {
     skipSuccessScreen?: boolean | (() => Promise<boolean>);
     instructions?: ReactNode;
     releaseCameraAccessOnExit?: boolean;
+    guideType?: IdCaptureGuideType;
     assets?: IdCaptureWizardAssets;
     classNames?: IdCaptureWizardClassNames;
     colors?: IdCaptureWizardColors;
     verbiage?: IdCaptureWizardVerbiage;
     debugMode?: boolean;
 };
-export declare const IdCaptureWizard: ({ onSuccess, onExitCapture, onUserCancel, precapturedDocuments, captureRequirement, autoCaptureEnabled, autoCaptureGoodFramesRequired, autoCaptureBarcodeRequired, barcodeScanningEnabled, idCardAutoCaptureScoreThreshold, passportAutoCaptureScoreThreshold, mrzDetectionScoreThreshold, idCardFocusScoreThreshold, passportFocusScoreThreshold, skipSuccessScreen, instructions, releaseCameraAccessOnExit, assets, classNames, colors, verbiage, debugMode, }: IdCaptureWizardProps) => ReactElement;
+export declare const IdCaptureWizard: ({ onSuccess, onExitCapture, onUserCancel, precapturedDocuments, captureRequirement, autoCaptureEnabled, autoCaptureGoodFramesRequired, autoCaptureBarcodeRequired, barcodeScanningEnabled, idCardAutoCaptureScoreThreshold, passportAutoCaptureScoreThreshold, mrzDetectionScoreThreshold, idCardFocusScoreThreshold, passportFocusScoreThreshold, skipSuccessScreen, instructions, releaseCameraAccessOnExit, guideType, assets, classNames, colors, verbiage, debugMode, }: IdCaptureWizardProps) => ReactElement;

package/dist/lib/camera/CameraFeedWrapper.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="react" />
+export type CameraFeedMode = 'snapToGuides' | 'fullscreen';
+export declare const CameraFeedWrapper: import("styled-components").IStyledComponent<"web", import("styled-components/dist/types").Substitute<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {
+    $mode: CameraFeedMode;
+    $x: number;
+    $y: number;
+    $w: number;
+    $h: number;
+}>>;

package/dist/lib/utils/canvas.d.ts

@@ -0,0 +1,2 @@
+export declare function setCanvasDimensions(canvas: HTMLCanvasElement, width: number, height: number): void;
+export declare function resetCanvasDimensions(canvas: HTMLCanvasElement): void;