idmission-web-sdk 2.1.43 → 2.1.45

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.
Files changed (36) hide show
  1. package/dist/components/common/LoaderButton.d.ts +1 -1
  2. package/dist/components/face_liveness/FaceCaptureGuideOverlay.d.ts +6 -2
  3. package/dist/components/face_liveness/FaceLivenessCapture.d.ts +8 -2
  4. package/dist/components/face_liveness/FaceLivenessFailure.d.ts +2 -1
  5. package/dist/components/face_liveness/FaceLivenessWizard.d.ts +6 -2
  6. package/dist/components/id_capture/FlipIdPrompt.d.ts +15 -18
  7. package/dist/components/id_capture/IdCaptureFitGuide.d.ts +10 -6
  8. package/dist/components/id_capture/IdCaptureGuideOverlay.d.ts +48 -32
  9. package/dist/components/id_capture/IdCaptureGuides.d.ts +14 -7
  10. package/dist/components/id_capture/IdCaptureWizard.d.ts +4 -4
  11. package/dist/components/id_capture/ScalingCameraFeed.d.ts +2 -0
  12. package/dist/components/selfie_capture/SelfieCapture.d.ts +8 -3
  13. package/dist/components/selfie_capture/SelfieCaptureLoadingGraphic.d.ts +14 -1
  14. package/dist/components/selfie_capture/SelfieGuidanceModelsProvider.d.ts +2 -2
  15. package/dist/components/video_id/IdVideoCaptureFlipIdPrompt.d.ts +25 -6
  16. package/dist/components/video_id/IdVideoCaptureGuides.d.ts +12 -3
  17. package/dist/components/video_id/IdVideoCaptureGuidesCommon.d.ts +23 -0
  18. package/dist/components/video_signature_capture/VideoSignatureCapture.d.ts +4 -10
  19. package/dist/components/video_signature_capture/VideoSignatureContext.d.ts +18 -0
  20. package/dist/components/video_signature_capture/VideoSignatureGuides.d.ts +28 -0
  21. package/dist/components/video_signature_capture/VideoSignatureSuccess.d.ts +1 -2
  22. package/dist/lib/locales/es/translation.d.ts +2 -0
  23. package/dist/lib/locales/index.d.ts +2 -0
  24. package/dist/sdk2.cjs.development.js +2830 -1993
  25. package/dist/sdk2.cjs.development.js.map +1 -1
  26. package/dist/sdk2.cjs.production.js +1 -1
  27. package/dist/sdk2.cjs.production.js.map +1 -1
  28. package/dist/sdk2.esm.js +2830 -1993
  29. package/dist/sdk2.esm.js.map +1 -1
  30. package/dist/sdk2.umd.development.js +2831 -1994
  31. package/dist/sdk2.umd.development.js.map +1 -1
  32. package/dist/sdk2.umd.production.js +1 -1
  33. package/dist/sdk2.umd.production.js.map +1 -1
  34. package/dist/themes/index.d.ts +11 -0
  35. package/dist/version.d.ts +1 -1
  36. package/package.json +1 -1
@@ -1,5 +1,5 @@
1
1
  import React, { CSSProperties, ReactNode } from 'react';
