idmission-web-sdk 2.1.42 → 2.1.44

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

@@ -39,6 +39,8 @@ export type IdCaptureVerbiage = {
     guidanceNotCenteredText?: CustomerSuppliedVerbiage;
     guidanceTooCloseText?: CustomerSuppliedVerbiage;
     guidanceNotDetectedText?: CustomerSuppliedVerbiage;
+    guidanceIdCardNotAllowedText?: CustomerSuppliedVerbiage;
+    guidancePassportNotAllowedText?: CustomerSuppliedVerbiage;
     overrideWrongDocumentTypeGuidanceDialog?: OverrideWrongDocumentTypeGuidanceDialogVerbiage;
 };
 export type IdCaptureProps = {

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

@@ -27,6 +27,8 @@ export type IdCaptureState = {
     documentTooClose: boolean;
     flipRequired: boolean;
     backDetectedFirst: boolean;
+    idCardDetectedButNotAllowed: boolean;
+    passportDetectedButNotAllowed: boolean;
     enableOverrideWrongDocumentTypeDialog: boolean;
     allowOverrideWrongDocumentTypeAfterMs: number;
     allowOverrideWrongDocumentTypeGuidance: boolean;

package/dist/components/video_signature_capture/VideoSignatureCapture.d.ts

@@ -1,17 +1,12 @@
-import React from 'react';
+import React, { ComponentType } from 'react';
 import { SignatureData } from '../signature_capture/data';
 import { CustomerSuppliedVerbiage } from '../../lib/locales';
+import { FaceCaptureGuideOverlayProps } from '../face_liveness/FaceCaptureGuideOverlay';
 export type VideoSignatureCaptureClassNames = {
     container?: string;
     cameraFeed?: string;
     guidanceMessageContainer?: string;
     guidanceMessage?: string;
-    canvasContainer?: string;
-    canvasInner?: string;
-    canvas?: string;
-    buttonsRow?: string;
-    acceptBtn?: string;
-    clearBtn?: string;
     exitCaptureBtn?: string;
 };
 export type VideoSignatureCaptureColors = {
@@ -20,16 +15,15 @@ export type VideoSignatureCaptureColors = {
 };
 export type VideoSignatureCaptureVerbiage = {
     guidanceMessageText?: CustomerSuppliedVerbiage;
-    acceptBtnText?: CustomerSuppliedVerbiage;
-    clearBtnText?: CustomerSuppliedVerbiage;
 };
 export type VideoSignatureCaptureProps = {
     onVideoCaptured?: (videoData: Blob, signatureData: SignatureData, signatureImageData: string) => void;
     onFaceNotDetected?: () => void;
     onExit?: () => void;
+    guidesComponent?: ComponentType<FaceCaptureGuideOverlayProps>;
     classNames?: VideoSignatureCaptureClassNames;
     colors?: VideoSignatureCaptureColors;
     verbiage?: VideoSignatureCaptureVerbiage;
     debugMode?: boolean;
 };
-export declare const VideoSignatureCapture: ({ onVideoCaptured, onFaceNotDetected, onExit, classNames, colors, verbiage: rawVerbiage, debugMode, }: VideoSignatureCaptureProps) => React.ReactElement;
+export declare const VideoSignatureCapture: ({ onVideoCaptured, onFaceNotDetected, onExit, guidesComponent, classNames, colors, verbiage: rawVerbiage, debugMode, }: VideoSignatureCaptureProps) => React.ReactElement;

package/dist/components/video_signature_capture/VideoSignatureContext.d.ts

@@ -0,0 +1,18 @@
+import React, { ReactNode } from 'react';
+import { SignatureData } from '../signature_capture/data';
+import SignatureCanvas from 'react-signature-canvas';
+export type VideoSignatureState = {
+    startRecording: () => void;
+    stopRecording: () => void;
+    signaturePad?: React.RefObject<SignatureCanvas>;
+    signatureData: SignatureData | null;
+    signatureDataUrl: string | null;
+    signatureVideoData: Blob | null;
+    signatureVideoUrl: string | null;
+    onAcceptClicked: () => Promise<void>;
+};
+export declare const VideoSignatureContext: React.Context<VideoSignatureState>;
+export default function VideoSignatureContextProvider({ children, }: {
+    children: ReactNode;
+}): React.JSX.Element;
+export declare function useVideoSignatureContext(): VideoSignatureState;

package/dist/components/video_signature_capture/VideoSignatureGuides.d.ts

@@ -0,0 +1,28 @@
+import React from 'react';
+import { FaceGuideStatus } from '../face_liveness/FaceCaptureGuideOverlay';
+export type Action = 'VERIFY_LIVENESS' | 'CAPTURE_SIGNATURE';
+export type VideoSignatureGuidesClassNames = {
+    container?: string;
+    inner?: string;
+    faceGuideContainer?: string;
+    faceGuide?: string;
+    signaturePadContainer?: string;
+    signatureCanvasContainer?: string;
+    signatureCanvasInner?: string;
+    signatureCanvas?: string;
+    signatureButtonsRow?: string;
+    clearSignatureBtn?: string;
+    acceptSignatureBtn?: string;
+};
+export type VideoSignatureGuidesVerbiage = {
+    clearSignatureBtnText?: string;
+    acceptSignatureBtnText?: string;
+};
+export default function VideoSignatureGuides({ requestedAction, faceGuideStatus, faceGuideBorderWidth, faceGuideBorderColor, classNames, verbiage: rawVerbiage, }: {
+    requestedAction?: Action;
+    faceGuideStatus?: FaceGuideStatus;
+    faceGuideBorderWidth?: number;
+    faceGuideBorderColor?: string;
+    classNames?: VideoSignatureGuidesClassNames;
+    verbiage?: VideoSignatureGuidesVerbiage;
+}): React.JSX.Element;

package/dist/components/video_signature_capture/VideoSignatureSuccess.d.ts

@@ -21,7 +21,6 @@ export type VideoSignatureSuccessVerbiage = {
     doneBtnText?: CustomerSuppliedVerbiage;
 };
 export type VideoSignatureSuccessProps = {
-    videoUrl: string;
     imageUrl: string;
     onDoneClick?: () => void;
     onRetryClick?: () => void;
@@ -29,4 +28,4 @@ export type VideoSignatureSuccessProps = {
     colors?: VideoSignatureSuccessColors;
     verbiage?: VideoSignatureSuccessVerbiage;
 };
-export declare const VideoSignatureSuccess: ({ videoUrl, imageUrl, onDoneClick, onRetryClick, classNames, colors, verbiage: rawVerbiage, }: VideoSignatureSuccessProps) => ReactElement;
+export declare const VideoSignatureSuccess: ({ imageUrl, onDoneClick, onRetryClick, classNames, colors, verbiage: rawVerbiage, }: VideoSignatureSuccessProps) => ReactElement;

package/dist/contexts/SubmissionContext.d.ts

@@ -33,6 +33,7 @@ export type SubmissionRequest = {
             idType: 'NSP';
             idCountry: 'NSP';
             idState: '';
+            idNumber?: string;
             issueDate?: string;
             expDate?: string;
         };
@@ -109,17 +110,18 @@ export type CardData = {
     nameOnCard?: string;
 };
 export type IdData = {
+    idNumber?: string;
     issueDate?: string;
     expDate?: string;
 };
 export type CustomerDataMatchConfig = {
     /** Boolean flag to indicate whether the server should perform name matching using the `name` value from `personalData`. Valid values: "Y" (fuzzy match accepting 90% or higher similarity), "E" (only accept exact matches), "N" (do not perform matching). Defaults to "N". */
     nameMatch?: 'Y' | 'E' | 'N';
-    /** Boolean flag to indicate whether the server should perform ID number matching using the `idNumber` value from `personalData`. Valid values: "Y" (fuzzy match accepting 90% or higher similarity), "E" (only accept exact matches), "N" (do not perform matching). Defaults to "N". */
+    /** Boolean flag to indicate whether the server should perform ID number matching using the `idNumber` value from `idData`. Valid values: "Y" (fuzzy match accepting 90% or higher similarity), "E" (only accept exact matches), "N" (do not perform matching). Defaults to "N". */
     idNumberMatch?: 'Y' | 'E' | 'N';
     /** Boolean flag to indicate whether the server should perform date of birth matching using the `dob` value from `personalData`. Valid values: "Y" (fuzzy match accepting 90% or higher similarity), "E" (only accept exact matches), "N" (do not perform matching). Defaults to "N". */
     dateOfBirthMatch?: 'Y' | 'E' | 'N';
-    /** Boolean flag to indicate whether the server should perform expiry date matching using the `expDate` value from `personalData`. Valid values: "Y" (fuzzy match accepting 90% or higher similarity), "E" (only accept exact matches), "N" (do not perform matching). Defaults to "N". */
+    /** Boolean flag to indicate whether the server should perform expiry date matching using the `expDate` value from `idData`. Valid values: "Y" (fuzzy match accepting 90% or higher similarity), "E" (only accept exact matches), "N" (do not perform matching). Defaults to "N". */
     expiryDateMatch?: 'Y' | 'E' | 'N';
 };
 export type SubmissionMetadata = {

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

@@ -26,6 +26,8 @@ declare const _default: {
     'Document out of focus \u2013 try improving the lighting': string;
     'ID card front detected - please flip your ID card': string;
     'ID card back detected - please flip your ID card': string;
+    'ID card detected, please scan a passport instead': string;
+    'Passport detected, please scan an ID card instead': string;
     'Document detected, hold still...': string;
     'ID card front detected, hold still...': string;
     'ID card back detected, hold still...': string;

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

@@ -34,6 +34,8 @@ export declare const resources: {
             'Document out of focus \u2013 try improving the lighting': string;
             'ID card front detected - please flip your ID card': string;
             'ID card back detected - please flip your ID card': string;
+            'ID card detected, please scan a passport instead': string;
+            'Passport detected, please scan an ID card instead': string;
             'Document detected, hold still...': string;
             'ID card front detected, hold still...': string;
             'ID card back detected, hold still...': string;