@incodetech/web 2.1.0-rc.2 → 2.1.0-rc.3
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/ae-signature/ae-signature.es.js +2 -2
- package/dist/ae-signature/styles.css +59 -45
- package/dist/antifraud/antifraud.es.js +4 -4
- package/dist/authentication/authentication.es.js +5 -4
- package/dist/base.css +87 -59
- package/dist/{button-Ch5-QgHB.js → button-Dz6AsbmF.js} +2 -1
- package/dist/cameraView-DIEzM5ru.js +47 -0
- package/dist/{tutorial-Cap8qKvM.js → capture-CkGvdDNH.js} +18 -568
- package/dist/certificate-issuance/certificate-issuance.es.js +7 -7
- package/dist/consent/consent.es.js +8 -8
- package/dist/{countrySelector-B4WuNUya.js → countrySelector-SvUOyPo0.js} +1 -1
- package/dist/cpf-ocr/cpf-ocr.es.js +1 -1
- package/dist/cpfOcr-B79245-3.js +2 -0
- package/dist/{cpfOcr-liTE9e70.js → cpfOcr-BhxT-lRN.js} +5 -5
- package/dist/cross-document-data-match/cross-document-data-match.es.js +4 -4
- package/dist/curp-validation/curp-validation.es.js +7 -7
- package/dist/{customFields-BQ4scZfL.js → customFields-BDsXR7A-.js} +6 -6
- package/dist/{customWatchlist-7s0_wGtE.js → customWatchlist-CYoRNCim.js} +5 -5
- package/dist/document-capture/document-capture.es.js +1 -1
- package/dist/documentCapture-DXYYyxZl.js +2 -0
- package/dist/{documentCapture-CwoSD_Iq.js → documentCapture-DhbO-A-V.js} +11 -9
- package/dist/{dynamicForms-DvTU65bW.js → dynamicForms-BifGbC9F.js} +19 -8
- package/dist/ekyb/ekyb.es.js +1 -1
- package/dist/ekybModule-C6Nttked.js +2 -0
- package/dist/{ekybModule-CwZvxios.js → ekybModule-DGnTw5UV.js} +12 -12
- package/dist/ekyc/ekyc.es.js +1 -1
- package/dist/ekycModule-CDIEjI6V.js +2 -0
- package/dist/{ekycModule-jkXByPXe.js → ekycModule-Dxpdd0ns.js} +10 -10
- package/dist/electronic-signature/electronic-signature.es.js +1 -1
- package/dist/{electronic-signature-h1sAGg7l.js → electronic-signature-Ueoffasr.js} +37 -26
- package/dist/email/email.es.js +7 -7
- package/dist/{emailInput-BRMJMJV6.js → emailInput-DsLkDtER.js} +5 -5
- package/dist/{expiredId-D17oN5K2.js → expiredId-BZXLrLk-.js} +4 -4
- package/dist/{extensibility-CTmAsaji.js → extensibility-7sRIN0JC.js} +41 -76
- package/dist/extensibility.es.js +13 -11
- package/dist/face-match/face-match.es.js +1 -1
- package/dist/face-match/styles.css +4 -0
- package/dist/faceMatch-B_HvxLm_.js +2 -0
- package/dist/{faceMatch-Dez_bq3n.js → faceMatch-DyTBoMDm.js} +8 -8
- package/dist/field-comparison/field-comparison.es.js +1 -1
- package/dist/fieldComparison-DfNEuEE5.js +2 -0
- package/dist/{fieldComparison-BelzSC48.js → fieldComparison-L_knHqgw.js} +7 -7
- package/dist/fiscal-qr/fiscal-qr.es.js +8 -7
- package/dist/flow/flow.es.js +22 -9
- package/dist/flow/styles.css +4151 -3042
- package/dist/geolocation/geolocation.es.js +14 -9
- package/dist/{governmentValidation/governmentValidation.es.js → government-validation/government-validation.es.js} +10 -14
- package/dist/{homeScreen-BIdVm9KA.js → homeScreen-B6T0JVh8.js} +2 -2
- package/dist/{hooks-Da_yP_Dr.js → hooks-CNu7o-v8.js} +39 -2
- package/dist/{i18n-DoP1NB7u.js → i18n-CU4xq8qC.js} +1 -1
- package/dist/id/id.es.js +76 -46
- package/dist/id/styles.css +1 -9
- package/dist/id-ocr/styles.css +12 -2
- package/dist/id-verification/id-verification.es.js +5 -5
- package/dist/{idOcr-C4K2XVJr.js → idOcr-WFBvqy3b.js} +31 -13
- package/dist/identity-reuse/identity-reuse.es.js +6 -6
- package/dist/{incodeComponent-Cmi1rlWs.js → incodeComponent-CfzJGETt.js} +2 -2
- package/dist/{incodeModule-M8DszCee.js → incodeModule-B-4_3JrK.js} +1 -1
- package/dist/index.es.js +1 -1
- package/dist/{mandatoryConsent-DOQ0DKgM.js → mandatoryConsent-D0GTKu-H.js} +7 -7
- package/dist/{optionAccessibleLabel-_nvVCTSL.js → optionAccessibleLabel-gfF-58Mv.js} +3 -3
- package/dist/{otpInput-Q_kzSZeD.js → otpInput-CnDc6pQm.js} +12 -11
- package/dist/{pdf-BMUXKJuC.js → pdf-BqtJTlor.js} +1 -1
- package/dist/{pdfViewer-BewML6eg.js → pdfViewer-B97DmT9m.js} +57 -20
- package/dist/phone/phone.es.js +6 -6
- package/dist/{processing-Boki1Z8j.js → processing-BeUMfdJJ.js} +1 -1
- package/dist/qe-signature/qe-signature.es.js +2 -2
- package/dist/{radioGroupComposed-TuAWUAFK.js → radioGroupComposed-DuQxslB2.js} +1 -1
- package/dist/redirect-to-mobile/redirect-to-mobile.es.js +17 -18
- package/dist/redirect-to-mobile/styles.css +2 -2
- package/dist/{richText-DsTP4H3j.js → richText-CB1fmegc.js} +1 -1
- package/dist/selfie/selfie.es.js +8 -7
- package/dist/selfie/styles.css +133 -63
- package/dist/signature/signature.es.js +8 -8
- package/dist/spinner-BCDCoi9C.js +1 -0
- package/dist/{spinner-BRNNKqPN.js → spinner-BMeIEK1d.js} +12 -6
- package/dist/themes/dark.css +16 -0
- package/dist/themes/light.css +16 -0
- package/dist/{transitionSpinner-4rPkt-KM.js → transitionSpinner-CuNCqHNi.js} +9 -8
- package/dist/tutorial-CCfPuVKX.js +706 -0
- package/dist/types/ae-signature.d.ts +23 -1
- package/dist/types/antifraud.d.ts +23 -1
- package/dist/types/authentication.d.ts +23 -1
- package/dist/types/certificate-issuance.d.ts +23 -1
- package/dist/types/consent.d.ts +23 -1
- package/dist/types/cross-document-data-match.d.ts +23 -1
- package/dist/types/curp-validation.d.ts +23 -1
- package/dist/types/document-capture.d.ts +23 -1
- package/dist/types/ekyb.d.ts +23 -1
- package/dist/types/ekyc.d.ts +23 -1
- package/dist/types/electronic-signature.d.ts +23 -1
- package/dist/types/email.d.ts +23 -1
- package/dist/types/extensibility.d.ts +39 -2
- package/dist/types/face-match.d.ts +23 -1
- package/dist/types/field-comparison.d.ts +23 -1
- package/dist/types/fiscal-qr.d.ts +23 -1
- package/dist/types/flow.d.ts +23 -1
- package/dist/types/geolocation.d.ts +27 -2
- package/dist/types/{governmentValidation.d.ts → government-validation.d.ts} +23 -1
- package/dist/types/id-verification.d.ts +23 -1
- package/dist/types/id.d.ts +23 -1
- package/dist/types/identity-reuse.d.ts +23 -1
- package/dist/types/phone.d.ts +23 -1
- package/dist/types/qe-signature.d.ts +23 -1
- package/dist/types/selfie.d.ts +23 -1
- package/dist/types/signature.d.ts +23 -1
- package/dist/types/video-selfie.d.ts +72 -0
- package/dist/types/watchlist.d.ts +23 -1
- package/dist/types/workflow.d.ts +23 -1
- package/dist/{useModuleLoader-Kt78XfNR.js → useModuleLoader-Gvo9qscB.js} +38 -23
- package/dist/{verificationResult-B6PBXbp9.js → verificationResult-BWWkmeiA.js} +3 -3
- package/dist/video-selfie/styles.css +1644 -0
- package/dist/video-selfie/video-selfie.es.js +854 -0
- package/dist/watchlist/watchlist.es.js +5 -5
- package/dist/{watchlistForBusiness-DCKlKG81.js → watchlistForBusiness-D2Uo_TwF.js} +7 -7
- package/dist/workflow/styles.css +148 -76
- package/dist/workflow/workflow.es.js +23 -27
- package/package.json +29 -2
- package/dist/cpfOcr-BJOYoITy.js +0 -2
- package/dist/documentCapture-3RHCHepT.js +0 -2
- package/dist/ekybModule-BkVQBQvW.js +0 -2
- package/dist/ekycModule-BIbj7hr1.js +0 -2
- package/dist/faceMatch-C0-RPzrc.js +0 -2
- package/dist/fieldComparison-7FUznk_9.js +0 -2
- package/dist/spinner-zRaUjXtH.js +0 -1
- /package/dist/{aligndevicelottie-DMXPhIDs.js → aligndevicelottie-DFscByAI.js} +0 -0
- /package/dist/{back-horizontal-hint-DNIIDrEW.js → back-horizontal-hint-xTnSQbzn.js} +0 -0
- /package/dist/{back-tutorial-B8JJSJBB.js → back-tutorial-cI_4VHmE.js} +0 -0
- /package/dist/{back-vertical-hint-CW6ZS7bP.js → back-vertical-hint-BWWlHfX2.js} +0 -0
- /package/dist/{backdevicelottie-By75Bznp.js → backdevicelottie-COyhTrxM.js} +0 -0
- /package/dist/{blurdevicelottie-C_9VAHkM.js → blurdevicelottie-BLVeJHEG.js} +0 -0
- /package/dist/{browser-ponyfill-C_DpU0lQ.js → browser-ponyfill-Df13Th-G.js} +0 -0
- /package/dist/{defineProperty-CTu-cLWm.js → defineProperty-Qjefk7Uf.js} +0 -0
- /package/dist/{flip-animation-st9bra1p.js → flip-animation-CZYSUtMm.js} +0 -0
- /package/dist/{front-horizontal-hint-DvME-aVk.js → front-horizontal-hint-B84GgTO1.js} +0 -0
- /package/dist/{front-vertical-hint-BUG1VMsP.js → front-vertical-hint-Bs_avngq.js} +0 -0
- /package/dist/{frontdevicelottie-uObOEs8p.js → frontdevicelottie-B4tE2PYQ.js} +0 -0
- /package/dist/{glaredevicelottie-CsfIgqIc.js → glaredevicelottie-D1pR73sx.js} +0 -0
- /package/dist/{governmentValidation → government-validation}/styles.css +0 -0
- /package/dist/{id-laser-h-BvVSaLyU.js → id-laser-h-CzPegPMn.js} +0 -0
- /package/dist/{id-laser-v-Dj_RN_s9.js → id-laser-v-BiUXkM4x.js} +0 -0
- /package/dist/{id-tutorial-BOOsXlAJ.js → id-tutorial-DwO90SAm.js} +0 -0
- /package/dist/{lottie_light-BG-RL2Iu.js → lottie_light-C6B2ec41.js} +0 -0
- /package/dist/{numberedStep-Dc0BUU-j.js → numberedStep-CEb-lFJm.js} +0 -0
- /package/dist/{passport-horizontal-hint-BhpVt73n.js → passport-horizontal-hint-Bj0ZJY0g.js} +0 -0
- /package/dist/{passport-tutorial-CeSup6m9.js → passport-tutorial-D9JNsMsM.js} +0 -0
- /package/dist/{passport-vertical-hint-CVRBnZXS.js → passport-vertical-hint-Dfk77xUJ.js} +0 -0
- /package/dist/{registerIncodeElement-CdlNRRv5.js → registerIncodeElement-DaNjbAwZ.js} +0 -0
- /package/dist/{requiredLabelHint-DX3oVNtu.js → requiredLabelHint-D0RhuMed.js} +0 -0
- /package/dist/{selfieTutorial-CYa8bq6B.js → selfieTutorial-pB-N-fj5.js} +0 -0
- /package/dist/{snackbar-CGL6gp9u.js → snackbar-DS7Mv62v.js} +0 -0
- /package/dist/{statusPage-BUm5gtQY.js → statusPage-Bk8nJwXV.js} +0 -0
- /package/dist/{tabs-DUkWjBGk.js → tabs-C__chW-u.js} +0 -0
|
@@ -5,6 +5,26 @@ export declare const AeSignature: FC<AeSignatureModuleProps>;
|
|
|
5
5
|
|
|
6
6
|
declare type AeSignatureModuleProps = IncodeModuleProps<AeSignatureConfig>;
|
|
7
7
|
|
|
8
|
+
/**
|
|
9
|
+
* Extra context passed to `onFinish` alongside the result. Lets a host decide
|
|
10
|
+
* how to react to the terminal state without inspecting the DOM. Only the
|
|
11
|
+
* workflow module sets these fields today.
|
|
12
|
+
*/
|
|
13
|
+
declare type IncodeFinishMeta = {
|
|
14
|
+
/**
|
|
15
|
+
* True when the SDK owns the terminal screen — it has already rendered its
|
|
16
|
+
* own finish UI (today, the workflow's `showFinishScreenBySessionStatus`
|
|
17
|
+
* screen), so the host should not render its own completion screen on top.
|
|
18
|
+
* `onFinish` still fires so the host can run side effects (e.g. notify an
|
|
19
|
+
* OAuth parent).
|
|
20
|
+
*
|
|
21
|
+
* Advisory only: the SDK cannot stop a host from rendering. This works solely
|
|
22
|
+
* because the host reads this flag — a host that ignores it will still
|
|
23
|
+
* replace the SDK screen. Not a guarantee.
|
|
24
|
+
*/
|
|
25
|
+
sdkOwnsTerminalScreen?: boolean;
|
|
26
|
+
};
|
|
27
|
+
|
|
8
28
|
declare type IncodeModuleProps<TConfig, TResult = void, TManager = unknown> = {
|
|
9
29
|
/**
|
|
10
30
|
* Module configuration required to render the flow.
|
|
@@ -18,8 +38,10 @@ declare type IncodeModuleProps<TConfig, TResult = void, TManager = unknown> = {
|
|
|
18
38
|
/**
|
|
19
39
|
* Callback invoked when the module completes successfully.
|
|
20
40
|
* @param result - Optional result data from the module completion
|
|
41
|
+
* @param meta - Optional context about how the module resolved (e.g. whether
|
|
42
|
+
* the SDK rendered its own terminal finish screen). See {@link IncodeFinishMeta}.
|
|
21
43
|
*/
|
|
22
|
-
onFinish?: (result?: TResult) => void;
|
|
44
|
+
onFinish?: (result?: TResult, meta?: IncodeFinishMeta) => void;
|
|
23
45
|
/**
|
|
24
46
|
* Callback invoked when a fatal module error occurs.
|
|
25
47
|
*
|
|
@@ -6,6 +6,26 @@ export declare const Antifraud: FC<AntifraudProps>;
|
|
|
6
6
|
|
|
7
7
|
declare type AntifraudProps = IncodeModuleProps<AntifraudConfig, void, AntifraudManager>;
|
|
8
8
|
|
|
9
|
+
/**
|
|
10
|
+
* Extra context passed to `onFinish` alongside the result. Lets a host decide
|
|
11
|
+
* how to react to the terminal state without inspecting the DOM. Only the
|
|
12
|
+
* workflow module sets these fields today.
|
|
13
|
+
*/
|
|
14
|
+
declare type IncodeFinishMeta = {
|
|
15
|
+
/**
|
|
16
|
+
* True when the SDK owns the terminal screen — it has already rendered its
|
|
17
|
+
* own finish UI (today, the workflow's `showFinishScreenBySessionStatus`
|
|
18
|
+
* screen), so the host should not render its own completion screen on top.
|
|
19
|
+
* `onFinish` still fires so the host can run side effects (e.g. notify an
|
|
20
|
+
* OAuth parent).
|
|
21
|
+
*
|
|
22
|
+
* Advisory only: the SDK cannot stop a host from rendering. This works solely
|
|
23
|
+
* because the host reads this flag — a host that ignores it will still
|
|
24
|
+
* replace the SDK screen. Not a guarantee.
|
|
25
|
+
*/
|
|
26
|
+
sdkOwnsTerminalScreen?: boolean;
|
|
27
|
+
};
|
|
28
|
+
|
|
9
29
|
declare type IncodeModuleProps<TConfig, TResult = void, TManager = unknown> = {
|
|
10
30
|
/**
|
|
11
31
|
* Module configuration required to render the flow.
|
|
@@ -19,8 +39,10 @@ declare type IncodeModuleProps<TConfig, TResult = void, TManager = unknown> = {
|
|
|
19
39
|
/**
|
|
20
40
|
* Callback invoked when the module completes successfully.
|
|
21
41
|
* @param result - Optional result data from the module completion
|
|
42
|
+
* @param meta - Optional context about how the module resolved (e.g. whether
|
|
43
|
+
* the SDK rendered its own terminal finish screen). See {@link IncodeFinishMeta}.
|
|
22
44
|
*/
|
|
23
|
-
onFinish?: (result?: TResult) => void;
|
|
45
|
+
onFinish?: (result?: TResult, meta?: IncodeFinishMeta) => void;
|
|
24
46
|
/**
|
|
25
47
|
* Callback invoked when a fatal module error occurs.
|
|
26
48
|
*
|
|
@@ -8,6 +8,26 @@ declare type AuthenticationProps = IncodeModuleProps<AuthenticationConfig & {
|
|
|
8
8
|
authHint?: string;
|
|
9
9
|
}, void, AuthenticationManager>;
|
|
10
10
|
|
|
11
|
+
/**
|
|
12
|
+
* Extra context passed to `onFinish` alongside the result. Lets a host decide
|
|
13
|
+
* how to react to the terminal state without inspecting the DOM. Only the
|
|
14
|
+
* workflow module sets these fields today.
|
|
15
|
+
*/
|
|
16
|
+
declare type IncodeFinishMeta = {
|
|
17
|
+
/**
|
|
18
|
+
* True when the SDK owns the terminal screen — it has already rendered its
|
|
19
|
+
* own finish UI (today, the workflow's `showFinishScreenBySessionStatus`
|
|
20
|
+
* screen), so the host should not render its own completion screen on top.
|
|
21
|
+
* `onFinish` still fires so the host can run side effects (e.g. notify an
|
|
22
|
+
* OAuth parent).
|
|
23
|
+
*
|
|
24
|
+
* Advisory only: the SDK cannot stop a host from rendering. This works solely
|
|
25
|
+
* because the host reads this flag — a host that ignores it will still
|
|
26
|
+
* replace the SDK screen. Not a guarantee.
|
|
27
|
+
*/
|
|
28
|
+
sdkOwnsTerminalScreen?: boolean;
|
|
29
|
+
};
|
|
30
|
+
|
|
11
31
|
declare type IncodeModuleProps<TConfig, TResult = void, TManager = unknown> = {
|
|
12
32
|
/**
|
|
13
33
|
* Module configuration required to render the flow.
|
|
@@ -21,8 +41,10 @@ declare type IncodeModuleProps<TConfig, TResult = void, TManager = unknown> = {
|
|
|
21
41
|
/**
|
|
22
42
|
* Callback invoked when the module completes successfully.
|
|
23
43
|
* @param result - Optional result data from the module completion
|
|
44
|
+
* @param meta - Optional context about how the module resolved (e.g. whether
|
|
45
|
+
* the SDK rendered its own terminal finish screen). See {@link IncodeFinishMeta}.
|
|
24
46
|
*/
|
|
25
|
-
onFinish?: (result?: TResult) => void;
|
|
47
|
+
onFinish?: (result?: TResult, meta?: IncodeFinishMeta) => void;
|
|
26
48
|
/**
|
|
27
49
|
* Callback invoked when a fatal module error occurs.
|
|
28
50
|
*
|
|
@@ -8,6 +8,26 @@ declare type CertificateIssuanceProps = IncodeModuleProps<CertificateIssuanceCon
|
|
|
8
8
|
manager?: CertificateIssuanceManager;
|
|
9
9
|
};
|
|
10
10
|
|
|
11
|
+
/**
|
|
12
|
+
* Extra context passed to `onFinish` alongside the result. Lets a host decide
|
|
13
|
+
* how to react to the terminal state without inspecting the DOM. Only the
|
|
14
|
+
* workflow module sets these fields today.
|
|
15
|
+
*/
|
|
16
|
+
declare type IncodeFinishMeta = {
|
|
17
|
+
/**
|
|
18
|
+
* True when the SDK owns the terminal screen — it has already rendered its
|
|
19
|
+
* own finish UI (today, the workflow's `showFinishScreenBySessionStatus`
|
|
20
|
+
* screen), so the host should not render its own completion screen on top.
|
|
21
|
+
* `onFinish` still fires so the host can run side effects (e.g. notify an
|
|
22
|
+
* OAuth parent).
|
|
23
|
+
*
|
|
24
|
+
* Advisory only: the SDK cannot stop a host from rendering. This works solely
|
|
25
|
+
* because the host reads this flag — a host that ignores it will still
|
|
26
|
+
* replace the SDK screen. Not a guarantee.
|
|
27
|
+
*/
|
|
28
|
+
sdkOwnsTerminalScreen?: boolean;
|
|
29
|
+
};
|
|
30
|
+
|
|
11
31
|
declare type IncodeModuleProps<TConfig, TResult = void, TManager = unknown> = {
|
|
12
32
|
/**
|
|
13
33
|
* Module configuration required to render the flow.
|
|
@@ -21,8 +41,10 @@ declare type IncodeModuleProps<TConfig, TResult = void, TManager = unknown> = {
|
|
|
21
41
|
/**
|
|
22
42
|
* Callback invoked when the module completes successfully.
|
|
23
43
|
* @param result - Optional result data from the module completion
|
|
44
|
+
* @param meta - Optional context about how the module resolved (e.g. whether
|
|
45
|
+
* the SDK rendered its own terminal finish screen). See {@link IncodeFinishMeta}.
|
|
24
46
|
*/
|
|
25
|
-
onFinish?: (result?: TResult) => void;
|
|
47
|
+
onFinish?: (result?: TResult, meta?: IncodeFinishMeta) => void;
|
|
26
48
|
/**
|
|
27
49
|
* Callback invoked when a fatal module error occurs.
|
|
28
50
|
*
|
package/dist/types/consent.d.ts
CHANGED
|
@@ -6,6 +6,26 @@ export declare const Consent: FC<ConsentProps>;
|
|
|
6
6
|
|
|
7
7
|
declare type ConsentProps = IncodeModuleProps<ConsentConfig, void, ConsentManager>;
|
|
8
8
|
|
|
9
|
+
/**
|
|
10
|
+
* Extra context passed to `onFinish` alongside the result. Lets a host decide
|
|
11
|
+
* how to react to the terminal state without inspecting the DOM. Only the
|
|
12
|
+
* workflow module sets these fields today.
|
|
13
|
+
*/
|
|
14
|
+
declare type IncodeFinishMeta = {
|
|
15
|
+
/**
|
|
16
|
+
* True when the SDK owns the terminal screen — it has already rendered its
|
|
17
|
+
* own finish UI (today, the workflow's `showFinishScreenBySessionStatus`
|
|
18
|
+
* screen), so the host should not render its own completion screen on top.
|
|
19
|
+
* `onFinish` still fires so the host can run side effects (e.g. notify an
|
|
20
|
+
* OAuth parent).
|
|
21
|
+
*
|
|
22
|
+
* Advisory only: the SDK cannot stop a host from rendering. This works solely
|
|
23
|
+
* because the host reads this flag — a host that ignores it will still
|
|
24
|
+
* replace the SDK screen. Not a guarantee.
|
|
25
|
+
*/
|
|
26
|
+
sdkOwnsTerminalScreen?: boolean;
|
|
27
|
+
};
|
|
28
|
+
|
|
9
29
|
declare type IncodeModuleProps<TConfig, TResult = void, TManager = unknown> = {
|
|
10
30
|
/**
|
|
11
31
|
* Module configuration required to render the flow.
|
|
@@ -19,8 +39,10 @@ declare type IncodeModuleProps<TConfig, TResult = void, TManager = unknown> = {
|
|
|
19
39
|
/**
|
|
20
40
|
* Callback invoked when the module completes successfully.
|
|
21
41
|
* @param result - Optional result data from the module completion
|
|
42
|
+
* @param meta - Optional context about how the module resolved (e.g. whether
|
|
43
|
+
* the SDK rendered its own terminal finish screen). See {@link IncodeFinishMeta}.
|
|
22
44
|
*/
|
|
23
|
-
onFinish?: (result?: TResult) => void;
|
|
45
|
+
onFinish?: (result?: TResult, meta?: IncodeFinishMeta) => void;
|
|
24
46
|
/**
|
|
25
47
|
* Callback invoked when a fatal module error occurs.
|
|
26
48
|
*
|
|
@@ -5,6 +5,26 @@ export declare const CrossDocumentDataMatch: FC<CrossDocumentDataMatchProps>;
|
|
|
5
5
|
|
|
6
6
|
declare type CrossDocumentDataMatchProps = IncodeModuleProps<CrossDocumentDataMatchConfig>;
|
|
7
7
|
|
|
8
|
+
/**
|
|
9
|
+
* Extra context passed to `onFinish` alongside the result. Lets a host decide
|
|
10
|
+
* how to react to the terminal state without inspecting the DOM. Only the
|
|
11
|
+
* workflow module sets these fields today.
|
|
12
|
+
*/
|
|
13
|
+
declare type IncodeFinishMeta = {
|
|
14
|
+
/**
|
|
15
|
+
* True when the SDK owns the terminal screen — it has already rendered its
|
|
16
|
+
* own finish UI (today, the workflow's `showFinishScreenBySessionStatus`
|
|
17
|
+
* screen), so the host should not render its own completion screen on top.
|
|
18
|
+
* `onFinish` still fires so the host can run side effects (e.g. notify an
|
|
19
|
+
* OAuth parent).
|
|
20
|
+
*
|
|
21
|
+
* Advisory only: the SDK cannot stop a host from rendering. This works solely
|
|
22
|
+
* because the host reads this flag — a host that ignores it will still
|
|
23
|
+
* replace the SDK screen. Not a guarantee.
|
|
24
|
+
*/
|
|
25
|
+
sdkOwnsTerminalScreen?: boolean;
|
|
26
|
+
};
|
|
27
|
+
|
|
8
28
|
declare type IncodeModuleProps<TConfig, TResult = void, TManager = unknown> = {
|
|
9
29
|
/**
|
|
10
30
|
* Module configuration required to render the flow.
|
|
@@ -18,8 +38,10 @@ declare type IncodeModuleProps<TConfig, TResult = void, TManager = unknown> = {
|
|
|
18
38
|
/**
|
|
19
39
|
* Callback invoked when the module completes successfully.
|
|
20
40
|
* @param result - Optional result data from the module completion
|
|
41
|
+
* @param meta - Optional context about how the module resolved (e.g. whether
|
|
42
|
+
* the SDK rendered its own terminal finish screen). See {@link IncodeFinishMeta}.
|
|
21
43
|
*/
|
|
22
|
-
onFinish?: (result?: TResult) => void;
|
|
44
|
+
onFinish?: (result?: TResult, meta?: IncodeFinishMeta) => void;
|
|
23
45
|
/**
|
|
24
46
|
* Callback invoked when a fatal module error occurs.
|
|
25
47
|
*
|
|
@@ -6,6 +6,26 @@ export declare const CurpValidation: FC<CurpValidationProps>;
|
|
|
6
6
|
|
|
7
7
|
declare type CurpValidationProps = IncodeModuleProps<CurpValidationConfig, void, CurpValidationManager>;
|
|
8
8
|
|
|
9
|
+
/**
|
|
10
|
+
* Extra context passed to `onFinish` alongside the result. Lets a host decide
|
|
11
|
+
* how to react to the terminal state without inspecting the DOM. Only the
|
|
12
|
+
* workflow module sets these fields today.
|
|
13
|
+
*/
|
|
14
|
+
declare type IncodeFinishMeta = {
|
|
15
|
+
/**
|
|
16
|
+
* True when the SDK owns the terminal screen — it has already rendered its
|
|
17
|
+
* own finish UI (today, the workflow's `showFinishScreenBySessionStatus`
|
|
18
|
+
* screen), so the host should not render its own completion screen on top.
|
|
19
|
+
* `onFinish` still fires so the host can run side effects (e.g. notify an
|
|
20
|
+
* OAuth parent).
|
|
21
|
+
*
|
|
22
|
+
* Advisory only: the SDK cannot stop a host from rendering. This works solely
|
|
23
|
+
* because the host reads this flag — a host that ignores it will still
|
|
24
|
+
* replace the SDK screen. Not a guarantee.
|
|
25
|
+
*/
|
|
26
|
+
sdkOwnsTerminalScreen?: boolean;
|
|
27
|
+
};
|
|
28
|
+
|
|
9
29
|
declare type IncodeModuleProps<TConfig, TResult = void, TManager = unknown> = {
|
|
10
30
|
/**
|
|
11
31
|
* Module configuration required to render the flow.
|
|
@@ -19,8 +39,10 @@ declare type IncodeModuleProps<TConfig, TResult = void, TManager = unknown> = {
|
|
|
19
39
|
/**
|
|
20
40
|
* Callback invoked when the module completes successfully.
|
|
21
41
|
* @param result - Optional result data from the module completion
|
|
42
|
+
* @param meta - Optional context about how the module resolved (e.g. whether
|
|
43
|
+
* the SDK rendered its own terminal finish screen). See {@link IncodeFinishMeta}.
|
|
22
44
|
*/
|
|
23
|
-
onFinish?: (result?: TResult) => void;
|
|
45
|
+
onFinish?: (result?: TResult, meta?: IncodeFinishMeta) => void;
|
|
24
46
|
/**
|
|
25
47
|
* Callback invoked when a fatal module error occurs.
|
|
26
48
|
*
|
|
@@ -5,6 +5,26 @@ export declare const DocumentCapture: FC<DocumentCaptureProps>;
|
|
|
5
5
|
|
|
6
6
|
declare type DocumentCaptureProps = IncodeModuleProps<DocumentCaptureConfig>;
|
|
7
7
|
|
|
8
|
+
/**
|
|
9
|
+
* Extra context passed to `onFinish` alongside the result. Lets a host decide
|
|
10
|
+
* how to react to the terminal state without inspecting the DOM. Only the
|
|
11
|
+
* workflow module sets these fields today.
|
|
12
|
+
*/
|
|
13
|
+
declare type IncodeFinishMeta = {
|
|
14
|
+
/**
|
|
15
|
+
* True when the SDK owns the terminal screen — it has already rendered its
|
|
16
|
+
* own finish UI (today, the workflow's `showFinishScreenBySessionStatus`
|
|
17
|
+
* screen), so the host should not render its own completion screen on top.
|
|
18
|
+
* `onFinish` still fires so the host can run side effects (e.g. notify an
|
|
19
|
+
* OAuth parent).
|
|
20
|
+
*
|
|
21
|
+
* Advisory only: the SDK cannot stop a host from rendering. This works solely
|
|
22
|
+
* because the host reads this flag — a host that ignores it will still
|
|
23
|
+
* replace the SDK screen. Not a guarantee.
|
|
24
|
+
*/
|
|
25
|
+
sdkOwnsTerminalScreen?: boolean;
|
|
26
|
+
};
|
|
27
|
+
|
|
8
28
|
declare type IncodeModuleProps<TConfig, TResult = void, TManager = unknown> = {
|
|
9
29
|
/**
|
|
10
30
|
* Module configuration required to render the flow.
|
|
@@ -18,8 +38,10 @@ declare type IncodeModuleProps<TConfig, TResult = void, TManager = unknown> = {
|
|
|
18
38
|
/**
|
|
19
39
|
* Callback invoked when the module completes successfully.
|
|
20
40
|
* @param result - Optional result data from the module completion
|
|
41
|
+
* @param meta - Optional context about how the module resolved (e.g. whether
|
|
42
|
+
* the SDK rendered its own terminal finish screen). See {@link IncodeFinishMeta}.
|
|
21
43
|
*/
|
|
22
|
-
onFinish?: (result?: TResult) => void;
|
|
44
|
+
onFinish?: (result?: TResult, meta?: IncodeFinishMeta) => void;
|
|
23
45
|
/**
|
|
24
46
|
* Callback invoked when a fatal module error occurs.
|
|
25
47
|
*
|
package/dist/types/ekyb.d.ts
CHANGED
|
@@ -5,6 +5,26 @@ export declare const EkybModule: FC<EkybModuleProps>;
|
|
|
5
5
|
|
|
6
6
|
declare type EkybModuleProps = IncodeModuleProps<EkybConfig>;
|
|
7
7
|
|
|
8
|
+
/**
|
|
9
|
+
* Extra context passed to `onFinish` alongside the result. Lets a host decide
|
|
10
|
+
* how to react to the terminal state without inspecting the DOM. Only the
|
|
11
|
+
* workflow module sets these fields today.
|
|
12
|
+
*/
|
|
13
|
+
declare type IncodeFinishMeta = {
|
|
14
|
+
/**
|
|
15
|
+
* True when the SDK owns the terminal screen — it has already rendered its
|
|
16
|
+
* own finish UI (today, the workflow's `showFinishScreenBySessionStatus`
|
|
17
|
+
* screen), so the host should not render its own completion screen on top.
|
|
18
|
+
* `onFinish` still fires so the host can run side effects (e.g. notify an
|
|
19
|
+
* OAuth parent).
|
|
20
|
+
*
|
|
21
|
+
* Advisory only: the SDK cannot stop a host from rendering. This works solely
|
|
22
|
+
* because the host reads this flag — a host that ignores it will still
|
|
23
|
+
* replace the SDK screen. Not a guarantee.
|
|
24
|
+
*/
|
|
25
|
+
sdkOwnsTerminalScreen?: boolean;
|
|
26
|
+
};
|
|
27
|
+
|
|
8
28
|
declare type IncodeModuleProps<TConfig, TResult = void, TManager = unknown> = {
|
|
9
29
|
/**
|
|
10
30
|
* Module configuration required to render the flow.
|
|
@@ -18,8 +38,10 @@ declare type IncodeModuleProps<TConfig, TResult = void, TManager = unknown> = {
|
|
|
18
38
|
/**
|
|
19
39
|
* Callback invoked when the module completes successfully.
|
|
20
40
|
* @param result - Optional result data from the module completion
|
|
41
|
+
* @param meta - Optional context about how the module resolved (e.g. whether
|
|
42
|
+
* the SDK rendered its own terminal finish screen). See {@link IncodeFinishMeta}.
|
|
21
43
|
*/
|
|
22
|
-
onFinish?: (result?: TResult) => void;
|
|
44
|
+
onFinish?: (result?: TResult, meta?: IncodeFinishMeta) => void;
|
|
23
45
|
/**
|
|
24
46
|
* Callback invoked when a fatal module error occurs.
|
|
25
47
|
*
|
package/dist/types/ekyc.d.ts
CHANGED
|
@@ -5,6 +5,26 @@ export declare const EkycModule: FC<EkycModuleProps>;
|
|
|
5
5
|
|
|
6
6
|
declare type EkycModuleProps = IncodeModuleProps<EkycConfig>;
|
|
7
7
|
|
|
8
|
+
/**
|
|
9
|
+
* Extra context passed to `onFinish` alongside the result. Lets a host decide
|
|
10
|
+
* how to react to the terminal state without inspecting the DOM. Only the
|
|
11
|
+
* workflow module sets these fields today.
|
|
12
|
+
*/
|
|
13
|
+
declare type IncodeFinishMeta = {
|
|
14
|
+
/**
|
|
15
|
+
* True when the SDK owns the terminal screen — it has already rendered its
|
|
16
|
+
* own finish UI (today, the workflow's `showFinishScreenBySessionStatus`
|
|
17
|
+
* screen), so the host should not render its own completion screen on top.
|
|
18
|
+
* `onFinish` still fires so the host can run side effects (e.g. notify an
|
|
19
|
+
* OAuth parent).
|
|
20
|
+
*
|
|
21
|
+
* Advisory only: the SDK cannot stop a host from rendering. This works solely
|
|
22
|
+
* because the host reads this flag — a host that ignores it will still
|
|
23
|
+
* replace the SDK screen. Not a guarantee.
|
|
24
|
+
*/
|
|
25
|
+
sdkOwnsTerminalScreen?: boolean;
|
|
26
|
+
};
|
|
27
|
+
|
|
8
28
|
declare type IncodeModuleProps<TConfig, TResult = void, TManager = unknown> = {
|
|
9
29
|
/**
|
|
10
30
|
* Module configuration required to render the flow.
|
|
@@ -18,8 +38,10 @@ declare type IncodeModuleProps<TConfig, TResult = void, TManager = unknown> = {
|
|
|
18
38
|
/**
|
|
19
39
|
* Callback invoked when the module completes successfully.
|
|
20
40
|
* @param result - Optional result data from the module completion
|
|
41
|
+
* @param meta - Optional context about how the module resolved (e.g. whether
|
|
42
|
+
* the SDK rendered its own terminal finish screen). See {@link IncodeFinishMeta}.
|
|
21
43
|
*/
|
|
22
|
-
onFinish?: (result?: TResult) => void;
|
|
44
|
+
onFinish?: (result?: TResult, meta?: IncodeFinishMeta) => void;
|
|
23
45
|
/**
|
|
24
46
|
* Callback invoked when a fatal module error occurs.
|
|
25
47
|
*
|
|
@@ -8,6 +8,26 @@ export declare const ElectronicSignature: FC<ElectronicSignatureModuleProps>;
|
|
|
8
8
|
|
|
9
9
|
declare type ElectronicSignatureModuleProps = IncodeModuleProps<ElectronicSignatureConfig>;
|
|
10
10
|
|
|
11
|
+
/**
|
|
12
|
+
* Extra context passed to `onFinish` alongside the result. Lets a host decide
|
|
13
|
+
* how to react to the terminal state without inspecting the DOM. Only the
|
|
14
|
+
* workflow module sets these fields today.
|
|
15
|
+
*/
|
|
16
|
+
declare type IncodeFinishMeta = {
|
|
17
|
+
/**
|
|
18
|
+
* True when the SDK owns the terminal screen — it has already rendered its
|
|
19
|
+
* own finish UI (today, the workflow's `showFinishScreenBySessionStatus`
|
|
20
|
+
* screen), so the host should not render its own completion screen on top.
|
|
21
|
+
* `onFinish` still fires so the host can run side effects (e.g. notify an
|
|
22
|
+
* OAuth parent).
|
|
23
|
+
*
|
|
24
|
+
* Advisory only: the SDK cannot stop a host from rendering. This works solely
|
|
25
|
+
* because the host reads this flag — a host that ignores it will still
|
|
26
|
+
* replace the SDK screen. Not a guarantee.
|
|
27
|
+
*/
|
|
28
|
+
sdkOwnsTerminalScreen?: boolean;
|
|
29
|
+
};
|
|
30
|
+
|
|
11
31
|
declare type IncodeModuleProps<TConfig, TResult = void, TManager = unknown> = {
|
|
12
32
|
/**
|
|
13
33
|
* Module configuration required to render the flow.
|
|
@@ -21,8 +41,10 @@ declare type IncodeModuleProps<TConfig, TResult = void, TManager = unknown> = {
|
|
|
21
41
|
/**
|
|
22
42
|
* Callback invoked when the module completes successfully.
|
|
23
43
|
* @param result - Optional result data from the module completion
|
|
44
|
+
* @param meta - Optional context about how the module resolved (e.g. whether
|
|
45
|
+
* the SDK rendered its own terminal finish screen). See {@link IncodeFinishMeta}.
|
|
24
46
|
*/
|
|
25
|
-
onFinish?: (result?: TResult) => void;
|
|
47
|
+
onFinish?: (result?: TResult, meta?: IncodeFinishMeta) => void;
|
|
26
48
|
/**
|
|
27
49
|
* Callback invoked when a fatal module error occurs.
|
|
28
50
|
*
|
package/dist/types/email.d.ts
CHANGED
|
@@ -32,6 +32,26 @@ export declare const Email: FC<EmailProps>;
|
|
|
32
32
|
*/
|
|
33
33
|
declare type EmailProps = IncodeModuleProps<EmailConfig, void, EmailManager>;
|
|
34
34
|
|
|
35
|
+
/**
|
|
36
|
+
* Extra context passed to `onFinish` alongside the result. Lets a host decide
|
|
37
|
+
* how to react to the terminal state without inspecting the DOM. Only the
|
|
38
|
+
* workflow module sets these fields today.
|
|
39
|
+
*/
|
|
40
|
+
declare type IncodeFinishMeta = {
|
|
41
|
+
/**
|
|
42
|
+
* True when the SDK owns the terminal screen — it has already rendered its
|
|
43
|
+
* own finish UI (today, the workflow's `showFinishScreenBySessionStatus`
|
|
44
|
+
* screen), so the host should not render its own completion screen on top.
|
|
45
|
+
* `onFinish` still fires so the host can run side effects (e.g. notify an
|
|
46
|
+
* OAuth parent).
|
|
47
|
+
*
|
|
48
|
+
* Advisory only: the SDK cannot stop a host from rendering. This works solely
|
|
49
|
+
* because the host reads this flag — a host that ignores it will still
|
|
50
|
+
* replace the SDK screen. Not a guarantee.
|
|
51
|
+
*/
|
|
52
|
+
sdkOwnsTerminalScreen?: boolean;
|
|
53
|
+
};
|
|
54
|
+
|
|
35
55
|
declare type IncodeModuleProps<TConfig, TResult = void, TManager = unknown> = {
|
|
36
56
|
/**
|
|
37
57
|
* Module configuration required to render the flow.
|
|
@@ -45,8 +65,10 @@ declare type IncodeModuleProps<TConfig, TResult = void, TManager = unknown> = {
|
|
|
45
65
|
/**
|
|
46
66
|
* Callback invoked when the module completes successfully.
|
|
47
67
|
* @param result - Optional result data from the module completion
|
|
68
|
+
* @param meta - Optional context about how the module resolved (e.g. whether
|
|
69
|
+
* the SDK rendered its own terminal finish screen). See {@link IncodeFinishMeta}.
|
|
48
70
|
*/
|
|
49
|
-
onFinish?: (result?: TResult) => void;
|
|
71
|
+
onFinish?: (result?: TResult, meta?: IncodeFinishMeta) => void;
|
|
50
72
|
/**
|
|
51
73
|
* Callback invoked when a fatal module error occurs.
|
|
52
74
|
*
|
|
@@ -60,7 +60,7 @@ declare type ButtonProps = Omit<HTMLAttributes<HTMLButtonElement>, 'class' | 'ty
|
|
|
60
60
|
disabled?: boolean;
|
|
61
61
|
};
|
|
62
62
|
|
|
63
|
-
declare type ButtonSize = 'L' | 'M' | 'S';
|
|
63
|
+
declare type ButtonSize = 'L' | 'M' | 'S' | 'inline';
|
|
64
64
|
|
|
65
65
|
export declare const CalendarIcon: FC<CalendarIconProps>;
|
|
66
66
|
|
|
@@ -125,6 +125,7 @@ declare type CameraViewProps = {
|
|
|
125
125
|
videoRef?: Ref<HTMLVideoElement>;
|
|
126
126
|
onPlaying?: () => void;
|
|
127
127
|
className?: string;
|
|
128
|
+
mirrored?: boolean;
|
|
128
129
|
'data-testid'?: string;
|
|
129
130
|
};
|
|
130
131
|
|
|
@@ -402,6 +403,9 @@ declare type IdErrorProps = {
|
|
|
402
403
|
* wires `idCaptureManager.retryCapture()` and forwards the
|
|
403
404
|
* `attemptsRemaining` counter into the shared `<ExpiredId>` primitive.
|
|
404
405
|
*
|
|
406
|
+
* `isBackSide` triggers the Figma `1-9-11-id-documenterror` subtitle
|
|
407
|
+
* ("Use a different ID from the accepted list") when the back side expired.
|
|
408
|
+
*
|
|
405
409
|
* Workflow's verify-side node uses its own wrapper in the `id-verification`
|
|
406
410
|
* module that passes only `onContinue` (no attempts concept), matching the
|
|
407
411
|
* legacy SDK 1 `Workflow.tsx → ProcessId.jsx → ExpiredId` one-shot Continue
|
|
@@ -412,6 +416,7 @@ export declare const IdExpired: FC<IdExpiredProps>;
|
|
|
412
416
|
declare type IdExpiredProps = {
|
|
413
417
|
manager: IdCaptureManager;
|
|
414
418
|
attemptsRemaining: number;
|
|
419
|
+
isBackSide?: boolean;
|
|
415
420
|
};
|
|
416
421
|
|
|
417
422
|
export declare const IdFlipAnimation: FC<FlipAnimationProps>;
|
|
@@ -428,6 +433,26 @@ declare type IncodeComponentProps = {
|
|
|
428
433
|
children?: ComponentChildren;
|
|
429
434
|
};
|
|
430
435
|
|
|
436
|
+
/**
|
|
437
|
+
* Extra context passed to `onFinish` alongside the result. Lets a host decide
|
|
438
|
+
* how to react to the terminal state without inspecting the DOM. Only the
|
|
439
|
+
* workflow module sets these fields today.
|
|
440
|
+
*/
|
|
441
|
+
declare type IncodeFinishMeta = {
|
|
442
|
+
/**
|
|
443
|
+
* True when the SDK owns the terminal screen — it has already rendered its
|
|
444
|
+
* own finish UI (today, the workflow's `showFinishScreenBySessionStatus`
|
|
445
|
+
* screen), so the host should not render its own completion screen on top.
|
|
446
|
+
* `onFinish` still fires so the host can run side effects (e.g. notify an
|
|
447
|
+
* OAuth parent).
|
|
448
|
+
*
|
|
449
|
+
* Advisory only: the SDK cannot stop a host from rendering. This works solely
|
|
450
|
+
* because the host reads this flag — a host that ignores it will still
|
|
451
|
+
* replace the SDK screen. Not a guarantee.
|
|
452
|
+
*/
|
|
453
|
+
sdkOwnsTerminalScreen?: boolean;
|
|
454
|
+
};
|
|
455
|
+
|
|
431
456
|
export declare type IncodeModuleProps<TConfig, TResult = void, TManager = unknown> = {
|
|
432
457
|
/**
|
|
433
458
|
* Module configuration required to render the flow.
|
|
@@ -441,8 +466,10 @@ export declare type IncodeModuleProps<TConfig, TResult = void, TManager = unknow
|
|
|
441
466
|
/**
|
|
442
467
|
* Callback invoked when the module completes successfully.
|
|
443
468
|
* @param result - Optional result data from the module completion
|
|
469
|
+
* @param meta - Optional context about how the module resolved (e.g. whether
|
|
470
|
+
* the SDK rendered its own terminal finish screen). See {@link IncodeFinishMeta}.
|
|
444
471
|
*/
|
|
445
|
-
onFinish?: (result?: TResult) => void;
|
|
472
|
+
onFinish?: (result?: TResult, meta?: IncodeFinishMeta) => void;
|
|
446
473
|
/**
|
|
447
474
|
* Callback invoked when a fatal module error occurs.
|
|
448
475
|
*
|
|
@@ -847,6 +874,16 @@ declare type SpinnerProps = {
|
|
|
847
874
|
fullScreen?: boolean;
|
|
848
875
|
/** Additional CSS class name */
|
|
849
876
|
className?: string;
|
|
877
|
+
/**
|
|
878
|
+
* Render the spinner purely visually and hide it from assistive tech:
|
|
879
|
+
* no `role="status"`, no live region, no `aria-label`, no focus-on-mount,
|
|
880
|
+
* and `aria-hidden` on the container. The title/subtitle stay visible.
|
|
881
|
+
*
|
|
882
|
+
* Use when the spinner may sit behind a native OS surface (e.g. the camera
|
|
883
|
+
* permission prompt) where an announced/focusable status would leak — a
|
|
884
|
+
* screen reader must not be able to swipe into or hear it behind that prompt.
|
|
885
|
+
*/
|
|
886
|
+
presentational?: boolean;
|
|
850
887
|
};
|
|
851
888
|
|
|
852
889
|
export declare type SpinnerSize = 'small' | 'medium' | 'large';
|
|
@@ -30,6 +30,26 @@ export declare const FaceMatch: FC<FaceMatchProps>;
|
|
|
30
30
|
*/
|
|
31
31
|
declare type FaceMatchProps = IncodeModuleProps<FaceMatchConfig>;
|
|
32
32
|
|
|
33
|
+
/**
|
|
34
|
+
* Extra context passed to `onFinish` alongside the result. Lets a host decide
|
|
35
|
+
* how to react to the terminal state without inspecting the DOM. Only the
|
|
36
|
+
* workflow module sets these fields today.
|
|
37
|
+
*/
|
|
38
|
+
declare type IncodeFinishMeta = {
|
|
39
|
+
/**
|
|
40
|
+
* True when the SDK owns the terminal screen — it has already rendered its
|
|
41
|
+
* own finish UI (today, the workflow's `showFinishScreenBySessionStatus`
|
|
42
|
+
* screen), so the host should not render its own completion screen on top.
|
|
43
|
+
* `onFinish` still fires so the host can run side effects (e.g. notify an
|
|
44
|
+
* OAuth parent).
|
|
45
|
+
*
|
|
46
|
+
* Advisory only: the SDK cannot stop a host from rendering. This works solely
|
|
47
|
+
* because the host reads this flag — a host that ignores it will still
|
|
48
|
+
* replace the SDK screen. Not a guarantee.
|
|
49
|
+
*/
|
|
50
|
+
sdkOwnsTerminalScreen?: boolean;
|
|
51
|
+
};
|
|
52
|
+
|
|
33
53
|
declare type IncodeModuleProps<TConfig, TResult = void, TManager = unknown> = {
|
|
34
54
|
/**
|
|
35
55
|
* Module configuration required to render the flow.
|
|
@@ -43,8 +63,10 @@ declare type IncodeModuleProps<TConfig, TResult = void, TManager = unknown> = {
|
|
|
43
63
|
/**
|
|
44
64
|
* Callback invoked when the module completes successfully.
|
|
45
65
|
* @param result - Optional result data from the module completion
|
|
66
|
+
* @param meta - Optional context about how the module resolved (e.g. whether
|
|
67
|
+
* the SDK rendered its own terminal finish screen). See {@link IncodeFinishMeta}.
|
|
46
68
|
*/
|
|
47
|
-
onFinish?: (result?: TResult) => void;
|
|
69
|
+
onFinish?: (result?: TResult, meta?: IncodeFinishMeta) => void;
|
|
48
70
|
/**
|
|
49
71
|
* Callback invoked when a fatal module error occurs.
|
|
50
72
|
*
|
|
@@ -6,6 +6,26 @@ export declare const FieldComparison: FC<FieldComparisonProps>;
|
|
|
6
6
|
|
|
7
7
|
declare type FieldComparisonProps = IncodeModuleProps<FieldComparisonConfig, void, FieldComparisonManager>;
|
|
8
8
|
|
|
9
|
+
/**
|
|
10
|
+
* Extra context passed to `onFinish` alongside the result. Lets a host decide
|
|
11
|
+
* how to react to the terminal state without inspecting the DOM. Only the
|
|
12
|
+
* workflow module sets these fields today.
|
|
13
|
+
*/
|
|
14
|
+
declare type IncodeFinishMeta = {
|
|
15
|
+
/**
|
|
16
|
+
* True when the SDK owns the terminal screen — it has already rendered its
|
|
17
|
+
* own finish UI (today, the workflow's `showFinishScreenBySessionStatus`
|
|
18
|
+
* screen), so the host should not render its own completion screen on top.
|
|
19
|
+
* `onFinish` still fires so the host can run side effects (e.g. notify an
|
|
20
|
+
* OAuth parent).
|
|
21
|
+
*
|
|
22
|
+
* Advisory only: the SDK cannot stop a host from rendering. This works solely
|
|
23
|
+
* because the host reads this flag — a host that ignores it will still
|
|
24
|
+
* replace the SDK screen. Not a guarantee.
|
|
25
|
+
*/
|
|
26
|
+
sdkOwnsTerminalScreen?: boolean;
|
|
27
|
+
};
|
|
28
|
+
|
|
9
29
|
declare type IncodeModuleProps<TConfig, TResult = void, TManager = unknown> = {
|
|
10
30
|
/**
|
|
11
31
|
* Module configuration required to render the flow.
|
|
@@ -19,8 +39,10 @@ declare type IncodeModuleProps<TConfig, TResult = void, TManager = unknown> = {
|
|
|
19
39
|
/**
|
|
20
40
|
* Callback invoked when the module completes successfully.
|
|
21
41
|
* @param result - Optional result data from the module completion
|
|
42
|
+
* @param meta - Optional context about how the module resolved (e.g. whether
|
|
43
|
+
* the SDK rendered its own terminal finish screen). See {@link IncodeFinishMeta}.
|
|
22
44
|
*/
|
|
23
|
-
onFinish?: (result?: TResult) => void;
|
|
45
|
+
onFinish?: (result?: TResult, meta?: IncodeFinishMeta) => void;
|
|
24
46
|
/**
|
|
25
47
|
* Callback invoked when a fatal module error occurs.
|
|
26
48
|
*
|