@metamask-previews/kyc-controller 0.0.0-preview-e12b5ece6 → 0.0.0-preview-e0510042f
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/CHANGELOG.md +0 -12
- package/dist/KycController-method-action-types.cjs.map +1 -1
- package/dist/KycController-method-action-types.d.cts +4 -6
- package/dist/KycController-method-action-types.d.cts.map +1 -1
- package/dist/KycController-method-action-types.d.mts +4 -6
- package/dist/KycController-method-action-types.d.mts.map +1 -1
- package/dist/KycController-method-action-types.mjs.map +1 -1
- package/dist/KycController.cjs +150 -186
- package/dist/KycController.cjs.map +1 -1
- package/dist/KycController.d.cts +37 -43
- package/dist/KycController.d.cts.map +1 -1
- package/dist/KycController.d.mts +37 -43
- package/dist/KycController.d.mts.map +1 -1
- package/dist/KycController.mjs +149 -183
- package/dist/KycController.mjs.map +1 -1
- package/dist/KycService-method-action-types.cjs.map +1 -1
- package/dist/KycService-method-action-types.d.cts +6 -23
- package/dist/KycService-method-action-types.d.cts.map +1 -1
- package/dist/KycService-method-action-types.d.mts +6 -23
- package/dist/KycService-method-action-types.d.mts.map +1 -1
- package/dist/KycService-method-action-types.mjs.map +1 -1
- package/dist/KycService.cjs +119 -100
- package/dist/KycService.cjs.map +1 -1
- package/dist/KycService.d.cts +12 -38
- package/dist/KycService.d.cts.map +1 -1
- package/dist/KycService.d.mts +12 -38
- package/dist/KycService.d.mts.map +1 -1
- package/dist/KycService.mjs +119 -100
- package/dist/KycService.mjs.map +1 -1
- package/dist/index.cjs +1 -3
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +4 -4
- package/dist/index.d.cts.map +1 -1
- package/dist/index.d.mts +4 -4
- package/dist/index.d.mts.map +1 -1
- package/dist/index.mjs +1 -1
- package/dist/index.mjs.map +1 -1
- package/dist/types.cjs.map +1 -1
- package/dist/types.d.cts +5 -53
- package/dist/types.d.cts.map +1 -1
- package/dist/types.d.mts +5 -53
- package/dist/types.d.mts.map +1 -1
- package/dist/types.mjs.map +1 -1
- package/dist/ukyc/wrapEncryptionKey.cjs +9 -4
- package/dist/ukyc/wrapEncryptionKey.cjs.map +1 -1
- package/dist/ukyc/wrapEncryptionKey.d.cts +10 -8
- package/dist/ukyc/wrapEncryptionKey.d.cts.map +1 -1
- package/dist/ukyc/wrapEncryptionKey.d.mts +10 -8
- package/dist/ukyc/wrapEncryptionKey.d.mts.map +1 -1
- package/dist/ukyc/wrapEncryptionKey.mjs +9 -4
- package/dist/ukyc/wrapEncryptionKey.mjs.map +1 -1
- package/package.json +2 -2
- package/dist/logger.cjs +0 -9
- package/dist/logger.cjs.map +0 -1
- package/dist/logger.d.cts +0 -6
- package/dist/logger.d.cts.map +0 -1
- package/dist/logger.d.mts +0 -6
- package/dist/logger.d.mts.map +0 -1
- package/dist/logger.mjs +0 -6
- package/dist/logger.mjs.map +0 -1
- package/dist/vendorDisclaimerAcceptance.cjs +0 -74
- package/dist/vendorDisclaimerAcceptance.cjs.map +0 -1
- package/dist/vendorDisclaimerAcceptance.d.cts +0 -39
- package/dist/vendorDisclaimerAcceptance.d.cts.map +0 -1
- package/dist/vendorDisclaimerAcceptance.d.mts +0 -39
- package/dist/vendorDisclaimerAcceptance.d.mts.map +0 -1
- package/dist/vendorDisclaimerAcceptance.mjs +0 -67
- package/dist/vendorDisclaimerAcceptance.mjs.map +0 -1
package/dist/KycController.d.cts
CHANGED
|
@@ -5,7 +5,7 @@ import type { UserStorageControllerPerformGetStorageAction, UserStorageControlle
|
|
|
5
5
|
import type { Json } from "@metamask/utils";
|
|
6
6
|
import type { KycControllerMethodActions } from "./KycController-method-action-types.cjs";
|
|
7
7
|
import type { KycServiceMethodActions } from "./KycService-method-action-types.cjs";
|
|
8
|
-
import type {
|
|
8
|
+
import type { KycCustomerIdentity, KycDisclaimer, KycPhase, KycProduct, KycSessionDisclaimers, KycSessionStatus, KycSumSubLauncher, KycSumSubStatus, KycUserStatus, KycVendor } from "./types.cjs";
|
|
9
9
|
export declare const controllerName = "KycController";
|
|
10
10
|
/**
|
|
11
11
|
* Describes the shape of the state object for {@link KycController}.
|
|
@@ -19,27 +19,30 @@ export type KycControllerState = {
|
|
|
19
19
|
error: string | null;
|
|
20
20
|
/** Email associated with the session (sourced from the account). */
|
|
21
21
|
email: string | null;
|
|
22
|
+
/** ISO-8601 timestamp of the customer's terms acceptance (persisted). */
|
|
23
|
+
termsAcceptedAt: string | null;
|
|
24
|
+
/** IDs of the disclaimers the customer accepted (persisted). */
|
|
25
|
+
acceptedDisclaimerIds: string[];
|
|
22
26
|
/**
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
* `
|
|
27
|
+
* The vendor whose disclaimers `acceptedDisclaimerIds` belong to (persisted).
|
|
28
|
+
* Each vendor serves its own disclaimer set, so acceptance recorded for one
|
|
29
|
+
* vendor must not be reused for another. `null` when nothing is accepted.
|
|
26
30
|
*/
|
|
27
|
-
|
|
31
|
+
termsAcceptedVendor: KycVendor | null;
|
|
28
32
|
/**
|
|
29
|
-
*
|
|
30
|
-
* terms acceptance (persisted
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
* reacceptance).
|
|
33
|
+
* Whether the customer accepted the SumSub T&C (T&C2) during the last
|
|
34
|
+
* terms acceptance (persisted). Consents-path vendors require this flag
|
|
35
|
+
* when resuming a session. `null` for acceptance recorded before this
|
|
36
|
+
* field existed (treated as requiring reacceptance).
|
|
34
37
|
*/
|
|
35
|
-
|
|
38
|
+
sumsubTncAccepted: boolean | null;
|
|
36
39
|
/**
|
|
37
|
-
*
|
|
38
|
-
* acceptance (persisted
|
|
39
|
-
*
|
|
40
|
-
*
|
|
40
|
+
* Whether the customer accepted the idOS T&C (T&C2) during the last
|
|
41
|
+
* terms acceptance (persisted). Consents-path vendors require this flag
|
|
42
|
+
* when resuming a session. `null` for acceptance recorded before this
|
|
43
|
+
* field existed (treated as requiring reacceptance).
|
|
41
44
|
*/
|
|
42
|
-
|
|
45
|
+
idosTncAccepted: boolean | null;
|
|
43
46
|
/**
|
|
44
47
|
* Whether the customer consented to reuse existing idOS credentials
|
|
45
48
|
* during this session. Applied when recording session-scoped disclaimers.
|
|
@@ -47,22 +50,22 @@ export type KycControllerState = {
|
|
|
47
50
|
* `null` when never set (treated as `false`).
|
|
48
51
|
*/
|
|
49
52
|
credentialReusabilityConsentGiven: boolean | null;
|
|
50
|
-
/**
|
|
51
|
-
|
|
52
|
-
/** Error encountered while loading
|
|
53
|
-
|
|
53
|
+
/** Disclaimers fetched for the current country. */
|
|
54
|
+
disclaimers: KycDisclaimer[];
|
|
55
|
+
/** Error encountered while loading disclaimers, or `null`. */
|
|
56
|
+
disclaimersError: string | null;
|
|
54
57
|
/**
|
|
55
|
-
* idOS / KYC-provider disclaimer catalog from
|
|
56
|
-
* `GET /sessions/{sessionId}/disclaimers`. `null` until
|
|
57
|
-
*
|
|
58
|
+
* Session-scoped idOS / KYC-provider disclaimer catalog from
|
|
59
|
+
* `GET /sessions/{sessionId}/disclaimers`. `null` until a UKYC session
|
|
60
|
+
* exists and the catalog has been fetched.
|
|
58
61
|
*/
|
|
59
62
|
sessionDisclaimers: KycSessionDisclaimers | null;
|
|
60
63
|
/** Resolved ISO 3166-1 alpha-3 country code. */
|
|
61
64
|
geoCountry: string | null;
|
|
62
|
-
/**
|
|
63
|
-
|
|
64
|
-
/**
|
|
65
|
-
|
|
65
|
+
/** Vendor session token (not persisted, not logged). */
|
|
66
|
+
sessionToken: string | null;
|
|
67
|
+
/** Vendor access token (not persisted, not logged). */
|
|
68
|
+
accessToken: string | null;
|
|
66
69
|
/** Vendor customer id, used for the SumSub hand-off. */
|
|
67
70
|
moonpayCustomerId: string | null;
|
|
68
71
|
/**
|
|
@@ -106,13 +109,6 @@ export type KycControllerState = {
|
|
|
106
109
|
sessionStatus: KycSessionStatus | null;
|
|
107
110
|
};
|
|
108
111
|
};
|
|
109
|
-
/**
|
|
110
|
-
* Constructs the default {@link KycVendorDisclaimersAccepted} value.
|
|
111
|
-
*
|
|
112
|
-
* @returns The default vendor-disclaimer acceptance map.
|
|
113
|
-
*/
|
|
114
|
-
export declare function getDefaultKycVendorDisclaimersAccepted(): KycVendorDisclaimersAccepted;
|
|
115
|
-
export declare function getDefaultKycProviderDisclaimersAccepted(): KycProviderDisclaimersAccepted;
|
|
116
112
|
/**
|
|
117
113
|
* Constructs the default {@link KycController} state.
|
|
118
114
|
*
|
|
@@ -239,21 +235,19 @@ export declare class KycController extends BaseController<typeof controllerName,
|
|
|
239
235
|
* @param params.product - The consuming feature the flow runs for. See
|
|
240
236
|
* {@link initialize} for how the product drives the automatic post
|
|
241
237
|
* authentication continuation.
|
|
242
|
-
* @param params.
|
|
243
|
-
*
|
|
244
|
-
*
|
|
245
|
-
*
|
|
246
|
-
* customer accepted (`{ key, version }` records). Required for every vendor
|
|
247
|
-
* so callers explicitly declare acceptance.
|
|
238
|
+
* @param params.sumsubTncSigned - Whether Sumsub T&C were accepted (T&C2).
|
|
239
|
+
* Required for every vendor so callers explicitly declare acceptance.
|
|
240
|
+
* @param params.idosTncSigned - Whether idOS T&C were accepted (T&C2).
|
|
241
|
+
* Required for every vendor so callers explicitly declare acceptance.
|
|
248
242
|
* @param params.credentialReusabilityConsentGiven - Whether the customer
|
|
249
243
|
* consented to reuse existing idOS credentials. Used when recording
|
|
250
244
|
* session-scoped disclaimers on the consents path. Defaults to `false`.
|
|
251
245
|
*/
|
|
252
|
-
acceptTermsAndStartSession(params
|
|
246
|
+
acceptTermsAndStartSession(params: {
|
|
253
247
|
email?: string;
|
|
254
248
|
product?: KycProduct;
|
|
255
|
-
|
|
256
|
-
|
|
249
|
+
sumsubTncSigned: boolean;
|
|
250
|
+
idosTncSigned: boolean;
|
|
257
251
|
credentialReusabilityConsentGiven?: boolean;
|
|
258
252
|
}): Promise<void>;
|
|
259
253
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"KycController.d.cts","sourceRoot":"","sources":["../src/KycController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAE3B,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AACrD,OAAO,KAAK,EACV,4CAA4C,EAC5C,4CAA4C,EAC7C,uDAAuD;AACxD,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAO5C,OAAO,KAAK,EAAE,0BAA0B,EAAE,gDAA+C;AACzF,OAAO,KAAK,EAAE,uBAAuB,EAAE,6CAA4C;
|
|
1
|
+
{"version":3,"file":"KycController.d.cts","sourceRoot":"","sources":["../src/KycController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAE3B,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AACrD,OAAO,KAAK,EACV,4CAA4C,EAC5C,4CAA4C,EAC7C,uDAAuD;AACxD,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAO5C,OAAO,KAAK,EAAE,0BAA0B,EAAE,gDAA+C;AACzF,OAAO,KAAK,EAAE,uBAAuB,EAAE,6CAA4C;AAKnF,OAAO,KAAK,EAEV,mBAAmB,EACnB,aAAa,EACb,QAAQ,EACR,UAAU,EACV,qBAAqB,EACrB,gBAAgB,EAChB,iBAAiB,EACjB,eAAe,EACf,aAAa,EACb,SAAS,EACV,oBAAmB;AAcpB,eAAO,MAAM,cAAc,kBAAkB,CAAC;AAsF9C;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,0CAA0C;IAC1C,KAAK,EAAE,QAAQ,CAAC;IAChB,2DAA2D;IAC3D,aAAa,EAAE,MAAM,CAAC;IACtB,4CAA4C;IAC5C,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB,oEAAoE;IACpE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB,yEAAyE;IACzE,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,gEAAgE;IAChE,qBAAqB,EAAE,MAAM,EAAE,CAAC;IAChC;;;;OAIG;IACH,mBAAmB,EAAE,SAAS,GAAG,IAAI,CAAC;IACtC;;;;;OAKG;IACH,iBAAiB,EAAE,OAAO,GAAG,IAAI,CAAC;IAClC;;;;;OAKG;IACH,eAAe,EAAE,OAAO,GAAG,IAAI,CAAC;IAChC;;;;;OAKG;IACH,iCAAiC,EAAE,OAAO,GAAG,IAAI,CAAC;IAElD,mDAAmD;IACnD,WAAW,EAAE,aAAa,EAAE,CAAC;IAC7B,8DAA8D;IAC9D,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC;;;;OAIG;IACH,kBAAkB,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAEjD,gDAAgD;IAChD,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,wDAAwD;IACxD,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,uDAAuD;IACvD,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,wDAAwD;IACxD,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;;OAIG;IACH,YAAY,EAAE,SAAS,CAAC;IAExB;;;;;;OAMG;IACH,aAAa,EAAE,UAAU,GAAG,IAAI,CAAC;IAEjC,+DAA+D;IAC/D,oBAAoB,EAAE,OAAO,CAAC,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC;IAC3D,qEAAqE;IACrE,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;;;OAIG;IACH,UAAU,EAAE,aAAa,GAAG,IAAI,CAAC;IACjC,+DAA+D;IAC/D,yBAAyB,EAAE,MAAM,GAAG,IAAI,CAAC;IACzC,kEAAkE;IAClE,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC,mDAAmD;IACnD,MAAM,EAAE;QACN,MAAM,EAAE,eAAe,CAAC;QACxB,MAAM,EAAE,IAAI,GAAG,IAAI,CAAC;QACpB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QACzB,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;QACpC;;;WAGG;QACH,aAAa,EAAE,gBAAgB,GAAG,IAAI,CAAC;KACxC,CAAC;CACH,CAAC;AA2JF;;;;GAIG;AACH,wBAAgB,4BAA4B,IAAI,kBAAkB,CAkCjE;AAuHD,MAAM,MAAM,2BAA2B,GAAG,wBAAwB,CAChE,OAAO,cAAc,EACrB,kBAAkB,CACnB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAC5B,2BAA2B,GAC3B,0BAA0B,CAAC;AAE/B,KAAK,cAAc,GACf,uBAAuB,GACvB,4CAA4C,GAC5C,4CAA4C,CAAC;AAEjD,MAAM,MAAM,6BAA6B,GAAG,0BAA0B,CACpE,OAAO,cAAc,EACrB,kBAAkB,CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,GAAG,OAAO,cAAc,gBAAgB,CAAC;IAC/C,OAAO,EAAE;QACP;YACE,MAAM,EAAE,aAAa,CAAC;YACtB,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;YAC/B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;SAC1B;KACF,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAC3B,6BAA6B,GAC7B,+BAA+B,CAAC;AAEpC,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B,MAAM,MAAM,sBAAsB,GAAG,SAAS,CAC5C,OAAO,cAAc,EACrB,oBAAoB,GAAG,cAAc,EACrC,mBAAmB,GAAG,aAAa,CACpC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,SAAS,EAAE,sBAAsB,CAAC;IAClC,KAAK,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAC;IACpC;;;OAGG;IACH,cAAc,EAAE,iBAAiB,CAAC;IAClC;;;;OAIG;IACH,2BAA2B,CAAC,EAAE,MAAM,CAAC;IACrC;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC,CAAC;AAuBF;;;;;;GAMG;AACH,qBAAa,aAAc,SAAQ,cAAc,CAC/C,OAAO,cAAc,EACrB,kBAAkB,EAClB,sBAAsB,CACvB;;IAkDC;;;;;;;;;;;OAWG;gBACS,EACV,SAAS,EACT,KAAK,EACL,cAAc,EACd,2BAAqE,EACrE,wBAA+D,GAChE,EAAE,oBAAoB;IAmDvB;;;;;;;;;;;;;OAaG;IACG,UAAU,CAAC,MAAM,CAAC,EAAE;QACxB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,OAAO,CAAC,EAAE,UAAU,CAAC;QACrB,MAAM,CAAC,EAAE,SAAS,CAAC;KACpB,GAAG,OAAO,CAAC,IAAI,CAAC;IAqHjB;;;;;;;;;;;;OAYG;IACG,oBAAoB,CAAC,MAAM,EAAE;QACjC,MAAM,EAAE,SAAS,CAAC;QAClB,KAAK,EAAE,MAAM,CAAC;KACf,GAAG,OAAO,CAAC,IAAI,CAAC;IAkCjB;;;;;OAKG;IACG,eAAe,CAAC,MAAM,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAiCnE;;;;;;;;;;;;;;;;OAgBG;IACG,0BAA0B,CAAC,MAAM,EAAE;QACvC,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,OAAO,CAAC,EAAE,UAAU,CAAC;QACrB,eAAe,EAAE,OAAO,CAAC;QACzB,aAAa,EAAE,OAAO,CAAC;QACvB,iCAAiC,CAAC,EAAE,OAAO,CAAC;KAC7C,GAAG,OAAO,CAAC,IAAI,CAAC;IAuXjB;;OAEG;IACH,eAAe,IAAI,IAAI;IAuEvB;;;;;;;;;OASG;IACG,kBAAkB,CAAC,MAAM,EAAE;QAC/B,OAAO,EAAE,OAAO,CAAC;KAClB,GAAG,OAAO,CAAC;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC;IAkMhC;;;;OAIG;IACH,kBAAkB,IAAI,MAAM,GAAG,IAAI;IAYnC;;;;OAIG;IACH,iBAAiB,IAAI,MAAM,GAAG,IAAI;IAWlC;;;;OAIG;IACH,kBAAkB,IAAI,MAAM;IAM5B;;;;;;;OAOG;IACG,gBAAgB,CAAC,MAAM,EAAE;QAC7B,OAAO,EAAE,UAAU,CAAC;QACpB,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,GAAG,OAAO,CAAC,OAAO,CAAC;IA+CpB;;;;;;OAMG;IACH,YAAY,CAAC,MAAM,EAAE;QAAE,OAAO,EAAE,UAAU,CAAA;KAAE,GAAG,OAAO,GAAG,SAAS;IAIlE;;;;;;;;;;;;OAYG;IACH,mBAAmB,IAAI,mBAAmB,GAAG,IAAI;IAkKjD;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACG,WAAW,CAAC,MAAM,CAAC,EAAE;QACzB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,KAAK,CAAC,EAAE,OAAO,CAAC;KACjB,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAoKpC;;;;;;OAMG;IACG,gBAAgB,IAAI,OAAO,CAAC;QAChC,MAAM,EAAE,aAAa,CAAC;QACtB,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;QAC/B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;KAC1B,CAAC;IAoIF;;;;;;;OAOG;IACG,gBAAgB,IAAI,OAAO,CAAC,gBAAgB,CAAC;IAmHnD;;;OAGG;IACH,KAAK,IAAI,IAAI;IAyBb;;;;;;;OAOG;IACH,UAAU,IAAI,IAAI;CA4FnB"}
|
package/dist/KycController.d.mts
CHANGED
|
@@ -5,7 +5,7 @@ import type { UserStorageControllerPerformGetStorageAction, UserStorageControlle
|
|
|
5
5
|
import type { Json } from "@metamask/utils";
|
|
6
6
|
import type { KycControllerMethodActions } from "./KycController-method-action-types.mjs";
|
|
7
7
|
import type { KycServiceMethodActions } from "./KycService-method-action-types.mjs";
|
|
8
|
-
import type {
|
|
8
|
+
import type { KycCustomerIdentity, KycDisclaimer, KycPhase, KycProduct, KycSessionDisclaimers, KycSessionStatus, KycSumSubLauncher, KycSumSubStatus, KycUserStatus, KycVendor } from "./types.mjs";
|
|
9
9
|
export declare const controllerName = "KycController";
|
|
10
10
|
/**
|
|
11
11
|
* Describes the shape of the state object for {@link KycController}.
|
|
@@ -19,27 +19,30 @@ export type KycControllerState = {
|
|
|
19
19
|
error: string | null;
|
|
20
20
|
/** Email associated with the session (sourced from the account). */
|
|
21
21
|
email: string | null;
|
|
22
|
+
/** ISO-8601 timestamp of the customer's terms acceptance (persisted). */
|
|
23
|
+
termsAcceptedAt: string | null;
|
|
24
|
+
/** IDs of the disclaimers the customer accepted (persisted). */
|
|
25
|
+
acceptedDisclaimerIds: string[];
|
|
22
26
|
/**
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
* `
|
|
27
|
+
* The vendor whose disclaimers `acceptedDisclaimerIds` belong to (persisted).
|
|
28
|
+
* Each vendor serves its own disclaimer set, so acceptance recorded for one
|
|
29
|
+
* vendor must not be reused for another. `null` when nothing is accepted.
|
|
26
30
|
*/
|
|
27
|
-
|
|
31
|
+
termsAcceptedVendor: KycVendor | null;
|
|
28
32
|
/**
|
|
29
|
-
*
|
|
30
|
-
* terms acceptance (persisted
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
* reacceptance).
|
|
33
|
+
* Whether the customer accepted the SumSub T&C (T&C2) during the last
|
|
34
|
+
* terms acceptance (persisted). Consents-path vendors require this flag
|
|
35
|
+
* when resuming a session. `null` for acceptance recorded before this
|
|
36
|
+
* field existed (treated as requiring reacceptance).
|
|
34
37
|
*/
|
|
35
|
-
|
|
38
|
+
sumsubTncAccepted: boolean | null;
|
|
36
39
|
/**
|
|
37
|
-
*
|
|
38
|
-
* acceptance (persisted
|
|
39
|
-
*
|
|
40
|
-
*
|
|
40
|
+
* Whether the customer accepted the idOS T&C (T&C2) during the last
|
|
41
|
+
* terms acceptance (persisted). Consents-path vendors require this flag
|
|
42
|
+
* when resuming a session. `null` for acceptance recorded before this
|
|
43
|
+
* field existed (treated as requiring reacceptance).
|
|
41
44
|
*/
|
|
42
|
-
|
|
45
|
+
idosTncAccepted: boolean | null;
|
|
43
46
|
/**
|
|
44
47
|
* Whether the customer consented to reuse existing idOS credentials
|
|
45
48
|
* during this session. Applied when recording session-scoped disclaimers.
|
|
@@ -47,22 +50,22 @@ export type KycControllerState = {
|
|
|
47
50
|
* `null` when never set (treated as `false`).
|
|
48
51
|
*/
|
|
49
52
|
credentialReusabilityConsentGiven: boolean | null;
|
|
50
|
-
/**
|
|
51
|
-
|
|
52
|
-
/** Error encountered while loading
|
|
53
|
-
|
|
53
|
+
/** Disclaimers fetched for the current country. */
|
|
54
|
+
disclaimers: KycDisclaimer[];
|
|
55
|
+
/** Error encountered while loading disclaimers, or `null`. */
|
|
56
|
+
disclaimersError: string | null;
|
|
54
57
|
/**
|
|
55
|
-
* idOS / KYC-provider disclaimer catalog from
|
|
56
|
-
* `GET /sessions/{sessionId}/disclaimers`. `null` until
|
|
57
|
-
*
|
|
58
|
+
* Session-scoped idOS / KYC-provider disclaimer catalog from
|
|
59
|
+
* `GET /sessions/{sessionId}/disclaimers`. `null` until a UKYC session
|
|
60
|
+
* exists and the catalog has been fetched.
|
|
58
61
|
*/
|
|
59
62
|
sessionDisclaimers: KycSessionDisclaimers | null;
|
|
60
63
|
/** Resolved ISO 3166-1 alpha-3 country code. */
|
|
61
64
|
geoCountry: string | null;
|
|
62
|
-
/**
|
|
63
|
-
|
|
64
|
-
/**
|
|
65
|
-
|
|
65
|
+
/** Vendor session token (not persisted, not logged). */
|
|
66
|
+
sessionToken: string | null;
|
|
67
|
+
/** Vendor access token (not persisted, not logged). */
|
|
68
|
+
accessToken: string | null;
|
|
66
69
|
/** Vendor customer id, used for the SumSub hand-off. */
|
|
67
70
|
moonpayCustomerId: string | null;
|
|
68
71
|
/**
|
|
@@ -106,13 +109,6 @@ export type KycControllerState = {
|
|
|
106
109
|
sessionStatus: KycSessionStatus | null;
|
|
107
110
|
};
|
|
108
111
|
};
|
|
109
|
-
/**
|
|
110
|
-
* Constructs the default {@link KycVendorDisclaimersAccepted} value.
|
|
111
|
-
*
|
|
112
|
-
* @returns The default vendor-disclaimer acceptance map.
|
|
113
|
-
*/
|
|
114
|
-
export declare function getDefaultKycVendorDisclaimersAccepted(): KycVendorDisclaimersAccepted;
|
|
115
|
-
export declare function getDefaultKycProviderDisclaimersAccepted(): KycProviderDisclaimersAccepted;
|
|
116
112
|
/**
|
|
117
113
|
* Constructs the default {@link KycController} state.
|
|
118
114
|
*
|
|
@@ -239,21 +235,19 @@ export declare class KycController extends BaseController<typeof controllerName,
|
|
|
239
235
|
* @param params.product - The consuming feature the flow runs for. See
|
|
240
236
|
* {@link initialize} for how the product drives the automatic post
|
|
241
237
|
* authentication continuation.
|
|
242
|
-
* @param params.
|
|
243
|
-
*
|
|
244
|
-
*
|
|
245
|
-
*
|
|
246
|
-
* customer accepted (`{ key, version }` records). Required for every vendor
|
|
247
|
-
* so callers explicitly declare acceptance.
|
|
238
|
+
* @param params.sumsubTncSigned - Whether Sumsub T&C were accepted (T&C2).
|
|
239
|
+
* Required for every vendor so callers explicitly declare acceptance.
|
|
240
|
+
* @param params.idosTncSigned - Whether idOS T&C were accepted (T&C2).
|
|
241
|
+
* Required for every vendor so callers explicitly declare acceptance.
|
|
248
242
|
* @param params.credentialReusabilityConsentGiven - Whether the customer
|
|
249
243
|
* consented to reuse existing idOS credentials. Used when recording
|
|
250
244
|
* session-scoped disclaimers on the consents path. Defaults to `false`.
|
|
251
245
|
*/
|
|
252
|
-
acceptTermsAndStartSession(params
|
|
246
|
+
acceptTermsAndStartSession(params: {
|
|
253
247
|
email?: string;
|
|
254
248
|
product?: KycProduct;
|
|
255
|
-
|
|
256
|
-
|
|
249
|
+
sumsubTncSigned: boolean;
|
|
250
|
+
idosTncSigned: boolean;
|
|
257
251
|
credentialReusabilityConsentGiven?: boolean;
|
|
258
252
|
}): Promise<void>;
|
|
259
253
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"KycController.d.mts","sourceRoot":"","sources":["../src/KycController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAE3B,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AACrD,OAAO,KAAK,EACV,4CAA4C,EAC5C,4CAA4C,EAC7C,uDAAuD;AACxD,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAO5C,OAAO,KAAK,EAAE,0BAA0B,EAAE,gDAA+C;AACzF,OAAO,KAAK,EAAE,uBAAuB,EAAE,6CAA4C;
|
|
1
|
+
{"version":3,"file":"KycController.d.mts","sourceRoot":"","sources":["../src/KycController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAE3B,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AACrD,OAAO,KAAK,EACV,4CAA4C,EAC5C,4CAA4C,EAC7C,uDAAuD;AACxD,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAO5C,OAAO,KAAK,EAAE,0BAA0B,EAAE,gDAA+C;AACzF,OAAO,KAAK,EAAE,uBAAuB,EAAE,6CAA4C;AAKnF,OAAO,KAAK,EAEV,mBAAmB,EACnB,aAAa,EACb,QAAQ,EACR,UAAU,EACV,qBAAqB,EACrB,gBAAgB,EAChB,iBAAiB,EACjB,eAAe,EACf,aAAa,EACb,SAAS,EACV,oBAAmB;AAcpB,eAAO,MAAM,cAAc,kBAAkB,CAAC;AAsF9C;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,0CAA0C;IAC1C,KAAK,EAAE,QAAQ,CAAC;IAChB,2DAA2D;IAC3D,aAAa,EAAE,MAAM,CAAC;IACtB,4CAA4C;IAC5C,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB,oEAAoE;IACpE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB,yEAAyE;IACzE,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,gEAAgE;IAChE,qBAAqB,EAAE,MAAM,EAAE,CAAC;IAChC;;;;OAIG;IACH,mBAAmB,EAAE,SAAS,GAAG,IAAI,CAAC;IACtC;;;;;OAKG;IACH,iBAAiB,EAAE,OAAO,GAAG,IAAI,CAAC;IAClC;;;;;OAKG;IACH,eAAe,EAAE,OAAO,GAAG,IAAI,CAAC;IAChC;;;;;OAKG;IACH,iCAAiC,EAAE,OAAO,GAAG,IAAI,CAAC;IAElD,mDAAmD;IACnD,WAAW,EAAE,aAAa,EAAE,CAAC;IAC7B,8DAA8D;IAC9D,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC;;;;OAIG;IACH,kBAAkB,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAEjD,gDAAgD;IAChD,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,wDAAwD;IACxD,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,uDAAuD;IACvD,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,wDAAwD;IACxD,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;;OAIG;IACH,YAAY,EAAE,SAAS,CAAC;IAExB;;;;;;OAMG;IACH,aAAa,EAAE,UAAU,GAAG,IAAI,CAAC;IAEjC,+DAA+D;IAC/D,oBAAoB,EAAE,OAAO,CAAC,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC;IAC3D,qEAAqE;IACrE,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;;;OAIG;IACH,UAAU,EAAE,aAAa,GAAG,IAAI,CAAC;IACjC,+DAA+D;IAC/D,yBAAyB,EAAE,MAAM,GAAG,IAAI,CAAC;IACzC,kEAAkE;IAClE,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC,mDAAmD;IACnD,MAAM,EAAE;QACN,MAAM,EAAE,eAAe,CAAC;QACxB,MAAM,EAAE,IAAI,GAAG,IAAI,CAAC;QACpB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QACzB,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;QACpC;;;WAGG;QACH,aAAa,EAAE,gBAAgB,GAAG,IAAI,CAAC;KACxC,CAAC;CACH,CAAC;AA2JF;;;;GAIG;AACH,wBAAgB,4BAA4B,IAAI,kBAAkB,CAkCjE;AAuHD,MAAM,MAAM,2BAA2B,GAAG,wBAAwB,CAChE,OAAO,cAAc,EACrB,kBAAkB,CACnB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAC5B,2BAA2B,GAC3B,0BAA0B,CAAC;AAE/B,KAAK,cAAc,GACf,uBAAuB,GACvB,4CAA4C,GAC5C,4CAA4C,CAAC;AAEjD,MAAM,MAAM,6BAA6B,GAAG,0BAA0B,CACpE,OAAO,cAAc,EACrB,kBAAkB,CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,GAAG,OAAO,cAAc,gBAAgB,CAAC;IAC/C,OAAO,EAAE;QACP;YACE,MAAM,EAAE,aAAa,CAAC;YACtB,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;YAC/B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;SAC1B;KACF,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAC3B,6BAA6B,GAC7B,+BAA+B,CAAC;AAEpC,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B,MAAM,MAAM,sBAAsB,GAAG,SAAS,CAC5C,OAAO,cAAc,EACrB,oBAAoB,GAAG,cAAc,EACrC,mBAAmB,GAAG,aAAa,CACpC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,SAAS,EAAE,sBAAsB,CAAC;IAClC,KAAK,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAC;IACpC;;;OAGG;IACH,cAAc,EAAE,iBAAiB,CAAC;IAClC;;;;OAIG;IACH,2BAA2B,CAAC,EAAE,MAAM,CAAC;IACrC;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC,CAAC;AAuBF;;;;;;GAMG;AACH,qBAAa,aAAc,SAAQ,cAAc,CAC/C,OAAO,cAAc,EACrB,kBAAkB,EAClB,sBAAsB,CACvB;;IAkDC;;;;;;;;;;;OAWG;gBACS,EACV,SAAS,EACT,KAAK,EACL,cAAc,EACd,2BAAqE,EACrE,wBAA+D,GAChE,EAAE,oBAAoB;IAmDvB;;;;;;;;;;;;;OAaG;IACG,UAAU,CAAC,MAAM,CAAC,EAAE;QACxB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,OAAO,CAAC,EAAE,UAAU,CAAC;QACrB,MAAM,CAAC,EAAE,SAAS,CAAC;KACpB,GAAG,OAAO,CAAC,IAAI,CAAC;IAqHjB;;;;;;;;;;;;OAYG;IACG,oBAAoB,CAAC,MAAM,EAAE;QACjC,MAAM,EAAE,SAAS,CAAC;QAClB,KAAK,EAAE,MAAM,CAAC;KACf,GAAG,OAAO,CAAC,IAAI,CAAC;IAkCjB;;;;;OAKG;IACG,eAAe,CAAC,MAAM,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAiCnE;;;;;;;;;;;;;;;;OAgBG;IACG,0BAA0B,CAAC,MAAM,EAAE;QACvC,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,OAAO,CAAC,EAAE,UAAU,CAAC;QACrB,eAAe,EAAE,OAAO,CAAC;QACzB,aAAa,EAAE,OAAO,CAAC;QACvB,iCAAiC,CAAC,EAAE,OAAO,CAAC;KAC7C,GAAG,OAAO,CAAC,IAAI,CAAC;IAuXjB;;OAEG;IACH,eAAe,IAAI,IAAI;IAuEvB;;;;;;;;;OASG;IACG,kBAAkB,CAAC,MAAM,EAAE;QAC/B,OAAO,EAAE,OAAO,CAAC;KAClB,GAAG,OAAO,CAAC;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC;IAkMhC;;;;OAIG;IACH,kBAAkB,IAAI,MAAM,GAAG,IAAI;IAYnC;;;;OAIG;IACH,iBAAiB,IAAI,MAAM,GAAG,IAAI;IAWlC;;;;OAIG;IACH,kBAAkB,IAAI,MAAM;IAM5B;;;;;;;OAOG;IACG,gBAAgB,CAAC,MAAM,EAAE;QAC7B,OAAO,EAAE,UAAU,CAAC;QACpB,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,GAAG,OAAO,CAAC,OAAO,CAAC;IA+CpB;;;;;;OAMG;IACH,YAAY,CAAC,MAAM,EAAE;QAAE,OAAO,EAAE,UAAU,CAAA;KAAE,GAAG,OAAO,GAAG,SAAS;IAIlE;;;;;;;;;;;;OAYG;IACH,mBAAmB,IAAI,mBAAmB,GAAG,IAAI;IAkKjD;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACG,WAAW,CAAC,MAAM,CAAC,EAAE;QACzB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,KAAK,CAAC,EAAE,OAAO,CAAC;KACjB,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAoKpC;;;;;;OAMG;IACG,gBAAgB,IAAI,OAAO,CAAC;QAChC,MAAM,EAAE,aAAa,CAAC;QACtB,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;QAC/B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;KAC1B,CAAC;IAoIF;;;;;;;OAOG;IACG,gBAAgB,IAAI,OAAO,CAAC,gBAAgB,CAAC;IAmHnD;;;OAGG;IACH,KAAK,IAAI,IAAI;IAyBb;;;;;;;OAOG;IACH,UAAU,IAAI,IAAI;CA4FnB"}
|