@metamask-previews/kyc-controller 0.0.0-preview-b63fbdb38 → 0.0.0-preview-e12b5ece6
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 +12 -0
- package/dist/KycController-method-action-types.cjs.map +1 -1
- package/dist/KycController-method-action-types.d.cts +6 -4
- package/dist/KycController-method-action-types.d.cts.map +1 -1
- package/dist/KycController-method-action-types.d.mts +6 -4
- 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 +186 -150
- package/dist/KycController.cjs.map +1 -1
- package/dist/KycController.d.cts +43 -37
- package/dist/KycController.d.cts.map +1 -1
- package/dist/KycController.d.mts +43 -37
- package/dist/KycController.d.mts.map +1 -1
- package/dist/KycController.mjs +183 -149
- 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 +23 -6
- package/dist/KycService-method-action-types.d.cts.map +1 -1
- package/dist/KycService-method-action-types.d.mts +23 -6
- 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 +100 -119
- package/dist/KycService.cjs.map +1 -1
- package/dist/KycService.d.cts +38 -12
- package/dist/KycService.d.cts.map +1 -1
- package/dist/KycService.d.mts +38 -12
- package/dist/KycService.d.mts.map +1 -1
- package/dist/KycService.mjs +100 -119
- package/dist/KycService.mjs.map +1 -1
- package/dist/index.cjs +3 -1
- 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/logger.cjs +9 -0
- package/dist/logger.cjs.map +1 -0
- package/dist/logger.d.cts +6 -0
- package/dist/logger.d.cts.map +1 -0
- package/dist/logger.d.mts +6 -0
- package/dist/logger.d.mts.map +1 -0
- package/dist/logger.mjs +6 -0
- package/dist/logger.mjs.map +1 -0
- package/dist/types.cjs.map +1 -1
- package/dist/types.d.cts +53 -5
- package/dist/types.d.cts.map +1 -1
- package/dist/types.d.mts +53 -5
- package/dist/types.d.mts.map +1 -1
- package/dist/types.mjs.map +1 -1
- package/dist/ukyc/wrapEncryptionKey.cjs +4 -9
- package/dist/ukyc/wrapEncryptionKey.cjs.map +1 -1
- package/dist/ukyc/wrapEncryptionKey.d.cts +8 -10
- package/dist/ukyc/wrapEncryptionKey.d.cts.map +1 -1
- package/dist/ukyc/wrapEncryptionKey.d.mts +8 -10
- package/dist/ukyc/wrapEncryptionKey.d.mts.map +1 -1
- package/dist/ukyc/wrapEncryptionKey.mjs +4 -9
- package/dist/ukyc/wrapEncryptionKey.mjs.map +1 -1
- package/dist/vendorDisclaimerAcceptance.cjs +74 -0
- package/dist/vendorDisclaimerAcceptance.cjs.map +1 -0
- package/dist/vendorDisclaimerAcceptance.d.cts +39 -0
- package/dist/vendorDisclaimerAcceptance.d.cts.map +1 -0
- package/dist/vendorDisclaimerAcceptance.d.mts +39 -0
- package/dist/vendorDisclaimerAcceptance.d.mts.map +1 -0
- package/dist/vendorDisclaimerAcceptance.mjs +67 -0
- package/dist/vendorDisclaimerAcceptance.mjs.map +1 -0
- package/package.json +2 -2
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 { KycCustomerIdentity, KycDisclaimer, KycPhase, KycProduct, KycSessionDisclaimers, KycSessionStatus, KycSumSubLauncher, KycSumSubStatus, KycUserStatus, KycVendor } from "./types.cjs";
|
|
8
|
+
import type { KycConsentRecord, KycCustomerIdentity, KycDisclaimer, KycPhase, KycProduct, KycProviderDisclaimersAccepted, KycSessionDisclaimers, KycSessionStatus, KycSumSubLauncher, KycSumSubStatus, KycUserStatus, KycVendor, KycVendorDisclaimersAccepted } 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,30 +19,27 @@ 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[];
|
|
26
22
|
/**
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
23
|
+
* Persisted vendor-disclaimer acceptance (T&C1) with fixed `moonpay` and
|
|
24
|
+
* `iron` keys. MoonPay stores only `termsAcceptedAt`; Iron stores
|
|
25
|
+
* `disclaimerIds`.
|
|
30
26
|
*/
|
|
31
|
-
|
|
27
|
+
vendorDisclaimersAccepted: KycVendorDisclaimersAccepted;
|
|
32
28
|
/**
|
|
33
|
-
*
|
|
34
|
-
* terms acceptance (persisted
|
|
35
|
-
* when resuming a session. `null` for
|
|
36
|
-
* field existed (treated as requiring
|
|
29
|
+
* KYC-provider disclaimer documents the customer accepted during the last
|
|
30
|
+
* terms acceptance (persisted `{ key, version }` records under `sumsub`).
|
|
31
|
+
* Consents-path vendors require this when resuming a session. `null` for
|
|
32
|
+
* acceptance recorded before this field existed (treated as requiring
|
|
33
|
+
* reacceptance).
|
|
37
34
|
*/
|
|
38
|
-
|
|
35
|
+
providerDisclaimersAccepted: KycProviderDisclaimersAccepted;
|
|
39
36
|
/**
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
* when resuming a session. `null` for acceptance recorded
|
|
43
|
-
* field existed (treated as requiring reacceptance).
|
|
37
|
+
* idOS disclaimer documents the customer accepted during the last terms
|
|
38
|
+
* acceptance (persisted `{ key, version }` records). Consents-path vendors
|
|
39
|
+
* require this when resuming a session. `null` for acceptance recorded
|
|
40
|
+
* before this field existed (treated as requiring reacceptance).
|
|
44
41
|
*/
|
|
45
|
-
|
|
42
|
+
idosDisclaimersAccepted: KycConsentRecord[] | null;
|
|
46
43
|
/**
|
|
47
44
|
* Whether the customer consented to reuse existing idOS credentials
|
|
48
45
|
* during this session. Applied when recording session-scoped disclaimers.
|
|
@@ -50,22 +47,22 @@ export type KycControllerState = {
|
|
|
50
47
|
* `null` when never set (treated as `false`).
|
|
51
48
|
*/
|
|
52
49
|
credentialReusabilityConsentGiven: boolean | null;
|
|
53
|
-
/**
|
|
54
|
-
|
|
55
|
-
/** Error encountered while loading disclaimers, or `null`. */
|
|
56
|
-
|
|
50
|
+
/** Vendor disclaimers fetched for the current country. */
|
|
51
|
+
vendorDisclaimers: KycDisclaimer[];
|
|
52
|
+
/** Error encountered while loading vendor disclaimers, or `null`. */
|
|
53
|
+
vendorError: string | null;
|
|
57
54
|
/**
|
|
58
|
-
*
|
|
59
|
-
* `GET /sessions/{sessionId}/disclaimers`. `null` until
|
|
60
|
-
*
|
|
55
|
+
* idOS / KYC-provider disclaimer catalog from `GET /disclaimers` or
|
|
56
|
+
* `GET /sessions/{sessionId}/disclaimers`. `null` until the catalog has
|
|
57
|
+
* been fetched (typically after a UKYC session exists).
|
|
61
58
|
*/
|
|
62
59
|
sessionDisclaimers: KycSessionDisclaimers | null;
|
|
63
60
|
/** Resolved ISO 3166-1 alpha-3 country code. */
|
|
64
61
|
geoCountry: string | null;
|
|
65
|
-
/**
|
|
66
|
-
|
|
67
|
-
/**
|
|
68
|
-
|
|
62
|
+
/** MoonPay session token (not persisted, not logged). */
|
|
63
|
+
moonpaySessionToken: string | null;
|
|
64
|
+
/** MoonPay access token (not persisted, not logged). */
|
|
65
|
+
moonpayAccessToken: string | null;
|
|
69
66
|
/** Vendor customer id, used for the SumSub hand-off. */
|
|
70
67
|
moonpayCustomerId: string | null;
|
|
71
68
|
/**
|
|
@@ -109,6 +106,13 @@ export type KycControllerState = {
|
|
|
109
106
|
sessionStatus: KycSessionStatus | null;
|
|
110
107
|
};
|
|
111
108
|
};
|
|
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;
|
|
112
116
|
/**
|
|
113
117
|
* Constructs the default {@link KycController} state.
|
|
114
118
|
*
|
|
@@ -235,19 +239,21 @@ export declare class KycController extends BaseController<typeof controllerName,
|
|
|
235
239
|
* @param params.product - The consuming feature the flow runs for. See
|
|
236
240
|
* {@link initialize} for how the product drives the automatic post
|
|
237
241
|
* authentication continuation.
|
|
238
|
-
* @param params.
|
|
239
|
-
*
|
|
240
|
-
*
|
|
241
|
-
*
|
|
242
|
+
* @param params.providerDisclaimersAccepted - Sumsub disclaimer documents the
|
|
243
|
+
* customer accepted (`{ key, version }` records). Required for every vendor
|
|
244
|
+
* so callers explicitly declare acceptance.
|
|
245
|
+
* @param params.idosDisclaimersAccepted - idOS disclaimer documents the
|
|
246
|
+
* customer accepted (`{ key, version }` records). Required for every vendor
|
|
247
|
+
* so callers explicitly declare acceptance.
|
|
242
248
|
* @param params.credentialReusabilityConsentGiven - Whether the customer
|
|
243
249
|
* consented to reuse existing idOS credentials. Used when recording
|
|
244
250
|
* session-scoped disclaimers on the consents path. Defaults to `false`.
|
|
245
251
|
*/
|
|
246
|
-
acceptTermsAndStartSession(params
|
|
252
|
+
acceptTermsAndStartSession(params?: {
|
|
247
253
|
email?: string;
|
|
248
254
|
product?: KycProduct;
|
|
249
|
-
|
|
250
|
-
|
|
255
|
+
providerDisclaimersAccepted: KycConsentRecord[];
|
|
256
|
+
idosDisclaimersAccepted: KycConsentRecord[];
|
|
251
257
|
credentialReusabilityConsentGiven?: boolean;
|
|
252
258
|
}): Promise<void>;
|
|
253
259
|
/**
|
|
@@ -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;AAMnF,OAAO,KAAK,EAEV,gBAAgB,EAChB,mBAAmB,EACnB,aAAa,EACb,QAAQ,EACR,UAAU,EACV,8BAA8B,EAC9B,qBAAqB,EACrB,gBAAgB,EAChB,iBAAiB,EACjB,eAAe,EACf,aAAa,EACb,SAAS,EACT,4BAA4B,EAC7B,oBAAmB;AAoBpB,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;;;;OAIG;IACH,yBAAyB,EAAE,4BAA4B,CAAC;IACxD;;;;;;OAMG;IACH,2BAA2B,EAAE,8BAA8B,CAAC;IAC5D;;;;;OAKG;IACH,uBAAuB,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC;IACnD;;;;;OAKG;IACH,iCAAiC,EAAE,OAAO,GAAG,IAAI,CAAC;IAElD,0DAA0D;IAC1D,iBAAiB,EAAE,aAAa,EAAE,CAAC;IACnC,qEAAqE;IACrE,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B;;;;OAIG;IACH,kBAAkB,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAEjD,gDAAgD;IAChD,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,yDAAyD;IACzD,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,wDAAwD;IACxD,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,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;AA+IF;;;;GAIG;AACH,wBAAgB,sCAAsC,IAAI,4BAA4B,CAErF;AAED,wBAAgB,wCAAwC,IAAI,8BAA8B,CAEzF;AAED;;;;GAIG;AACH,wBAAgB,4BAA4B,IAAI,kBAAkB,CAgCjE;AAuJD,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;IAkDvB;;;;;;;;;;;;;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;IAuIjB;;;;;;;;;;;;OAYG;IACG,oBAAoB,CAAC,MAAM,EAAE;QACjC,MAAM,EAAE,SAAS,CAAC;QAClB,KAAK,EAAE,MAAM,CAAC;KACf,GAAG,OAAO,CAAC,IAAI,CAAC;IA+BjB;;;;;OAKG;IACG,eAAe,CAAC,MAAM,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAiCnE;;;;;;;;;;;;;;;;;;OAkBG;IACG,0BAA0B,CAAC,MAAM,CAAC,EAAE;QACxC,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,OAAO,CAAC,EAAE,UAAU,CAAC;QACrB,2BAA2B,EAAE,gBAAgB,EAAE,CAAC;QAChD,uBAAuB,EAAE,gBAAgB,EAAE,CAAC;QAC5C,iCAAiC,CAAC,EAAE,OAAO,CAAC;KAC7C,GAAG,OAAO,CAAC,IAAI,CAAC;IAwYjB;;OAEG;IACH,eAAe,IAAI,IAAI;IAgDvB;;;;;;;;;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;IAgBnC;;;;OAIG;IACH,iBAAiB,IAAI,MAAM,GAAG,IAAI;IAelC;;;;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;IAqDpB;;;;;;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 { KycCustomerIdentity, KycDisclaimer, KycPhase, KycProduct, KycSessionDisclaimers, KycSessionStatus, KycSumSubLauncher, KycSumSubStatus, KycUserStatus, KycVendor } from "./types.mjs";
|
|
8
|
+
import type { KycConsentRecord, KycCustomerIdentity, KycDisclaimer, KycPhase, KycProduct, KycProviderDisclaimersAccepted, KycSessionDisclaimers, KycSessionStatus, KycSumSubLauncher, KycSumSubStatus, KycUserStatus, KycVendor, KycVendorDisclaimersAccepted } 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,30 +19,27 @@ 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[];
|
|
26
22
|
/**
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
23
|
+
* Persisted vendor-disclaimer acceptance (T&C1) with fixed `moonpay` and
|
|
24
|
+
* `iron` keys. MoonPay stores only `termsAcceptedAt`; Iron stores
|
|
25
|
+
* `disclaimerIds`.
|
|
30
26
|
*/
|
|
31
|
-
|
|
27
|
+
vendorDisclaimersAccepted: KycVendorDisclaimersAccepted;
|
|
32
28
|
/**
|
|
33
|
-
*
|
|
34
|
-
* terms acceptance (persisted
|
|
35
|
-
* when resuming a session. `null` for
|
|
36
|
-
* field existed (treated as requiring
|
|
29
|
+
* KYC-provider disclaimer documents the customer accepted during the last
|
|
30
|
+
* terms acceptance (persisted `{ key, version }` records under `sumsub`).
|
|
31
|
+
* Consents-path vendors require this when resuming a session. `null` for
|
|
32
|
+
* acceptance recorded before this field existed (treated as requiring
|
|
33
|
+
* reacceptance).
|
|
37
34
|
*/
|
|
38
|
-
|
|
35
|
+
providerDisclaimersAccepted: KycProviderDisclaimersAccepted;
|
|
39
36
|
/**
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
* when resuming a session. `null` for acceptance recorded
|
|
43
|
-
* field existed (treated as requiring reacceptance).
|
|
37
|
+
* idOS disclaimer documents the customer accepted during the last terms
|
|
38
|
+
* acceptance (persisted `{ key, version }` records). Consents-path vendors
|
|
39
|
+
* require this when resuming a session. `null` for acceptance recorded
|
|
40
|
+
* before this field existed (treated as requiring reacceptance).
|
|
44
41
|
*/
|
|
45
|
-
|
|
42
|
+
idosDisclaimersAccepted: KycConsentRecord[] | null;
|
|
46
43
|
/**
|
|
47
44
|
* Whether the customer consented to reuse existing idOS credentials
|
|
48
45
|
* during this session. Applied when recording session-scoped disclaimers.
|
|
@@ -50,22 +47,22 @@ export type KycControllerState = {
|
|
|
50
47
|
* `null` when never set (treated as `false`).
|
|
51
48
|
*/
|
|
52
49
|
credentialReusabilityConsentGiven: boolean | null;
|
|
53
|
-
/**
|
|
54
|
-
|
|
55
|
-
/** Error encountered while loading disclaimers, or `null`. */
|
|
56
|
-
|
|
50
|
+
/** Vendor disclaimers fetched for the current country. */
|
|
51
|
+
vendorDisclaimers: KycDisclaimer[];
|
|
52
|
+
/** Error encountered while loading vendor disclaimers, or `null`. */
|
|
53
|
+
vendorError: string | null;
|
|
57
54
|
/**
|
|
58
|
-
*
|
|
59
|
-
* `GET /sessions/{sessionId}/disclaimers`. `null` until
|
|
60
|
-
*
|
|
55
|
+
* idOS / KYC-provider disclaimer catalog from `GET /disclaimers` or
|
|
56
|
+
* `GET /sessions/{sessionId}/disclaimers`. `null` until the catalog has
|
|
57
|
+
* been fetched (typically after a UKYC session exists).
|
|
61
58
|
*/
|
|
62
59
|
sessionDisclaimers: KycSessionDisclaimers | null;
|
|
63
60
|
/** Resolved ISO 3166-1 alpha-3 country code. */
|
|
64
61
|
geoCountry: string | null;
|
|
65
|
-
/**
|
|
66
|
-
|
|
67
|
-
/**
|
|
68
|
-
|
|
62
|
+
/** MoonPay session token (not persisted, not logged). */
|
|
63
|
+
moonpaySessionToken: string | null;
|
|
64
|
+
/** MoonPay access token (not persisted, not logged). */
|
|
65
|
+
moonpayAccessToken: string | null;
|
|
69
66
|
/** Vendor customer id, used for the SumSub hand-off. */
|
|
70
67
|
moonpayCustomerId: string | null;
|
|
71
68
|
/**
|
|
@@ -109,6 +106,13 @@ export type KycControllerState = {
|
|
|
109
106
|
sessionStatus: KycSessionStatus | null;
|
|
110
107
|
};
|
|
111
108
|
};
|
|
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;
|
|
112
116
|
/**
|
|
113
117
|
* Constructs the default {@link KycController} state.
|
|
114
118
|
*
|
|
@@ -235,19 +239,21 @@ export declare class KycController extends BaseController<typeof controllerName,
|
|
|
235
239
|
* @param params.product - The consuming feature the flow runs for. See
|
|
236
240
|
* {@link initialize} for how the product drives the automatic post
|
|
237
241
|
* authentication continuation.
|
|
238
|
-
* @param params.
|
|
239
|
-
*
|
|
240
|
-
*
|
|
241
|
-
*
|
|
242
|
+
* @param params.providerDisclaimersAccepted - Sumsub disclaimer documents the
|
|
243
|
+
* customer accepted (`{ key, version }` records). Required for every vendor
|
|
244
|
+
* so callers explicitly declare acceptance.
|
|
245
|
+
* @param params.idosDisclaimersAccepted - idOS disclaimer documents the
|
|
246
|
+
* customer accepted (`{ key, version }` records). Required for every vendor
|
|
247
|
+
* so callers explicitly declare acceptance.
|
|
242
248
|
* @param params.credentialReusabilityConsentGiven - Whether the customer
|
|
243
249
|
* consented to reuse existing idOS credentials. Used when recording
|
|
244
250
|
* session-scoped disclaimers on the consents path. Defaults to `false`.
|
|
245
251
|
*/
|
|
246
|
-
acceptTermsAndStartSession(params
|
|
252
|
+
acceptTermsAndStartSession(params?: {
|
|
247
253
|
email?: string;
|
|
248
254
|
product?: KycProduct;
|
|
249
|
-
|
|
250
|
-
|
|
255
|
+
providerDisclaimersAccepted: KycConsentRecord[];
|
|
256
|
+
idosDisclaimersAccepted: KycConsentRecord[];
|
|
251
257
|
credentialReusabilityConsentGiven?: boolean;
|
|
252
258
|
}): Promise<void>;
|
|
253
259
|
/**
|
|
@@ -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;AAMnF,OAAO,KAAK,EAEV,gBAAgB,EAChB,mBAAmB,EACnB,aAAa,EACb,QAAQ,EACR,UAAU,EACV,8BAA8B,EAC9B,qBAAqB,EACrB,gBAAgB,EAChB,iBAAiB,EACjB,eAAe,EACf,aAAa,EACb,SAAS,EACT,4BAA4B,EAC7B,oBAAmB;AAoBpB,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;;;;OAIG;IACH,yBAAyB,EAAE,4BAA4B,CAAC;IACxD;;;;;;OAMG;IACH,2BAA2B,EAAE,8BAA8B,CAAC;IAC5D;;;;;OAKG;IACH,uBAAuB,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC;IACnD;;;;;OAKG;IACH,iCAAiC,EAAE,OAAO,GAAG,IAAI,CAAC;IAElD,0DAA0D;IAC1D,iBAAiB,EAAE,aAAa,EAAE,CAAC;IACnC,qEAAqE;IACrE,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B;;;;OAIG;IACH,kBAAkB,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAEjD,gDAAgD;IAChD,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,yDAAyD;IACzD,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,wDAAwD;IACxD,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,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;AA+IF;;;;GAIG;AACH,wBAAgB,sCAAsC,IAAI,4BAA4B,CAErF;AAED,wBAAgB,wCAAwC,IAAI,8BAA8B,CAEzF;AAED;;;;GAIG;AACH,wBAAgB,4BAA4B,IAAI,kBAAkB,CAgCjE;AAuJD,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;IAkDvB;;;;;;;;;;;;;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;IAuIjB;;;;;;;;;;;;OAYG;IACG,oBAAoB,CAAC,MAAM,EAAE;QACjC,MAAM,EAAE,SAAS,CAAC;QAClB,KAAK,EAAE,MAAM,CAAC;KACf,GAAG,OAAO,CAAC,IAAI,CAAC;IA+BjB;;;;;OAKG;IACG,eAAe,CAAC,MAAM,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAiCnE;;;;;;;;;;;;;;;;;;OAkBG;IACG,0BAA0B,CAAC,MAAM,CAAC,EAAE;QACxC,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,OAAO,CAAC,EAAE,UAAU,CAAC;QACrB,2BAA2B,EAAE,gBAAgB,EAAE,CAAC;QAChD,uBAAuB,EAAE,gBAAgB,EAAE,CAAC;QAC5C,iCAAiC,CAAC,EAAE,OAAO,CAAC;KAC7C,GAAG,OAAO,CAAC,IAAI,CAAC;IAwYjB;;OAEG;IACH,eAAe,IAAI,IAAI;IAgDvB;;;;;;;;;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;IAgBnC;;;;OAIG;IACH,iBAAiB,IAAI,MAAM,GAAG,IAAI;IAelC;;;;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;IAqDpB;;;;;;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"}
|