2
- export type LoaderButtonVariant = 'primary' | 'secondary' | 'positive' | 'negative' | 'warning';
2
+ export type LoaderButtonVariant = 'primary' | 'secondary' | 'positive' | 'negative' | 'warning' | 'outline';
3
3
  export type LoaderButtonColors = {
4
4
  backgroundColor?: string;
5
5
  textColor?: string;
@@ -1,13 +1,17 @@
1
- import { ReactElement } from 'react';
1
+ import React, { ReactElement } from 'react';
2
2
  export type FaceCaptureGuideOverlayVariant = 'satisfied' | 'unsatisfied';
3
+ export declare const FaceCaptureGuideContainer: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, never>> & string;
3
4
  export type FaceCaptureGuideOverlayClassNames = {
4
5
  container?: string;
5
6
  oval?: string;
6
7
  };
8
+ export type FaceGuideStatus = 'ready' | 'processing' | 'success' | 'failure';
7
9
  export type FaceCaptureGuideOverlayProps = {
8
10
  classNames?: FaceCaptureGuideOverlayClassNames;
9
11
  variant?: FaceCaptureGuideOverlayVariant;
12
+ status?: FaceGuideStatus;
10
13
  borderWidth?: number;
11
14
  borderColor?: string;
15
+ borderOpacity?: number;
12
16
  };
13
- export declare const FaceCaptureGuideOverlay: ({ classNames, variant, borderWidth, borderColor, }: FaceCaptureGuideOverlayProps) => ReactElement;
17
+ export declare const FaceCaptureGuideOverlay: ({ classNames, status, borderWidth, borderColor, borderOpacity, }: FaceCaptureGuideOverlayProps) => ReactElement;
@@ -1,7 +1,8 @@
1
- import { ReactElement } from 'react';
1
+ import { ComponentType, ReactElement } from 'react';
2
2
  import { SelfieCaptureClassNames, SelfieCaptureColors, SelfieCaptureVerbiage } from '../selfie_capture/SelfieCapture';
3
3
  import { SelfieProgressPreviewClassNames } from '../common/SelfieProgressPreview';
4
4
  import { CustomerSuppliedVerbiage } from '../../lib/locales';
5
+ import { FaceCaptureGuideOverlayProps } from './FaceCaptureGuideOverlay';
5
6
  export type FaceLivenessCaptureClassNames = SelfieCaptureClassNames & {
6
7
  imagePreview?: SelfieProgressPreviewClassNames;
7
8
  };
@@ -11,6 +12,8 @@ export type FaceLivenessCaptureVerbiage = SelfieCaptureVerbiage & {
11
12
  guidanceRemoveHeadCoveringsText?: CustomerSuppliedVerbiage;
12
13
  guidanceRemoveMaskText?: CustomerSuppliedVerbiage;
13
14
  progressPreviewText?: CustomerSuppliedVerbiage;
15
+ guidanceLivenessCheckFailedText?: CustomerSuppliedVerbiage;
16
+ guidanceLivenessCheckErrorText?: CustomerSuppliedVerbiage;
14
17
  };
15
18
  export type FaceLivenessCaptureProps = {
16
19
  onCapture?: () => void;
@@ -19,9 +22,12 @@ export type FaceLivenessCaptureProps = {
19
22
  onExit?: () => void;
20
23
  timeoutDurationMs?: number;
21
24
  silentFallback?: boolean;
25
+ guidesComponent?: ComponentType<FaceCaptureGuideOverlayProps>;
26
+ disableCapturePreview?: boolean;
27
+ requireVerticalFaceCentering?: boolean;
22
28
  classNames?: FaceLivenessCaptureClassNames;
23
29
  colors?: FaceLivenessCaptureColors;
24
30
  verbiage?: FaceLivenessCaptureVerbiage;
25
31
  debugMode?: boolean;
26
32
  };
27
- export declare const FaceLivenessCapture: ({ onCapture, onSuccess, onTimeout, onExit, timeoutDurationMs, silentFallback, classNames, colors, verbiage: rawVerbiage, debugMode, }: FaceLivenessCaptureProps) => ReactElement;
33
+ export declare const FaceLivenessCapture: ({ onCapture, onSuccess, onTimeout, onExit, timeoutDurationMs, silentFallback, guidesComponent, disableCapturePreview, requireVerticalFaceCentering, classNames, colors, verbiage: rawVerbiage, debugMode, }: FaceLivenessCaptureProps) => ReactElement;
@@ -1,4 +1,4 @@
1
- import { ReactElement } from 'react';
1
+ import React, { ReactElement } from 'react';
2
2
  import { LoaderButtonColors } from '../common/LoaderButton';
3
3
  import { CustomerSuppliedVerbiage } from '../../lib/locales';
4
4
  export type FaceLivenessFailureAssets = {
@@ -33,3 +33,4 @@ export type FaceLivenessFailureProps = {
33
33
  verbiage?: FaceLivenessFailureVerbiage;
34
34
  };
35
35
  export declare const FaceLivenessFailure: ({ canRetry, onRetryClick, onExitClick, assets, classNames, colors, verbiage: rawVerbiage, }: FaceLivenessFailureProps) => ReactElement;
36
+ export declare const ButtonsRow: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, never>> & string;
@@ -1,9 +1,10 @@
1
- import { ReactElement } from 'react';
1
+ import { ComponentType, ReactElement } from 'react';
2
2
  import { FaceLivenessCaptureClassNames, FaceLivenessCaptureColors, FaceLivenessCaptureVerbiage } from './FaceLivenessCapture';
3
3
  import { FaceLivenessSuccessClassNames, FaceLivenessSuccessColors, FaceLivenessSuccessVerbiage } from './FaceLivenessSuccess';
4
4
  import { FaceLivenessFailureAssets, FaceLivenessFailureClassNames, FaceLivenessFailureColors, FaceLivenessFailureVerbiage } from './FaceLivenessFailure';
5
5
  import { LivenessCheckRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
6
6
  import { SelfieCaptureLoadingOverlayMode, SelfieCaptureLoadingOverlayAssets, SelfieCaptureLoadingOverlayClassNames, SelfieCaptureLoadingOverlayColors, SelfieCaptureLoadingOverlayVerbiage } from '../selfie_capture/SelfieCaptureLoadingOverlay';
7
+ import { FaceCaptureGuideOverlayProps } from './FaceCaptureGuideOverlay';
7
8
  export type FaceLivenessAssets = {
8
9
  loadingOverlay?: SelfieCaptureLoadingOverlayAssets;
9
10
  failure?: FaceLivenessFailureAssets;
@@ -40,10 +41,13 @@ export type FaceLivenessWizardProps = {
40
41
  renderCameraFeed?: boolean;
41
42
  releaseCameraAccessOnExit?: boolean;
42
43
  silentFallback?: boolean;
44
+ guidesComponent?: ComponentType<FaceCaptureGuideOverlayProps>;
45
+ disableCapturePreview?: boolean;
46
+ requireVerticalFaceCentering?: boolean;
43
47
  assets?: FaceLivenessAssets;
44
48
  classNames?: FaceLivenessClassNames;
45
49
  colors?: FaceLivenessColors;
46
50
  verbiage?: FaceLivenessVerbiage;
47
51
  debugMode?: boolean;
48
52
  };
49
- export declare const FaceLivenessWizard: ({ onComplete, onSuccess, onTimeout, onExitCapture, onExitAfterFailure, onUserCancel, loadingOverlayMode, timeoutDurationMs, maxRetries, skipSuccessScreen, renderCameraFeed, releaseCameraAccessOnExit, silentFallback, assets, classNames, colors, verbiage, debugMode, }: FaceLivenessWizardProps) => ReactElement;
53
+ export declare const FaceLivenessWizard: ({ onComplete, onSuccess, onTimeout, onExitCapture, onExitAfterFailure, onUserCancel, loadingOverlayMode, timeoutDurationMs, maxRetries, skipSuccessScreen, renderCameraFeed, releaseCameraAccessOnExit, silentFallback, guidesComponent, disableCapturePreview, requireVerticalFaceCentering, assets, classNames, colors, verbiage, debugMode, }: FaceLivenessWizardProps) => ReactElement;
@@ -1,35 +1,32 @@
1
1
  import { ReactElement } from 'react';
2
2
  import { CustomerSuppliedVerbiage } from '../../lib/locales';
3
3
  export type FlipIdPromptAssets = {
4
- frontPortraitGuidesImageUrl?: string;
5
- frontLandscapeGuidesImageUrl?: string;
6
- backPortraitGuidesImageUrl?: string;
7
- backLandscapeGuidesImageUrl?: string;
4
+ idCardFrontPortraitImageUrl?: string;
5
+ idCardFrontLandscapeImageUrl?: string;
6
+ idCardBackPortraitImageUrl?: string;
7
+ idCardBackLandscapeImageUrl?: string;
8
8
  };
9
9
  export type FlipIdPromptClassNames = {
10
- container?: string;
11
- inner?: string;
12
- dimmingRegion?: string;
13
- dimmingRegionTop?: string;
14
- dimmingRegionLeft?: string;
15
- dimmingRegionRight?: string;
16
- dimmingRegionBottom?: string;
17
- centerRow?: string;
18
- centerRegion?: string;
19
- image?: string;
20
- guideText?: string;
10
+ frontImageContainer?: string;
11
+ backImageContainer?: string;
12
+ frontImage?: string;
13
+ backImage?: string;
21
14
  };
22
15
  export type FlipIdPromptVerbiage = {
23
16
  instructionText?: CustomerSuppliedVerbiage;
24
17
  };
25
18
  export type FlipIdPromptProps = {
19
+ width?: number;
20
+ height?: number;
26
21
  padding?: number;
27
22
  imagePadding?: number;
28
- borderWidth?: number;
23
+ borderWidth?: number | string;
29
24
  borderColor?: string;
30
- maskColor?: string;
25
+ borderRadius?: number;
26
+ isMirrored?: boolean;
27
+ portraitGuidesOnMobile?: boolean;
31
28
  assets?: FlipIdPromptAssets;
32
29
  classNames?: FlipIdPromptClassNames;
33
30
  verbiage?: FlipIdPromptVerbiage;
34
31
  };
35
- export declare const FlipIdPrompt: ({ padding: userSuppliedPadding, imagePadding: userSuppliedImagePadding, borderWidth, borderColor, maskColor, assets, classNames, verbiage, }: FlipIdPromptProps) => ReactElement;
32
+ export declare const FlipIdPrompt: ({ width, height, borderWidth, borderColor, borderRadius, isMirrored, portraitGuidesOnMobile, assets, classNames, }: FlipIdPromptProps) => ReactElement;
@@ -1,5 +1,7 @@
1
1
  import React from 'react';
2
- import { IdCaptureGuideOverlayClassNames } from './IdCaptureGuideOverlay';
2
+ import { IdCaptureGuideAction, IdCaptureGuideOverlayAssets, IdCaptureGuideOverlayClassNames } from './IdCaptureGuideOverlay';
3
+ import { IdCardGuideStatus } from '../video_id/IdVideoCaptureGuidesCommon';
4
+ export type IdCaptureFitGuideAssets = IdCaptureGuideOverlayAssets;
3
5
  export type IdCaptureFitGuideClassNames = IdCaptureGuideOverlayClassNames & {
4
6
  canvasWrapper?: string;
5
7
  canvas?: string;
@@ -11,13 +13,15 @@ export type IdCaptureFitGuideProps = {
11
13
  borderColor?: string;
12
14
  borderWidth?: number;
13
15
  padding?: number;
14
- imageUrl?: string;
15
16
  imageVisible?: boolean;
16
- frontImageUrl?: string;
17
- backImageUrl?: string;
18
17
  isMirrored?: boolean;
18
+ isBackToFront?: boolean;
19
+ portraitGuidesOnMobile?: boolean;
19
20
  instruction?: string;
20
- requestingFlip?: boolean;
21
+ requestedAction?: IdCaptureGuideAction;
22
+ status?: IdCardGuideStatus;
23
+ progress?: number;
24
+ assets?: IdCaptureFitGuideAssets;
21
25
  classNames?: IdCaptureFitGuideClassNames;
22
26
  };
23
- export declare const IdCaptureFitGuide: ({ aspectRatio, maskColor, borderRadius, borderColor, borderWidth, padding, imageUrl, imageVisible, frontImageUrl, backImageUrl, isMirrored, instruction, requestingFlip, classNames, }: IdCaptureFitGuideProps) => React.JSX.Element;
27
+ export declare const IdCaptureFitGuide: ({ aspectRatio, maskColor, borderRadius, borderColor, borderWidth, padding, imageVisible, isMirrored, isBackToFront, portraitGuidesOnMobile, instruction, requestedAction, status, progress, assets, classNames, }: IdCaptureFitGuideProps) => React.JSX.Element;
@@ -1,33 +1,15 @@
1
1
  import React, { ReactElement } from 'react';
2
- export declare const GuidesContainer: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, never>> & string;
3
- export declare const GuideCenterRow: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, never>> & string;
4
- export declare const GuideRegion: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components/dist/types").Substitute<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {
5
- $minWidth?: number;
6
- $minHeight?: number;
7
- $maskColor?: string;
8
- }>> & string;
9
- export declare const Spacer: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<Omit<import("styled-components").FastOmit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "$minWidth" | "$minHeight" | "$maskColor"> & {
10
- $minWidth?: number;
11
- $minHeight?: number;
12
- $maskColor?: string;
13
- }, "ref"> & {
14
- ref?: ((instance: HTMLDivElement | null) => void | React.DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES[keyof React.DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES]) | React.RefObject<HTMLDivElement> | null | undefined;
15
- }, never>> & string;
16
- export declare const GuideCenterRegion: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components/dist/types").Substitute<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {
17
- $minWidth?: number;
18
- $isMirrored?: boolean;
19
- }>> & string;
20
- export declare const GuideCenterBorder: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components/dist/types").Substitute<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {
21
- $borderWidth: number;
22
- $borderColor?: string;
23
- }>> & string;
24
- export declare const GuideText: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLSpanElement>, HTMLSpanElement>, never>> & string;
25
- export declare const GuideImage: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components/dist/types").Substitute<React.DetailedHTMLProps<React.ImgHTMLAttributes<HTMLImageElement>, HTMLImageElement>, {
26
- $width?: number;
27
- $height?: number;
28
- $padding: number;
29
- $visible?: boolean;
30
- }>> & string;
2
+ import { IdCardGuideStatus } from '../video_id/IdVideoCaptureGuidesCommon';
3
+ import { FlipIdPromptAssets, FlipIdPromptClassNames } from './FlipIdPrompt';
4
+ export type IdCaptureGuideOverlayAssets = {
5
+ idCardFrontPortraitImageUrl?: string;
6
+ idCardFrontLandscapeImageUrl?: string;
7
+ idCardBackPortraitImageUrl?: string;
8
+ idCardBackLandscapeImageUrl?: string;
9
+ passportPortraitImageUrl?: string;
10
+ passportLandscapeImageUrl?: string;
11
+ flipIdPrompt?: FlipIdPromptAssets;
12
+ };
31
13
  export type IdCaptureGuideOverlayClassNames = {
32
14
  container?: string;
33
15
  inner?: string;
@@ -38,11 +20,14 @@ export type IdCaptureGuideOverlayClassNames = {
38
20
  dimmingRegionBottom?: string;
39
21
  centerRow?: string;
40
22
  centerRegion?: string;
23
+ centerRegionBorder?: string;
41
24
  centerRegionInner?: string;
42
25
  image?: string;
43
26
  guideText?: string;
27
+ flipIdPrompt?: FlipIdPromptClassNames;
44
28
  };
45
29
  export type IdCaptureGuideOverlayProps = {
30
+ assets?: IdCaptureGuideOverlayAssets;
46
31
  classNames?: IdCaptureGuideOverlayClassNames;
47
32
  width?: number;
48
33
  height?: number;
@@ -51,11 +36,42 @@ export type IdCaptureGuideOverlayProps = {
51
36
  imageVisible?: boolean;
52
37
  borderWidth?: number;
53
38
  borderColor?: string;
39
+ idCardBorderWidth?: number | string;
40
+ idCardBorderColor?: string;
54
41
  maskColor?: string;
55
42
  isMirrored?: boolean;
43
+ isBackToFront?: boolean;
44
+ portraitGuidesOnMobile?: boolean;
56
45
  instruction?: string;
57
- portraitGuidesImageUrl?: string;
58
- landscapeGuidesImageUrl?: string;
46
+ requestedAction?: IdCaptureGuideAction;
47
+ status?: IdCardGuideStatus;
48
+ progress?: number;
59
49
  onClick?: () => void;
60
50
  };
61
- export declare const IdCaptureGuideOverlay: ({ classNames, width, height, padding: userSuppliedPadding, imagePadding: userSuppliedImagePadding, imageVisible, borderWidth, borderColor, maskColor, isMirrored, instruction, portraitGuidesImageUrl, landscapeGuidesImageUrl, onClick, }: IdCaptureGuideOverlayProps) => ReactElement;
51
+ export type IdCaptureGuideAction = 'SHOW_ID_FRONT' | 'FLIP_ID' | 'SHOW_ID_BACK' | 'SHOW_PASSPORT';
52
+ export declare const IdCaptureGuideOverlay: ({ assets, classNames, width, height, padding: userSuppliedPadding, imagePadding: userSuppliedImagePadding, imageVisible, borderWidth, borderColor, idCardBorderWidth, idCardBorderColor, maskColor, isMirrored, isBackToFront, portraitGuidesOnMobile, instruction, requestedAction, progress, status, onClick, }: IdCaptureGuideOverlayProps) => ReactElement;
53
+ export declare const GuidesContainer: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, never>> & string;
54
+ export declare const GuideCenterRow: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, never>> & string;
55
+ export declare const GuideRegion: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components/dist/types").Substitute<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {
56
+ $minWidth?: number;
57
+ $minHeight?: number;
58
+ $maskColor?: string;
59
+ }>> & string;
60
+ export declare const Spacer: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<Omit<import("styled-components").FastOmit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "$minWidth" | "$minHeight" | "$maskColor"> & {
61
+ $minWidth?: number;
62
+ $minHeight?: number;
63
+ $maskColor?: string;
64
+ }, "ref"> & {
65
+ ref?: ((instance: HTMLDivElement | null) => void | React.DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES[keyof React.DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES]) | React.RefObject<HTMLDivElement> | null | undefined;
66
+ }, never>> & string;
67
+ export declare const GuideCenterRegion: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components/dist/types").Substitute<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {
68
+ $minWidth?: number;
69
+ $isMirrored?: boolean;
70
+ }>> & string;
71
+ export declare const GuideCenterBorder: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components/dist/types").Substitute<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {
72
+ $borderWidth: number;
73
+ $borderColor?: string;
74
+ $padding?: number;
75
+ }>> & string;
76
+ export declare const GuideText: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLSpanElement>, HTMLSpanElement>, never>> & string;
77
+ export declare const GuideCenterInner: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, never>> & string;
@@ -1,16 +1,23 @@
1
- import { IdCaptureFitGuideClassNames } from './IdCaptureFitGuide';
1
+ import { IdCaptureFitGuideAssets, IdCaptureFitGuideClassNames } from './IdCaptureFitGuide';
2
2
  import React from 'react';
3
- import { IdCaptureAssets, IdCaptureColors, IdCaptureVerbiage } from './IdCapture';
3
+ import { IdCaptureGuideAction } from './IdCaptureGuideOverlay';
4
+ import { IdCaptureColors, IdCaptureVerbiage } from './IdCapture';
4
5
  import { FlipIdPromptAssets } from './FlipIdPrompt';
6
+ import { IdCardGuideStatus } from '../video_id/IdVideoCaptureGuidesCommon';
7
+ export type IdCaptureGuidesAssets = IdCaptureFitGuideAssets;
8
+ export type IdCaptureGuidesClassNames = IdCaptureFitGuideClassNames;
5
9
  export type IdCaptureGuideType = 'fit' | 'overlay';
6
- export declare function IdCaptureGuides({ guideType, portraitGuidesOnMobile, requestingFlip, isBackToFront, flipIdPromptAssets, classNames, assets, colors, verbiage: rawVerbiage, }: {
10
+ export type IdCaptureGuidesProps = {
7
11
  guideType?: IdCaptureGuideType;
12
+ status?: IdCardGuideStatus;
13
+ progress?: number;
8
14
  portraitGuidesOnMobile?: boolean;
9
- requestingFlip?: boolean;
15
+ requestedAction?: IdCaptureGuideAction;
10
16
  isBackToFront?: boolean;
11
17
  flipIdPromptAssets?: FlipIdPromptAssets;
12
- classNames?: IdCaptureFitGuideClassNames;
13
- assets?: IdCaptureAssets;
18
+ assets?: IdCaptureGuidesAssets;
19
+ classNames?: IdCaptureGuidesClassNames;
14
20
  colors?: IdCaptureColors;
15
21
  verbiage?: IdCaptureVerbiage;
16
- }): React.JSX.Element;
22
+ };
23
+ export declare function IdCaptureGuides({ guideType, status, progress, portraitGuidesOnMobile, requestedAction, isBackToFront, assets, classNames, colors, verbiage: rawVerbiage, }: IdCaptureGuidesProps): React.JSX.Element;
@@ -1,28 +1,28 @@
1
1
  import { ReactElement, ReactNode } from 'react';
2
2
  import { IdCaptureAssets, IdCaptureClassNames, IdCaptureColors, IdCaptureVerbiage } from './IdCapture';
3
3
  import { IdCaptureLoadingOverlayAssets, IdCaptureLoadingOverlayClassNames, IdCaptureLoadingOverlayColors, IdCaptureLoadingOverlayMode, IdCaptureLoadingOverlayVerbiage } from './IdCaptureLoadingOverlay';
4
- import { FlipIdPromptAssets, FlipIdPromptClassNames, FlipIdPromptVerbiage } from './FlipIdPrompt';
4
+ import { FlipIdPromptVerbiage } from './FlipIdPrompt';
5
5
  import { CapturedDocuments } from './CapturedDocuments';
6
6
  import { IdCaptureSuccessClassNames, IdCaptureSuccessColors, IdCaptureSuccessVerbiage } from './IdCaptureSuccess';
7
7
  import { IdCaptureThresholds } from './IdCaptureModelsProvider';
8
8
  import { IdCaptureRequirementOption } from './IdCaptureRequirementOption';
9
- import { IdCaptureGuideType } from './IdCaptureGuides';
9
+ import { IdCaptureGuidesAssets, IdCaptureGuidesClassNames, IdCaptureGuideType } from './IdCaptureGuides';
10
10
  import { IdCaptureFallbackClassNames, IdCaptureFallbackColors, IdCaptureFallbackVerbiage } from '../fallback_flows/IdCapture';
11
11
  export type IdCaptureWizardAssets = {
12
12
  documentDetectionModelUrl?: string;
13
13
  focusModelUrl?: string;
14
14
  loadingOverlay?: IdCaptureLoadingOverlayAssets;
15
+ guides?: IdCaptureGuidesAssets;
15
16
  idCardFront?: IdCaptureAssets;
16
17
  idCardBack?: IdCaptureAssets;
17
18
  passport?: IdCaptureAssets;
18
- flipIdPrompt?: FlipIdPromptAssets;
19
19
  };
20
20
  export type IdCaptureWizardClassNames = {
21
21
  container?: string;
22
22
  cameraFeed?: string;
23
23
  loadingOverlay?: IdCaptureLoadingOverlayClassNames;
24
24
  capture?: IdCaptureClassNames;
25
- flipIdPrompt?: FlipIdPromptClassNames;
25
+ guides?: IdCaptureGuidesClassNames;
26
26
  success?: IdCaptureSuccessClassNames;
27
27
  fallback?: IdCaptureFallbackClassNames;
28
28
  };
@@ -0,0 +1,2 @@
1
+ import React from 'react';
2
+ export declare function ScalingCameraFeed(): React.JSX.Element | null;
@@ -1,5 +1,5 @@
1
- import { ReactElement } from 'react';
2
- import { FaceCaptureGuideOverlayClassNames } from '../face_liveness/FaceCaptureGuideOverlay';
1
+ import { ComponentType, ReactElement } from 'react';
2
+ import { FaceCaptureGuideOverlayClassNames, FaceCaptureGuideOverlayProps } from '../face_liveness/FaceCaptureGuideOverlay';
3
3
  import { CustomerSuppliedVerbiage } from '../../lib/locales';
4
4
  import { SelfieCaptureFallbackClassNames } from '../fallback_flows/SelfieCapture';
5
5
  import { Face } from '../../lib/models/FaceDetection';
@@ -26,19 +26,24 @@ export type SelfieCaptureVerbiage = {
26
26
  guidanceMoveBackText?: CustomerSuppliedVerbiage;
27
27
  guidanceMoveForwardText?: CustomerSuppliedVerbiage;
28
28
  guidanceMoveToCenterText?: CustomerSuppliedVerbiage;
29
+ guidanceNoFaceDetectedText?: CustomerSuppliedVerbiage;
29
30
  };
30
31
  export type SelfieCaptureProps = {
31
32
  onGuidanceSatisfied?: () => void;
32
33
  onGuidanceNotSatisfied?: () => void;
34
+ onSelfieCaptureStarted?: () => void;
33
35
  onSelfieCaptured?: (frame: ImageData, face: Face) => void;
34
36
  onTimeout?: () => void;
35
37
  onExit?: () => void;
36
38
  timeoutDurationMs?: number;
37
39
  guidanceMessage?: string;
38
40
  guidanceSatisfied?: boolean;
41
+ guidesComponent?: ComponentType<FaceCaptureGuideOverlayProps>;
42
+ requireVerticalFaceCentering?: boolean;
43
+ shouldCapture?: boolean;
39
44
  classNames?: SelfieCaptureClassNames;
40
45
  colors?: SelfieCaptureColors;
41
46
  verbiage?: SelfieCaptureVerbiage;
42
47
  debugMode?: boolean;
43
48
  };
44
- export declare const SelfieCapture: ({ onGuidanceSatisfied, onGuidanceNotSatisfied, onSelfieCaptured, onTimeout, onExit, timeoutDurationMs, guidanceMessage, guidanceSatisfied, classNames, colors, verbiage: rawVerbiage, debugMode, }: SelfieCaptureProps) => ReactElement;
49
+ export declare const SelfieCapture: ({ onGuidanceSatisfied, onGuidanceNotSatisfied, onSelfieCaptureStarted, onSelfieCaptured, onTimeout, onExit, timeoutDurationMs, guidanceMessage, guidanceSatisfied, guidesComponent, requireVerticalFaceCentering, shouldCapture, classNames, colors, verbiage: rawVerbiage, debugMode, }: SelfieCaptureProps) => ReactElement;
@@ -1,6 +1,19 @@
1
- import React from 'react';
1
+ import React, { SVGProps } from 'react';
2
+ import { FaceGuideStatus } from '../face_liveness/FaceCaptureGuideOverlay';
2
3
  export declare function SelfieCaptureLoadingGraphic({ width, height, className, }: {
3
4
  width?: number;
4
5
  height?: number;
5
6
  className?: string;
6
7
  }): React.JSX.Element;
8
+ export type SelfieCaptureAnimatedMaskProps = SVGProps<SVGSVGElement> & {
9
+ frame?: number;
10
+ borderWidth?: number;
11
+ borderColor?: string;
12
+ borderOpacity?: number;
13
+ verticalAlign?: 'center' | 'bottom';
14
+ status?: FaceGuideStatus;
15
+ };
16
+ export declare function SelfieCaptureAnimatedMask({ frame, borderWidth, borderColor, borderOpacity, verticalAlign, status, ...props }: SelfieCaptureAnimatedMaskProps): React.JSX.Element;
17
+ export declare function SelfieCaptureAnimatedMaskWithStatus({ status, ...props }: SelfieCaptureAnimatedMaskProps & {
18
+ status?: FaceGuideStatus;
19
+ }): React.JSX.Element;
@@ -1,11 +1,11 @@
1
1
  import * as React from 'react';
2
2
  import { MutableRefObject, ReactElement, ReactNode } from 'react';
3
3
  import { Face } from '../../lib/models/FaceDetection';
4
- type PredictionHandler = (prediction: Face[]) => void;
4
+ export type SelfieGuidancePredictionHandler = (prediction: Face[]) => Promise<void> | void;
5
5
  type SelfieGuidanceModelsState = {
6
6
  start: () => void;
7
7
  stop: () => void;
8
- onPredictionMade: (handler: PredictionHandler) => void;
8
+ onPredictionMade: (handler: SelfieGuidancePredictionHandler) => void;
9
9
  canvasRef: MutableRefObject<HTMLCanvasElement | null>;
10
10
  ready: boolean;
11
11
  error: Error | null;
@@ -1,13 +1,32 @@
1
- import { ReactElement } from 'react';
1
+ import React, { CSSProperties, ReactElement } from 'react';
2
2
  export type IdVideoCaptureFlipIdPromptAssets = {
3
3
  frontImageUrl?: string;
4
4
  backImageUrl?: string;
5
5
  };
6
+ export type IdVideoCaptureFlipIdPromptClassNames = {
7
+ frontImageContainer?: string;
8
+ backImageContainer?: string;
9
+ frontImage?: string;
10
+ backImage?: string;
11
+ };
6
12
  export type IdVideoCaptureFlipIdPromptProps = {
7
- className?: string;
8
- imageWidth?: number;
9
- imageHeight?: number;
10
- borderWidth?: number;
13
+ classNames?: IdVideoCaptureFlipIdPromptClassNames;
11
14
  assets?: IdVideoCaptureFlipIdPromptAssets;
15
+ borderWidth?: number;
16
+ borderColor?: string;
17
+ borderRadius?: number;
18
+ imageStyle?: CSSProperties;
12
19
  };
13
- export declare const IdVideoCaptureFlipIdPrompt: ({ className, imageWidth, imageHeight, borderWidth, assets, }: IdVideoCaptureFlipIdPromptProps) => ReactElement;
20
+ export declare const IdVideoCaptureFlipIdPrompt: ({ assets, classNames, borderWidth, borderColor, borderRadius, imageStyle, }: IdVideoCaptureFlipIdPromptProps) => ReactElement;
21
+ export declare const FlipImageContainer: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components/dist/types").Substitute<import("styled-components").FastOmit<React.HTMLAttributes<HTMLDivElement> & {
22
+ status?: import("./IdVideoCaptureGuidesCommon").IdCardGuideStatus;
23
+ borderWidth?: number | string;
24
+ borderRadius?: number;
25
+ borderColor?: string;
26
+ progress?: number;
27
+ }, "$isVisible"> & {
28
+ $isVisible?: boolean;
29
+ }, {
30
+ $transforms: string;
31
+ $transitionTime: number;
32
+ }>> & string;
@@ -1,37 +1,46 @@
1
1
  import React, { ReactElement } from 'react';
2
+ import { IdVideoCaptureFlipIdPromptClassNames } from './IdVideoCaptureFlipIdPrompt';
2
3
  import { CustomerSuppliedVerbiage } from '../../lib/locales';
3
- export type Action = 'SHOW_ID_FRONT' | 'FLIP_ID' | 'SHOW_ID_BACK' | 'READ_TEXT';
4
+ import { IdCardGuideStatus } from './IdVideoCaptureGuidesCommon';
5
+ import { FaceGuideStatus } from '../face_liveness/FaceCaptureGuideOverlay';
6
+ export type Action = 'SHOW_ID_FRONT' | 'FLIP_ID' | 'SHOW_ID_BACK' | 'VERIFY_LIVENESS';
4
7
  export type IdVideoCaptureGuidesAssets = {
5
8
  frontImageUrl?: string;
6
9
  backImageUrl?: string;
7
10
  };
8
11
  export type IdVideoCaptureGuidesClassNames = {
9
12
  container?: string;
13
+ faceGuideContainer?: string;
10
14
  faceGuide?: string;
11
15
  idCardGuideContainer?: string;
16
+ idCardGuideInner?: string;
12
17
  idCardGuideInstructionsContainer?: string;
13
18
  idCardGuideInstructions?: string;
14
19
  idCardGuideImageContainer?: string;
15
20
  idCardGuideImage?: string;
16
- flipIdPromptImage?: string;
21
+ flipIdPrompt?: IdVideoCaptureFlipIdPromptClassNames;
17
22
  };
18
23
  export type IdVideoCaptureGuidesVerbiage = {
19
24
  idFrontInstructionText?: CustomerSuppliedVerbiage;
20
25
  idBackInstructionText?: CustomerSuppliedVerbiage;
21
26
  flipIdInstructionText?: CustomerSuppliedVerbiage;
27
+ verifyLivenessInstructionText?: CustomerSuppliedVerbiage;
22
28
  };
23
29
  export type IdVideoCaptureGuidesProps = {
24
30
  requestedAction?: Action;
25
31
  satisfied?: boolean;
32
+ faceGuideStatus?: FaceGuideStatus;
26
33
  faceGuideBorderWidth?: number;
27
34
  faceGuideBorderColor?: string;
35
+ idCardGuideStatus?: IdCardGuideStatus;
28
36
  idCardGuideBorderWidth?: number;
29
37
  idCardGuideBorderColor?: string;
38
+ idCardCaptureProgress?: number;
30
39
  assets?: IdVideoCaptureGuidesAssets;
31
40
  classNames?: IdVideoCaptureGuidesClassNames;
32
41
  verbiage?: IdVideoCaptureGuidesVerbiage;
33
42
  };
34
- export declare const IdVideoCaptureGuides: ({ requestedAction, satisfied, faceGuideBorderWidth, faceGuideBorderColor, idCardGuideBorderWidth, idCardGuideBorderColor, assets, classNames, verbiage: rawVerbiage, }: IdVideoCaptureGuidesProps) => ReactElement;
43
+ export declare const IdVideoCaptureGuides: ({ requestedAction, satisfied, faceGuideStatus, faceGuideBorderWidth, faceGuideBorderColor, idCardGuideStatus, idCardGuideBorderWidth, idCardGuideBorderColor, idCardCaptureProgress, assets, classNames, verbiage: rawVerbiage, }: IdVideoCaptureGuidesProps) => ReactElement;
35
44
  export declare const IdCardGuideInstructionsContainer: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, never>> & string;
36
45
  export declare const IdCardGuideInstructions: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<Omit<import("styled-components").FastOmit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "$textColor" | "$variant" | "$background"> & {
37
46
  $background?: string;
@@ -0,0 +1,23 @@
1
+ import React from 'react';
2
+ export declare const IdCardGuideImageContainer: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components/dist/types").Substitute<React.HTMLAttributes<HTMLDivElement> & {
3
+ status?: IdCardGuideStatus;
4
+ borderWidth?: number | string;
5
+ borderRadius?: number;
6
+ borderColor?: string;
7
+ progress?: number;
8
+ }, {
9
+ $isVisible?: boolean;
10
+ }>> & string & Omit<typeof IdCardBorder, keyof React.Component<any, {}, any>>;
11
+ export declare const IdCardGuideImage: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components/dist/types").Substitute<React.DetailedHTMLProps<React.ImgHTMLAttributes<HTMLImageElement>, HTMLImageElement>, {
12
+ $isMirrored?: boolean;
13
+ $isInvisible?: boolean;
14
+ }>> & string;
15
+ export type IdCardGuideStatus = 'disabled' | 'ready' | 'capturing';
16
+ declare function IdCardBorder({ children, status, borderWidth, borderRadius, borderColor, progress, ...props }: React.HTMLAttributes<HTMLDivElement> & {
17
+ status?: IdCardGuideStatus;
18
+ borderWidth?: number | string;
19
+ borderRadius?: number;
20
+ borderColor?: string;
21
+ progress?: number;
22
+ }): React.JSX.Element;
23
+ export {};
@@ -1,17 +1,12 @@
1
- import React from 'react';
1
+ import React, { ComponentType } from 'react';
2
2
  import { SignatureData } from '../signature_capture/data';
