idmission-web-sdk 1.0.78 → 1.0.80

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

@@ -59,6 +59,8 @@ export interface CustomerBiometricsEnrollmentProps extends PropsWithChildren {
     skipSuccessScreen?: boolean | (() => Promise<boolean>);
     /** 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! */
+    onSubmit?: (req: SubmissionRequest) => void;
     /** Callback function that fires when the user has completed the CustomerBiometricsEnrollment flow. Arguments: the SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check, and the request payload dispatched to IDmission's API, which contains the images submitted by the user. */
     onComplete?: (resp: SubmissionResponse, req: SubmissionRequest) => void;
     /** Callback function that fires when the user has completed the CustomerBiometricsEnrollment flow successfully. The SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check. */

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

@@ -94,6 +94,8 @@ export interface CustomerEnrollmentProps extends PropsWithChildren {
     skipSuccessScreen?: boolean | (() => Promise<boolean>);
     /** 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! */
+    onSubmit?: (req: SubmissionRequest) => void;
     /** Callback function that fires when the user has completed the CustomerIdAndBiometricsEnrollment flow. Arguments: the SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check, and the request payload dispatched to IDmission's API, which contains the images submitted by the user. */
     onComplete?: (resp: SubmissionResponse, req: SubmissionRequest) => void;
     /** Callback function that fires when the user has completed the CustomerIdAndBiometricsEnrollment flow successfully. The SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check. */

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

@@ -30,6 +30,8 @@ export interface CustomerIdentificationProps extends PropsWithChildren {
     skipSuccessScreen?: boolean | (() => Promise<boolean>);
     /** 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! */
+    onSubmit?: (req: SubmissionRequest) => void;
     /** Callback function that fires when the user has completed the CustomerIdentification flow. Arguments: the SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check, and the request payload dispatched to IDmission's API, which contains the images submitted by the user. */
     onComplete?: (resp: SubmissionResponse, req: SubmissionRequest) => void;
     /** Callback function that fires when the user has completed the CustomerIdentification flow and matches a pre-registered customer <code>enrollmentId</code> in IDmission's database. The SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check. */

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

@@ -42,6 +42,8 @@ export interface CustomerVerificationProps extends PropsWithChildren {
     verbiage?: CustomerVerificationVerbiage;
     /** 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! */
+    onSubmit?: (req: SubmissionRequest) => void;
     /** Callback function that fires when the user has completed the CustomerVerification flow. Arguments: the SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check, and the request payload dispatched to IDmission's API, which contains the images submitted by the user. */
     onComplete?: (resp: SubmissionResponse, req: SubmissionRequest) => void;
     /** Callback function that fires when the user has completed the CustomerVerification flow and matches the specified customer <code>enrollmentId</code>. The SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check. */

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

@@ -88,6 +88,8 @@ export interface IdAndFaceValidationProps extends PropsWithChildren {
     onBeforeLivenessCheck?: (req: LivenessCheckRequest) => Promise<LivenessCheckRequest>;
     /** 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! */
+    onSubmit?: (req: SubmissionRequest) => void;
     /** Callback function that fires when the user has completed both flows. Arguments: the SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check, and the request payload dispatched to IDmission's API, which contains the images submitted by the user. */
     onComplete?: (resp: SubmissionResponse, req: SubmissionRequest) => void;
     /** Callback function that fires when the user completes both flows with a valid ID and passes the realness check. Arguments: same as `onComplete`. */

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

@@ -72,6 +72,8 @@ export interface IdValidationProps extends PropsWithChildren {
     skipSuccessScreen?: boolean | (() => Promise<boolean>);
     /** 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! */
+    onSubmit?: (req: SubmissionRequest) => void;
     /** Callback function that fires when the user completes the IDValidation flow. Arguments: the SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check, and the request payload dispatched to IDmission's API, which contains the images submitted by the user. */
     onComplete?: (resp: SubmissionResponse, req: SubmissionRequest) => void;
     /** Callback function that fires when the user completes the IDValidation flow with a valid ID. Arguments: same as `onComplete`. */

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

@@ -12,6 +12,8 @@ export interface SignatureKYCProps extends PropsWithChildren {
     submissionUrl?: 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! */
+    onSubmit?: (req: SubmissionRequest) => void;
     /** Callback function that fires when the user completes the SignatureKYC flow. Arguments: the SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check, and the request payload dispatched to IDmission's API, which contains the data submitted by the user. */
     onComplete?: (resp: SubmissionResponse, req: SubmissionRequest) => void;
     /** Boolean or async function to indicate whether to proceed automatically after capture guidance is satisfied. If an async function is supplied returning a boolean, it will be evaluated at the time of capture guidance satisfaction. Defaults to `false`. */

package/dist/components/read_text_prompt/ReadTextPrompt.d.ts

@@ -0,0 +1,23 @@
+import React from 'react';
+import { CustomerSuppliedVerbiage } from '../../lib/locales';
+export type ReadTextPromptClassNames = {
+    container?: string;
+    heading?: string;
+    prompt?: string;
+    buttonsRow?: string;
+    timeRemaining?: string;
+    doneBtn?: string;
+};
+export type ReadTextPromptVerbiage = {
+    headingText?: CustomerSuppliedVerbiage;
+    doneBtnText?: CustomerSuppliedVerbiage;
+};
+export type ReadTextPromptProps = {
+    text: CustomerSuppliedVerbiage;
+    onComplete?: () => void;
+    startedAt?: Date;
+    durationMs?: number;
+    classNames?: ReadTextPromptClassNames;
+    verbiage?: ReadTextPromptVerbiage;
+};
+export declare const ReadTextPrompt: ({ text, onComplete, startedAt, durationMs, classNames, verbiage: rawVerbiage, }: ReadTextPromptProps) => React.JSX.Element;

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

@@ -2,10 +2,16 @@ import { ReactElement } from 'react';
 import { IdVideoCaptureGuidesAssets, IdVideoCaptureGuidesVerbiage } from './IdVideoCaptureGuides';
 import { CustomerSuppliedVerbiage } from '../../lib/locales';
 import { LoaderButtonColors } from '../common/LoaderButton';
+import { ReadTextPromptClassNames, ReadTextPromptVerbiage } from '../read_text_prompt/ReadTextPrompt';
 export type Action = 'SHOW_ID_FRONT' | 'FLIP_ID' | 'SHOW_ID_BACK' | 'READ_TEXT';
 export type IdVideoCaptureAssets = {
     guides?: IdVideoCaptureGuidesAssets;
 };
+export type IdVideoCaptureClassNames = {
+    container?: string;
+    cameraFeed?: string;
+    readTextPrompt?: ReadTextPromptClassNames;
+};
 export type IdVideoCaptureColors = {
     guidesSatisfiedColor?: string;
     guidesUnsatisfiedColor?: string;
@@ -13,8 +19,7 @@ export type IdVideoCaptureColors = {
 };
 export type IdVideoCaptureVerbiage = {
     guides?: IdVideoCaptureGuidesVerbiage;
-    readTextHeading?: CustomerSuppliedVerbiage;
-    readTextDoneBtnText?: CustomerSuppliedVerbiage;
+    readTextPrompt?: ReadTextPromptVerbiage;
 };
 export type IdVideoCaptureProps = {
     onComplete?: (videoUrl: string) => void;
@@ -29,8 +34,9 @@ export type IdVideoCaptureProps = {
     readTextPrompt?: CustomerSuppliedVerbiage;
     readTextTimeoutDurationMs?: number;
     assets?: IdVideoCaptureAssets;
+    classNames?: IdVideoCaptureClassNames;
     colors?: IdVideoCaptureColors;
     verbiage?: IdVideoCaptureVerbiage;
     debugMode?: boolean;
 };
-export declare const IdVideoCapture: ({ onComplete, onIdFrontImageCaptured, onIdBackImageCaptured, onFaceNotDetected, idCardFrontDetectionThreshold, idCardFrontFocusThreshold, goodIdCardFrontFramesThreshold, showIdCardBackDurationMs, skipShowIdCardBack, readTextPrompt, readTextTimeoutDurationMs, assets, colors, verbiage: rawVerbiage, debugMode, }: IdVideoCaptureProps) => ReactElement;
+export declare const IdVideoCapture: ({ onComplete, onIdFrontImageCaptured, onIdBackImageCaptured, onFaceNotDetected, idCardFrontDetectionThreshold, idCardFrontFocusThreshold, goodIdCardFrontFramesThreshold, showIdCardBackDurationMs, skipShowIdCardBack, readTextPrompt, readTextTimeoutDurationMs, assets, classNames, colors, verbiage: rawVerbiage, debugMode, }: IdVideoCaptureProps) => ReactElement;

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

@@ -1,6 +1,16 @@
 import { ReactElement } from 'react';
 import { LoaderButtonColors } from '../common/LoaderButton';
 import { CustomerSuppliedVerbiage } from '../../lib/locales';
+export type IdVideoCaptureSuccessClassNames = {
+    container?: string;
+    inner?: string;
+    heading?: string;
+    videoContainer?: string;
+    video?: string;
+    buttonsRow?: string;
+    retryBtn?: string;
+    doneBtn?: string;
+};
 export type IdVideoCaptureSuccessColors = {
     retryBtn?: LoaderButtonColors;
     doneBtn?: LoaderButtonColors;
@@ -14,7 +24,8 @@ export type IdVideoCaptureSuccessProps = {
     videoUrl: string;
     onDoneClick?: () => void;
     onRetryClick?: () => void;
+    classNames?: IdVideoCaptureSuccessClassNames;
     colors?: IdVideoCaptureSuccessColors;
     verbiage?: IdVideoCaptureSuccessVerbiage;
 };
-export declare const IdVideoCaptureSuccess: ({ videoUrl, onDoneClick, onRetryClick, colors, verbiage: rawVerbiage, }: IdVideoCaptureSuccessProps) => ReactElement;
+export declare const IdVideoCaptureSuccess: ({ videoUrl, onDoneClick, onRetryClick, classNames, colors, verbiage: rawVerbiage, }: IdVideoCaptureSuccessProps) => ReactElement;

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

@@ -1,8 +1,8 @@
 import { ReactElement } from 'react';
 import { IdCaptureWizardAssets, IdCaptureWizardClassNames, IdCaptureWizardColors, IdCaptureWizardProps, IdCaptureWizardVerbiage } from '../id_capture/IdCaptureWizard';
 import { FaceLivenessAssets, FaceLivenessClassNames, FaceLivenessColors, FaceLivenessVerbiage, FaceLivenessWizardProps } from '../face_liveness/FaceLivenessWizard';
-import { IdVideoCaptureAssets, IdVideoCaptureColors, IdVideoCaptureVerbiage } from './IdVideoCapture';
-import { IdVideoCaptureSuccessColors, IdVideoCaptureSuccessVerbiage } from './IdVideoCaptureSuccess';
+import { IdVideoCaptureAssets, IdVideoCaptureClassNames, IdVideoCaptureColors, IdVideoCaptureVerbiage } from './IdVideoCapture';
+import { IdVideoCaptureSuccessClassNames, IdVideoCaptureSuccessColors, IdVideoCaptureSuccessVerbiage } from './IdVideoCaptureSuccess';
 import { CustomerSuppliedVerbiage } from '../../lib/locales';
 import { LivenessCheckRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
 export type VideoIdWizardAssets = {
@@ -13,6 +13,8 @@ export type VideoIdWizardAssets = {
 export type VideoIdWizardClassNames = {
     idCapture?: IdCaptureWizardClassNames;
     faceLiveness?: FaceLivenessClassNames;
+    idVideoCapture?: IdVideoCaptureClassNames;
+    success?: IdVideoCaptureSuccessClassNames;
 };
 export type VideoIdWizardColors = {
     idCapture?: IdCaptureWizardColors;