idmission-web-sdk 1.0.67 → 1.0.68
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/components/customer_flows/CustomerBiometricsEnrollment.d.ts +3 -0
- package/dist/components/customer_flows/CustomerIdAndBiometricsEnrollment.d.ts +3 -0
- package/dist/components/customer_flows/CustomerIdentification.d.ts +3 -0
- package/dist/components/customer_flows/CustomerVerification.d.ts +3 -0
- package/dist/components/customer_flows/FaceValidation.d.ts +3 -0
- package/dist/components/customer_flows/IdAndFaceValidation.d.ts +3 -0
- package/dist/components/customer_flows/IdValidation.d.ts +3 -0
- package/dist/components/customer_flows/SignatureKYC.d.ts +3 -0
- package/dist/components/customer_flows/VideoIdValidation.d.ts +3 -0
- package/dist/index.d.ts +3 -1
- package/dist/sdk2.cjs.development.js +181 -99
- package/dist/sdk2.cjs.development.js.map +1 -1
- package/dist/sdk2.cjs.production.js +1 -1
- package/dist/sdk2.cjs.production.js.map +1 -1
- package/dist/sdk2.esm.js +182 -101
- package/dist/sdk2.esm.js.map +1 -1
- package/dist/sdk2.umd.development.js +181 -99
- package/dist/sdk2.umd.development.js.map +1 -1
- package/dist/sdk2.umd.production.js +1 -1
- package/dist/sdk2.umd.production.js.map +1 -1
- package/dist/stories/{CompositeWizard → Components/CompositeWizard}/FaceLivenessAndIdCapture.stories.d.ts +3 -3
- package/dist/stories/{CompositeWizard → Components/CompositeWizard}/IdCaptureAndFaceLiveness.stories.d.ts +3 -3
- package/dist/stories/{DocumentCaptureGuideOverlay → Components/DocumentCaptureGuideOverlay}/LicenseBack.stories.d.ts +1 -1
- package/dist/stories/{DocumentCaptureGuideOverlay → Components/DocumentCaptureGuideOverlay}/LicenseFront.stories.d.ts +1 -1
- package/dist/stories/{DocumentCaptureGuideOverlay → Components/DocumentCaptureGuideOverlay}/Passport.stories.d.ts +1 -1
- package/dist/stories/{FaceLiveness → Components/FaceLiveness}/Capture.stories.d.ts +1 -1
- package/dist/stories/{FaceLiveness → Components/FaceLiveness}/Wizard.stories.d.ts +1 -1
- package/dist/stories/{FlipIdPrompt.stories.d.ts → Components/FlipIdPrompt.stories.d.ts} +1 -1
- package/dist/stories/{IdCapture → Components/IdCapture}/LicenseBackCapture.stories.d.ts +1 -1
- package/dist/stories/{IdCapture → Components/IdCapture}/LicenseFrontCapture.stories.d.ts +1 -1
- package/dist/stories/{IdCapture → Components/IdCapture}/PassportCapture.stories.d.ts +1 -1
- package/dist/stories/{IdCapture → Components/IdCapture}/Wizard.stories.d.ts +1 -1
- package/dist/stories/{SignatureCapture → Components/SignatureCapture}/VideoSignatureCapture.stories.d.ts +1 -1
- package/dist/stories/CustomerFlows/CustomerBiometricsEnrollment.stories.d.ts +6 -1
- package/dist/stories/CustomerFlows/CustomerIdAndBiometricsEnrollment.stories.d.ts +7 -3
- package/dist/stories/CustomerFlows/CustomerIdentification.stories.d.ts +6 -1
- package/dist/stories/CustomerFlows/CustomerVerification.stories.d.ts +6 -1
- package/dist/stories/CustomerFlows/FaceValidation.stories.d.ts +6 -1
- package/dist/stories/CustomerFlows/IdAndFaceValidation.stories.d.ts +6 -1
- package/dist/stories/CustomerFlows/IdValidation.stories.d.ts +16 -1
- package/dist/stories/CustomerFlows/SignatureKYC.stories.d.ts +6 -1
- package/dist/stories/CustomerFlows/VideoIdValidation.stories.d.ts +5 -0
- package/dist/stories/{BarcodeReader.stories.d.ts → Experiments/BarcodeReader.stories.d.ts} +1 -1
- package/dist/stories/{CameraEnumerationTool.stories.d.ts → Experiments/CameraEnumerationTool.stories.d.ts} +1 -1
- package/dist/stories/{WebSdkExample.stories.d.ts → Experiments/WebSdkExample.stories.d.ts} +1 -1
- package/dist/themes/index.d.ts +23 -0
- package/dist/version.d.ts +1 -1
- package/package.json +1 -1
- /package/dist/stories/{AdditionalDocumentCapture → Components}/AdditionalDocumentCapture.stories.d.ts +0 -0
- /package/dist/stories/{models/HighPerformanceFaceDetectionMinimal.stories.d.ts → Components/HighPerformanceFaceDetection/Minimal.stories.d.ts} +0 -0
- /package/dist/stories/{models/HighPerformanceFaceDetectionOriginal.stories.d.ts → Components/HighPerformanceFaceDetection/Original.stories.d.ts} +0 -0
- /package/dist/stories/{SignatureCapture → Components/SignatureCapture}/SignatureCapture.stories.d.ts +0 -0
- /package/dist/stories/{Camera.stories.d.ts → Experiments/Camera.stories.d.ts} +0 -0
- /package/dist/stories/{FrameLoop.stories.d.ts → Experiments/FrameLoop.stories.d.ts} +0 -0
- /package/dist/stories/{MultiCamera.stories.d.ts → Experiments/MultiCamera.stories.d.ts} +0 -0
- /package/dist/stories/{PlatformDetectionTool.stories.d.ts → Experiments/PlatformDetectionTool.stories.d.ts} +0 -0
- /package/dist/stories/{VideoCapture.stories.d.ts → Experiments/VideoCapture.stories.d.ts} +0 -0
|
@@ -6,6 +6,7 @@ import { AdditionalDocument } from '../additional_document_capture/AdditionalDoc
|
|
|
6
6
|
import { LangOption } from '../../lib/locales';
|
|
7
7
|
import { SignatureCaptureVerbiage } from '../signature_capture/SignatureCapture';
|
|
8
8
|
import { VideoSignatureColors, VideoSignatureVerbiage } from '../video_signature_capture/VideoSignatureWizard';
|
|
9
|
+
import { ThemeInput } from '../../themes';
|
|
9
10
|
export type CustomerBiometricsEnrollmentAssets = {
|
|
10
11
|
faceLiveness?: FaceLivenessAssets;
|
|
11
12
|
};
|
|
@@ -68,6 +69,8 @@ export interface CustomerBiometricsEnrollmentProps extends PropsWithChildren {
|
|
|
68
69
|
captureSignatureVideo?: boolean | (() => Promise<boolean>);
|
|
69
70
|
/** Array of additional documents to be captured. Each element includes a name and description. */
|
|
70
71
|
captureAdditionalDocuments?: AdditionalDocument[];
|
|
72
|
+
/** Name of an included theme or object containing theme properties. **/
|
|
73
|
+
theme?: ThemeInput;
|
|
71
74
|
/** Object containing any asset overrides. */
|
|
72
75
|
assets?: CustomerBiometricsEnrollmentAssets;
|
|
73
76
|
/** Object containing any color overrides. */
|
|
@@ -7,6 +7,7 @@ import { AdditionalDocument } from '../additional_document_capture/AdditionalDoc
|
|
|
7
7
|
import { LangOption } from '../../lib/locales';
|
|
8
8
|
import { SignatureCaptureVerbiage } from '../signature_capture/SignatureCapture';
|
|
9
9
|
import { VideoSignatureColors, VideoSignatureVerbiage } from '../video_signature_capture/VideoSignatureWizard';
|
|
10
|
+
import { ThemeInput } from '../../themes';
|
|
10
11
|
export type CustomerEnrollmentAssets = {
|
|
11
12
|
idCapture?: IdCaptureWizardAssets;
|
|
12
13
|
faceLiveness?: FaceLivenessAssets;
|
|
@@ -100,6 +101,8 @@ export interface CustomerEnrollmentProps extends PropsWithChildren {
|
|
|
100
101
|
captureSignatureVideo?: boolean | (() => Promise<boolean>);
|
|
101
102
|
/** Array of additional documents to be captured. Each element includes a name and description. */
|
|
102
103
|
captureAdditionalDocuments?: AdditionalDocument[];
|
|
104
|
+
/** Name of an included theme or object containing theme properties. **/
|
|
105
|
+
theme?: ThemeInput;
|
|
103
106
|
/** Object containing any asset overrides. */
|
|
104
107
|
assets?: CustomerEnrollmentAssets;
|
|
105
108
|
/** Object containing any color overrides. */
|
|
@@ -2,6 +2,7 @@ import { FC, PropsWithChildren } from 'react';
|
|
|
2
2
|
import { SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
|
|
3
3
|
import { CustomerIdentificationAssets, CustomerIdentificationColors, CustomerIdentificationVerbiage } from '../customer_identification/CustomerIdentificationWizard';
|
|
4
4
|
import { LangOption } from '../../lib/locales';
|
|
5
|
+
import { ThemeInput } from '../../themes';
|
|
5
6
|
export interface CustomerIdentificationProps extends PropsWithChildren {
|
|
6
7
|
/** Language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto. */
|
|
7
8
|
lang?: LangOption;
|
|
@@ -42,6 +43,8 @@ export interface CustomerIdentificationProps extends PropsWithChildren {
|
|
|
42
43
|
onExitCapture?: () => void;
|
|
43
44
|
/** Callback function that fires when the user clicks the exit button after failing the realness check. */
|
|
44
45
|
onExitAfterFailure?: () => void;
|
|
46
|
+
/** Name of an included theme or object containing theme properties. **/
|
|
47
|
+
theme?: ThemeInput;
|
|
45
48
|
/** Object containing any asset overrides. */
|
|
46
49
|
assets?: CustomerIdentificationAssets;
|
|
47
50
|
/** Object containing any color overrides. */
|
|
@@ -2,6 +2,7 @@ import { FC, PropsWithChildren } from 'react';
|
|
|
2
2
|
import { SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
|
|
3
3
|
import { LangOption } from '../../lib/locales';
|
|
4
4
|
import { CustomerVerificationAssets, CustomerVerificationColors, CustomerVerificationVerbiage } from '../customer_verification/CustomerVerificationWizard';
|
|
5
|
+
import { ThemeInput } from '../../themes';
|
|
5
6
|
export interface CustomerVerificationProps extends PropsWithChildren {
|
|
6
7
|
/** The unique identifier to match from previously enrolled customers. */
|
|
7
8
|
enrollmentId: string;
|
|
@@ -29,6 +30,8 @@ export interface CustomerVerificationProps extends PropsWithChildren {
|
|
|
29
30
|
timeoutDurationMs?: number;
|
|
30
31
|
/** 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`. */
|
|
31
32
|
skipSuccessScreen?: boolean | (() => Promise<boolean>);
|
|
33
|
+
/** Name of an included theme or object containing theme properties. **/
|
|
34
|
+
theme?: ThemeInput;
|
|
32
35
|
/** Object containing any asset overrides. */
|
|
33
36
|
assets?: CustomerVerificationAssets;
|
|
34
37
|
/** Object containing any color overrides. */
|
|
@@ -2,6 +2,7 @@ import { FC, PropsWithChildren } from 'react';
|
|
|
2
2
|
import { LivenessCheckRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
|
|
3
3
|
import { FaceLivenessAssets, FaceLivenessColors, FaceLivenessVerbiage } from '../face_liveness/FaceLivenessWizard';
|
|
4
4
|
import { LangOption } from '../../lib/locales';
|
|
5
|
+
import { ThemeInput } from '../../themes';
|
|
5
6
|
export interface FaceValidationProps extends PropsWithChildren {
|
|
6
7
|
/** Language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto. */
|
|
7
8
|
lang?: LangOption;
|
|
@@ -39,6 +40,8 @@ export interface FaceValidationProps extends PropsWithChildren {
|
|
|
39
40
|
onExitCapture?: () => void;
|
|
40
41
|
/** Callback function that fires when the user clicks the exit button after completing the FaceValidation flow and failing the realness check. */
|
|
41
42
|
onExitAfterFailure?: () => void;
|
|
43
|
+
/** Name of an included theme or object containing theme properties. **/
|
|
44
|
+
theme?: ThemeInput;
|
|
42
45
|
/** Object containing any asset overrides. */
|
|
43
46
|
assets?: FaceLivenessAssets;
|
|
44
47
|
/** Object containing any color overrides. */
|
|
@@ -7,6 +7,7 @@ import { AdditionalDocument } from '../additional_document_capture/AdditionalDoc
|
|
|
7
7
|
import { LangOption } from '../../lib/locales';
|
|
8
8
|
import { SignatureCaptureVerbiage } from '../signature_capture/SignatureCapture';
|
|
9
9
|
import { VideoSignatureColors, VideoSignatureVerbiage } from '../video_signature_capture/VideoSignatureWizard';
|
|
10
|
+
import { ThemeInput } from '../../themes';
|
|
10
11
|
export type IdAndFaceValidationAssets = {
|
|
11
12
|
idCapture?: IdCaptureWizardAssets;
|
|
12
13
|
faceLiveness?: FaceLivenessAssets;
|
|
@@ -94,6 +95,8 @@ export interface IdAndFaceValidationProps extends PropsWithChildren {
|
|
|
94
95
|
captureSignatureVideo?: boolean | (() => Promise<boolean>);
|
|
95
96
|
/** Array of additional documents to be captured. Each element includes a name and description. */
|
|
96
97
|
captureAdditionalDocuments?: AdditionalDocument[];
|
|
98
|
+
/** Name of an included theme or object containing theme properties. **/
|
|
99
|
+
theme?: ThemeInput;
|
|
97
100
|
/** Object containing any asset overrides. */
|
|
98
101
|
assets?: IdAndFaceValidationAssets;
|
|
99
102
|
/** Object containing any color overrides. */
|
|
@@ -6,6 +6,7 @@ import { AdditionalDocument } from '../additional_document_capture/AdditionalDoc
|
|
|
6
6
|
import { LangOption } from '../../lib/locales';
|
|
7
7
|
import { SignatureCaptureVerbiage } from '../signature_capture/SignatureCapture';
|
|
8
8
|
import { VideoSignatureColors, VideoSignatureVerbiage } from '../video_signature_capture/VideoSignatureWizard';
|
|
9
|
+
import { ThemeInput } from '../../themes';
|
|
9
10
|
export type IdValidationAssets = IdCaptureWizardAssets;
|
|
10
11
|
export type IdValidationColors = IdCaptureWizardColors & {
|
|
11
12
|
videoSignatureCapture?: VideoSignatureColors;
|
|
@@ -78,6 +79,8 @@ export interface IdValidationProps extends PropsWithChildren {
|
|
|
78
79
|
captureSignatureVideo?: boolean | (() => Promise<boolean>);
|
|
79
80
|
/** Array of additional documents to be captured. Each element includes a name and description. */
|
|
80
81
|
captureAdditionalDocuments?: AdditionalDocument[];
|
|
82
|
+
/** Name of an included theme or object containing theme properties. **/
|
|
83
|
+
theme?: ThemeInput;
|
|
81
84
|
/** Object containing any asset overrides. */
|
|
82
85
|
assets?: IdValidationAssets;
|
|
83
86
|
/** Object containing any color overrides. */
|
|
@@ -2,6 +2,7 @@ import { FC, PropsWithChildren } from 'react';
|
|
|
2
2
|
import { LangOption } from '../../lib/locales';
|
|
3
3
|
import { SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
|
|
4
4
|
import { VideoSignatureColors, VideoSignatureVerbiage } from '../video_signature_capture/VideoSignatureWizard';
|
|
5
|
+
import { ThemeInput } from '../../themes';
|
|
5
6
|
export interface SignatureKYCProps extends PropsWithChildren {
|
|
6
7
|
/** Language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto. */
|
|
7
8
|
lang?: LangOption;
|
|
@@ -15,6 +16,8 @@ export interface SignatureKYCProps extends PropsWithChildren {
|
|
|
15
16
|
onComplete?: (resp: SubmissionResponse, req: SubmissionRequest) => void;
|
|
16
17
|
/** 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`. */
|
|
17
18
|
skipSuccessScreen?: boolean | (() => Promise<boolean>);
|
|
19
|
+
/** Name of an included theme or object containing theme properties. **/
|
|
20
|
+
theme?: ThemeInput;
|
|
18
21
|
/** Object containing any color overrides. */
|
|
19
22
|
colors?: VideoSignatureColors;
|
|
20
23
|
/** Object containing any verbiage overrides. */
|
|
@@ -4,6 +4,7 @@ import { CustomerSuppliedVerbiage, LangOption } from '../../lib/locales';
|
|
|
4
4
|
import { VideoIdWizardAssets, VideoIdWizardColors, VideoIdWizardVerbiage } from '../video_id/IdVideoCaptureWizard';
|
|
5
5
|
import { IdCaptureWizardProps } from '../id_capture/IdCaptureWizard';
|
|
6
6
|
import { FaceLivenessWizardProps } from '../face_liveness/FaceLivenessWizard';
|
|
7
|
+
import { ThemeInput } from '../../themes';
|
|
7
8
|
export type VideoIdValidationAssets = VideoIdWizardAssets;
|
|
8
9
|
export type VideoIdValidationColors = VideoIdWizardColors;
|
|
9
10
|
export type VideoIdValidationVerbiage = VideoIdWizardVerbiage;
|
|
@@ -74,6 +75,8 @@ export interface VideoIdValidationProps extends PropsWithChildren {
|
|
|
74
75
|
skipIdCapture?: boolean;
|
|
75
76
|
/** Boolean or async function to indicate whether to instruct the user to show the back of their ID card during video capture. If an async function is supplied returning a boolean, it will be evaluated at the time of ID front video capture completion. Defaults to `false`. */
|
|
76
77
|
skipShowIdCardBack?: boolean | (() => Promise<boolean>);
|
|
78
|
+
/** Name of an included theme or object containing theme properties. **/
|
|
79
|
+
theme?: ThemeInput;
|
|
77
80
|
/** Object containing any asset overrides. */
|
|
78
81
|
assets?: VideoIdValidationAssets;
|
|
79
82
|
/** Object containing any color overrides. */
|
package/dist/index.d.ts
CHANGED
|
@@ -8,6 +8,7 @@ import { SignatureKYC, SignatureKYCProps } from './components/customer_flows/Sig
|
|
|
8
8
|
import { VideoIdValidation, VideoIdValidationProps } from './components/customer_flows/VideoIdValidation';
|
|
9
9
|
import { preloadModels } from './lib/models/preloadModels';
|
|
10
10
|
import { CustomerBiometricsEnrollment } from './components/customer_flows/CustomerBiometricsEnrollment';
|
|
11
|
+
import { themes } from './themes';
|
|
11
12
|
type TargetElement = Element | DocumentFragment | string | undefined;
|
|
12
13
|
export declare const renderIdValidation: (optionsOrTargetElement: TargetElement | IdValidationProps, options?: IdValidationProps) => Element | DocumentFragment;
|
|
13
14
|
export declare const renderFaceValidation: (optionsOrTargetElement: TargetElement | FaceValidationProps, options?: FaceValidationProps) => Element | DocumentFragment;
|
|
@@ -29,10 +30,11 @@ export type IDmissionSDK = {
|
|
|
29
30
|
renderSignatureKYC: typeof renderSignatureKYC;
|
|
30
31
|
renderVideoIdValidation: typeof renderVideoIdValidation;
|
|
31
32
|
preloadModels: typeof preloadModels;
|
|
33
|
+
themes: typeof themes;
|
|
32
34
|
version: string;
|
|
33
35
|
ready: boolean;
|
|
34
36
|
};
|
|
35
37
|
declare global {
|
|
36
38
|
var IDmissionSDK: IDmissionSDK;
|
|
37
39
|
}
|
|
38
|
-
export { preloadModels, IdValidation, FaceValidation, IdAndFaceValidation, CustomerIdAndBiometricsEnrollment, CustomerBiometricsEnrollment, CustomerVerification, CustomerIdentification, SignatureKYC, VideoIdValidation, };
|
|
40
|
+
export { preloadModels, themes, IdValidation, FaceValidation, IdAndFaceValidation, CustomerIdAndBiometricsEnrollment, CustomerBiometricsEnrollment, CustomerVerification, CustomerIdentification, SignatureKYC, VideoIdValidation, };
|