3
3
  import { CustomerSuppliedVerbiage } from '../../lib/locales';
4
+ import { FaceCaptureGuideOverlayProps } from '../face_liveness/FaceCaptureGuideOverlay';
4
5
  export type VideoSignatureCaptureClassNames = {
5
6
  container?: string;
6
7
  cameraFeed?: string;
7
8
  guidanceMessageContainer?: string;
8
9
  guidanceMessage?: string;
9
- canvasContainer?: string;
10
- canvasInner?: string;
11
- canvas?: string;
12
- buttonsRow?: string;
13
- acceptBtn?: string;
14
- clearBtn?: string;
15
10
  exitCaptureBtn?: string;
16
11
  };
17
12
  export type VideoSignatureCaptureColors = {
@@ -20,16 +15,15 @@ export type VideoSignatureCaptureColors = {
20
15
  };
21
16
  export type VideoSignatureCaptureVerbiage = {
22
17
  guidanceMessageText?: CustomerSuppliedVerbiage;
23
- acceptBtnText?: CustomerSuppliedVerbiage;
24
- clearBtnText?: CustomerSuppliedVerbiage;
25
18
  };
26
19
  export type VideoSignatureCaptureProps = {
27
20
  onVideoCaptured?: (videoData: Blob, signatureData: SignatureData, signatureImageData: string) => void;
28
21
  onFaceNotDetected?: () => void;
29
22
  onExit?: () => void;
23
+ guidesComponent?: ComponentType<FaceCaptureGuideOverlayProps>;
30
24
  classNames?: VideoSignatureCaptureClassNames;
31
25
  colors?: VideoSignatureCaptureColors;
32
26
  verbiage?: VideoSignatureCaptureVerbiage;
33
27
  debugMode?: boolean;
34
28
  };
35
- export declare const VideoSignatureCapture: ({ onVideoCaptured, onFaceNotDetected, onExit, classNames, colors, verbiage: rawVerbiage, debugMode, }: VideoSignatureCaptureProps) => React.ReactElement;
29
+ export declare const VideoSignatureCapture: ({ onVideoCaptured, onFaceNotDetected, onExit, guidesComponent, classNames, colors, verbiage: rawVerbiage, debugMode, }: VideoSignatureCaptureProps) => React.ReactElement;
@@ -0,0 +1,18 @@
1
+ import React, { ReactNode } from 'react';
2
+ import { SignatureData } from '../signature_capture/data';
3
+ import SignatureCanvas from 'react-signature-canvas';
4
+ export type VideoSignatureState = {
5
+ startRecording: () => void;
6
+ stopRecording: () => void;
7
+ signaturePad?: React.RefObject<SignatureCanvas>;
8
+ signatureData: SignatureData | null;
9
+ signatureDataUrl: string | null;
10
+ signatureVideoData: Blob | null;
11
+ signatureVideoUrl: string | null;
12
+ onAcceptClicked: () => Promise<void>;
13
+ };
14
+ export declare const VideoSignatureContext: React.Context<VideoSignatureState>;
15
+ export default function VideoSignatureContextProvider({ children, }: {
16
+ children: ReactNode;
17
+ }): React.JSX.Element;
18
+ export declare function useVideoSignatureContext(): VideoSignatureState;