idmission-web-sdk 1.0.104 → 1.0.106

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

@@ -3,6 +3,7 @@ import { ThemeInput } from '../../themes';
 import { LangOption } from '../../lib/locales';
 import { SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
 import { DocumentCaptureWizardClassNames } from '../document_capture/DocumentCaptureWizard';
+import { CameraFeedMode } from '../document_capture/DocumentCaptureScreen';
 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. */
@@ -11,6 +12,8 @@ export interface DocumentCaptureProps extends PropsWithChildren {
     submissionToken: string;
     /** URL to hit with all API requests. Defaults to the value specified in your decoded `submissionToken`. */
     submissionUrl?: string;
+    /** URL to upload captured documents to via Tus. */
+    documentServiceUrl?: string;
     /** 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. */
     onBeforeSubmit?: (req: SubmissionRequest) => Promise<SubmissionRequest>;
     /** Callback function that fires when the user has completed the flow instead of making a call to IDmission's servers, allowing customers to specify their own submission logic. Arguments: the request payload that would have been dispatched to IDmission's API, which contains the images/documents/video submitted by the user. Note that when this parameter is supplied, `onComplete` will never fire, and the customer will need to implement their own error handling/retry logic. Use at your own risk! */
@@ -22,6 +25,7 @@ export interface DocumentCaptureProps extends PropsWithChildren {
     /** Callback function that fires when the user clicks the exit button from the loading overlay, declining to engage with IDmission. Binding this callback results in the cancel button being rendered on the loading overlay. */
     onUserCancel?: () => void;
     aspectRatio?: number;
+    cameraFeedMode?: CameraFeedMode;
     instructions?: ReactNode;
     /** Name of an included theme or object containing theme properties. **/
     theme?: ThemeInput;

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

@@ -7,7 +7,7 @@ export type DocumentCaptureGuideOverlayProps = {
     borderRadius?: number;
     borderColor?: string;
     borderWidth?: number;
-    maskColor?: string;
+    maskColor: string;
     padding?: number;
     classNames?: DocumentCaptureGuideOverlayClassNames;
 };

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

@@ -0,0 +1,15 @@
+import React, { ReactNode } from 'react';
+export type CameraFeedMode = 'snapToGuides' | 'fullscreen';
+export type DocumentCaptureScreenClassNames = {
+    container?: string;
+    cameraFeed?: string;
+};
+export type DocumentCaptureScreenProps = {
+    aspectRatio?: number;
+    cameraFeedMode?: CameraFeedMode;
+    classNames?: DocumentCaptureScreenClassNames;
+    instructions?: ReactNode;
+    onCaptureClicked?: () => void;
+    onSuccess?: (blob: Blob) => void;
+};
+export declare const DocumentCaptureScreen: ({ aspectRatio, cameraFeedMode, classNames, instructions, onCaptureClicked, onSuccess, }: DocumentCaptureScreenProps) => React.JSX.Element;

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

@@ -0,0 +1,68 @@
+import React, { Dispatch, ReactNode } from 'react';
+export type DocumentCaptureState = {
+    initialDrawComplete: boolean;
+    redrawing: boolean;
+    rectX: number;
+    rectY: number;
+    rectWidth: number;
+    rectHeight: number;
+    rectOffsetTop: number;
+    capturing: boolean;
+    imageUrl: string;
+    imageBlob: Blob | null;
+    uploadState: 'not_started' | 'in_progress' | 'succeeded' | 'failed';
+};
+export declare const documentCaptureInitialState: {
+    initialDrawComplete: false;
+    redrawing: false;
+    capturing: false;
+    rectX: number;
+    rectY: number;
+    rectWidth: number;
+    rectHeight: number;
+    rectOffsetTop: number;
+    imageUrl: string;
+    imageBlob: null;
+    uploadState: "not_started";
+};
+export declare const DocumentCaptureStateContext: React.Context<DocumentCaptureState>;
+export type DocumentCaptureAction = {
+    type: 'redrawRequested';
+} | {
+    type: 'redrawInProgress';
+} | {
+    type: 'redrawCompleted';
+    payload: {
+        rectX: number;
+        rectY: number;
+        rectWidth: number;
+        rectHeight: number;
+        rectOffsetTop: number;
+    };
+} | {
+    type: 'captureRequested';
+} | {
+    type: 'captureCompleted';
+    payload: {
+        imageUrl: string;
+        imageBlob: Blob;
+    };
+} | {
+    type: 'retryCapture';
+} | {
+    type: 'uploadStarted';
+} | {
+    type: 'uploadCompleted';
+} | {
+    type: 'uploadFailed';
+};
+export type DocumentCaptureDispatch = Dispatch<DocumentCaptureAction>;
+export declare const DocumentCaptureDispatchContext: React.Context<DocumentCaptureDispatch>;
+export declare const documentCaptureStateReducer: (state: DocumentCaptureState, action: DocumentCaptureAction) => DocumentCaptureState;
+export declare const DocumentCaptureStateProvider: ({ children, }: {
+    children: ReactNode;
+}) => React.JSX.Element;
+export declare const useDocumentCaptureState: () => [
+    DocumentCaptureState,
+    DocumentCaptureDispatch
+];

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

@@ -1,14 +1,13 @@
 import React, { ReactNode } from 'react';
-export type DocumentCaptureWizardClassNames = {
-    container?: string;
-    cameraFeed?: string;
-};
+import { CameraFeedMode, DocumentCaptureScreenClassNames } from './DocumentCaptureScreen';
+export type DocumentCaptureWizardClassNames = DocumentCaptureScreenClassNames;
 export type DocumentCaptureWizardProps = {
     onSuccess?: () => void;
     onExitCapture?: () => void;
     onUserCancel?: () => void;
     aspectRatio?: number;
+    cameraFeedMode?: CameraFeedMode;
     instructions?: ReactNode;
     classNames?: DocumentCaptureWizardClassNames;
 };
-export declare const DocumentCaptureWizard: ({ aspectRatio, instructions, classNames, }: DocumentCaptureWizardProps) => React.JSX.Element;
+export declare const DocumentCaptureWizard: ({ onSuccess, aspectRatio, cameraFeedMode, instructions, classNames, }: DocumentCaptureWizardProps) => React.JSX.Element;

package/dist/components/submission/SubmissionProvider.d.ts

@@ -32,6 +32,7 @@ export type SubmissionState = {
     setIdCaptureVideoIdFrontImage: (image: string) => void;
     setIdCaptureVideoIdBackImage: (image: string) => void;
     setAdditionalDocuments: (uploadedDocuments: UploadedDocument[]) => void;
+    uploadDocument: (blob: Blob) => Promise<string>;
     logIdFrontCaptureAttempt: (attempt: CaptureAttemptMetadata) => void;
     logIdBackCaptureAttempt: (attempt: CaptureAttemptMetadata) => void;
     logSelfieCaptureAttempt: (attempt: CaptureAttemptMetadata) => void;
@@ -68,10 +69,11 @@ export type SubmissionProviderProps = {
     webhooksSendProcessedImages?: boolean;
     webhooksFireOnReview?: boolean;
     precapturedDocuments?: CapturedDocuments;
+    documentServiceUrl?: string;
     onSubmit?: (payload: SubmissionRequest) => void;
     onBeforeSubmit?: (req: SubmissionRequest) => Promise<SubmissionRequest>;
     onBeforeLivenessCheck?: (req: LivenessCheckRequest) => Promise<LivenessCheckRequest>;
     onResponseReceived?: (res: SubmissionResponse, req: SubmissionRequest) => void;
     onRequestFailure?: (err: Error) => void;
 };
-export declare const SubmissionProvider: ({ action, children, url, environment, token, companyId, enrollmentId, personalData, cardData, bypassAgeValidation, bypassNameMatching, needImmediateResponse, manualReviewRequired, idBackImageRequired, idImageResolutionCheck, verifyIdWithExternalDatabases, deduplicationEnabled, deduplicationSynchronous, geolocationEnabled, geolocationRequired, webhooksEnabled, webhooksClientTraceId, webhooksStripSpecialCharacters, webhooksSendInputImages, webhooksSendProcessedImages, webhooksFireOnReview, precapturedDocuments, onSubmit, onBeforeSubmit, onBeforeLivenessCheck, onResponseReceived, onRequestFailure, }: SubmissionProviderProps) => ReactElement;
+export declare const SubmissionProvider: ({ action, children, url, environment, token, companyId, enrollmentId, personalData, cardData, bypassAgeValidation, bypassNameMatching, needImmediateResponse, manualReviewRequired, idBackImageRequired, idImageResolutionCheck, verifyIdWithExternalDatabases, deduplicationEnabled, deduplicationSynchronous, geolocationEnabled, geolocationRequired, webhooksEnabled, webhooksClientTraceId, webhooksStripSpecialCharacters, webhooksSendInputImages, webhooksSendProcessedImages, webhooksFireOnReview, precapturedDocuments, documentServiceUrl, onSubmit, onBeforeSubmit, onBeforeLivenessCheck, onResponseReceived, onRequestFailure, }: SubmissionProviderProps) => ReactElement;

package/dist/index.d.ts

@@ -10,6 +10,7 @@ import { preloadModels } from './lib/models/preloadModels';
 import { CustomerBiometricsEnrollment } from './components/customer_flows/CustomerBiometricsEnrollment';
 import { themes } from './themes';
 import { SubmissionRequest, SubmissionResponse } from './contexts/SubmissionContext';
+import { DocumentCapture, DocumentCaptureProps } from './components/customer_flows/DocumentCapture';
 type TargetElement = Element | DocumentFragment | string | undefined;
 export declare const renderIdValidation: (optionsOrTargetElement: TargetElement | IdValidationProps, options?: IdValidationProps) => Element | DocumentFragment;
 export declare const renderFaceValidation: (optionsOrTargetElement: TargetElement | FaceValidationProps, options?: FaceValidationProps) => Element | DocumentFragment;
@@ -20,6 +21,7 @@ export declare const renderCustomerVerification: (optionsOrTargetElement: Target
 export declare const renderCustomerIdentification: (optionsOrTargetElement: TargetElement | CustomerIdentificationProps, options?: CustomerIdentificationProps) => Element | DocumentFragment;
 export declare const renderSignatureKYC: (optionsOrTargetElement: TargetElement | SignatureKYCProps, options?: SignatureKYCProps) => Element | DocumentFragment;
 export declare const renderVideoIdValidation: (optionsOrTargetElement: TargetElement | VideoIdValidationProps, options?: VideoIdValidationProps) => Element | DocumentFragment;
+export declare const renderDocumentCapture: (optionsOrTargetElement: TargetElement | DocumentCaptureProps, options?: DocumentCaptureProps) => Element | DocumentFragment;
 export type IDmissionSDK = {
     renderIdValidation: typeof renderIdValidation;
     renderFaceValidation: typeof renderFaceValidation;
@@ -30,6 +32,7 @@ export type IDmissionSDK = {
     renderCustomerIdentification: typeof renderCustomerIdentification;
     renderSignatureKYC: typeof renderSignatureKYC;
     renderVideoIdValidation: typeof renderVideoIdValidation;
+    renderDocumentCapture: typeof renderDocumentCapture;
     preloadModels: typeof preloadModels;
     themes: typeof themes;
     version: string;
@@ -38,4 +41,4 @@ export type IDmissionSDK = {
 declare global {
     var IDmissionSDK: IDmissionSDK;
 }
-export { preloadModels, themes, IdValidation, FaceValidation, IdAndFaceValidation, CustomerIdAndBiometricsEnrollment, CustomerBiometricsEnrollment, CustomerVerification, CustomerIdentification, SignatureKYC, VideoIdValidation, SubmissionRequest, SubmissionResponse, };
+export { preloadModels, themes, IdValidation, FaceValidation, IdAndFaceValidation, CustomerIdAndBiometricsEnrollment, CustomerBiometricsEnrollment, CustomerVerification, CustomerIdentification, SignatureKYC, VideoIdValidation, DocumentCapture, SubmissionRequest, SubmissionResponse, };