@metamask-previews/kyc-controller 0.3.0-preview-3e86f66f7 → 0.4.0-preview-9324e33

package/CHANGELOG.md

@@ -7,6 +7,40 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.4.0]
+
+### Added
+
+- Export `MoonPayFrameHandler`, `MoonPayFrameHandlerOptions`, and `clearMoonPaySession` so clients can own MoonPay Check/Auth frames after those methods left `KycController` ([#10293](https://github.com/MetaMask/core/pull/10293))
+- Add `sessionStatus` (`KycSessionStatus | null`) to `KycControllerState` ([#10293](https://github.com/MetaMask/core/pull/10293))
+- Add `KycService.getSessionStatusForVendor`, which fetches `GET /sessions/latest/status/{vendor}` and returns `KycSessionStatus` or `null` ([#10293](https://github.com/MetaMask/core/pull/10293))
+- Add `KycController.fetchVendorDisclaimers`, which loads vendor T&Cs via `KycService.fetchVendorDisclaimers` ([#10293](https://github.com/MetaMask/core/pull/10293))
+- Add `KycController.hasCompletedVendorDisclaimers`, which fetches the vendor T&C catalog and returns whether persisted `vendorDisclaimersAccepted` covers every fetched disclaimer ([#10293](https://github.com/MetaMask/core/pull/10293))
+- Add `KycController.recordVendorDisclaimers`, which records vendor T&Cs via `KycService.submitVendorDisclaimers` and persists accepted ids on state ([#10293](https://github.com/MetaMask/core/pull/10293))
+- Add `KycController.startSession`, which reuses the latest vendor session when one exists and otherwise creates the vendor customer and a UKYC session ([#10293](https://github.com/MetaMask/core/pull/10293))
+- Add `KycController.launchProviderFlow`, which presents the identity-provider (SumSub) verification UI ([#10293](https://github.com/MetaMask/core/pull/10293))
+- Add `KycController.startSessionStatusPolling`, which polls `GET /sessions/{id}/status` for `state.sessionStatus.id` until `finalStatus` is `approved`, `rejected`, or `retry` ([#10293](https://github.com/MetaMask/core/pull/10293))
+- Expose current `KycController` methods as messenger actions: `startSession`, `reset`, `clearState`, `getSessionStatusForVendor`, `refreshSessionStatus`, `startSessionStatusPolling`, `fetchSessionDisclaimers`, `recordSessionDisclaimers`, `hasCompletedSessionDisclaimers`, `fetchVendorDisclaimers`, `recordVendorDisclaimers`, `hasCompletedVendorDisclaimers`, and `launchProviderFlow` ([#10293](https://github.com/MetaMask/core/pull/10293))
+
+### Changed
+
+- **BREAKING:** Add required `id` to `KycSessionStatus` ([#10293](https://github.com/MetaMask/core/pull/10293))
+- **BREAKING:** Rename `CreateSessionParams` to `CreateMoonpaySessionParams`, and `KycService.createSession` / `KycService:createSession` to `createMoonpaySession` / `KycService:createMoonpaySession` ([#10293](https://github.com/MetaMask/core/pull/10293))
+- `MoonPayFrameHandler.buildCheckFrameUrl` no longer sets the `skipKyc` query parameter ([#10293](https://github.com/MetaMask/core/pull/10293))
+- Bump `@metamask/profile-sync-controller` from `^32.1.0` to `^32.1.1` ([#10220](https://github.com/MetaMask/core/pull/10220))
+
+### Removed
+
+- **BREAKING:** Remove unused `KycCustomerIdentity` ([#10293](https://github.com/MetaMask/core/pull/10293))
+- **BREAKING:** Remove `sessionStatusPollIntervalMs` and `userStatusPollIntervalMs` from `KycControllerOptions`, and stop automatic session-status and user-status polling. Session-status polling is now opt-in through `startSessionStatusPolling` or `refreshSessionStatus` ([#10293](https://github.com/MetaMask/core/pull/10293))
+- **BREAKING:** Remove the `reselect` dependency ([#10293](https://github.com/MetaMask/core/pull/10293))
+- **BREAKING:** Remove the `polling` value from `KycSumSubStatus` ([#10293](https://github.com/MetaMask/core/pull/10293))
+- **BREAKING:** Remove MoonPay Check/Auth frame methods from `KycController`: `handleFrameMessage`, `buildCheckFrameUrl`, `buildAuthFrameUrl`, and `buildResetFrameUrl`. Use `MoonPayFrameHandler` directly for frame protocol, URLs, and message handling ([#10293](https://github.com/MetaMask/core/pull/10293))
+- **BREAKING:** Remove `KycService.checkKycRequired`, `CheckKycRequiredParams`, and the `KycService:checkKycRequired` messenger action ([#10293](https://github.com/MetaMask/core/pull/10293))
+- **BREAKING:** Remove `KycService.fetchKycStatus`, `KycService:fetchKycStatus`, `KycController.refreshKycStatus`, `KycController:refreshKycStatus`, `KycUserStatus`, `KycUserStatusResponse`, and `KycController:statusChanged` (`KycControllerStatusChangedEvent`) ([#10293](https://github.com/MetaMask/core/pull/10293))
+- **BREAKING:** Replace the previous `KycController` messenger method actions. Removed: `initialize`, `createVendorCustomer`, `loadDisclaimers`, `acceptTermsAndStartSession`, `clearSavedTerms`, `checkKycRequired`, `getKycStatus`, `getCustomerIdentity`, `startSumSub`, and `getSessionStatus` ([#10293](https://github.com/MetaMask/core/pull/10293))
+- **BREAKING:** Replace `selectKycPhase`, `selectKycSumSub`, and `selectIsKycRequiredForProduct` with `selectKycVendor` and `selectKycSessionStatus` ([#10293](https://github.com/MetaMask/core/pull/10293))
+
 ## [0.3.0]
 
 ### Added
@@ -46,7 +80,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Initial Release ([#10145](https://github.com/MetaMask/core/pull/10145))
 
-[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/kyc-controller@0.3.0...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/kyc-controller@0.4.0...HEAD
+[0.4.0]: https://github.com/MetaMask/core/compare/@metamask/kyc-controller@0.3.0...@metamask/kyc-controller@0.4.0
 [0.3.0]: https://github.com/MetaMask/core/compare/@metamask/kyc-controller@0.2.0...@metamask/kyc-controller@0.3.0
 [0.2.0]: https://github.com/MetaMask/core/compare/@metamask/kyc-controller@0.1.0...@metamask/kyc-controller@0.2.0
 [0.1.0]: https://github.com/MetaMask/core/releases/tag/@metamask/kyc-controller@0.1.0

package/dist/KycController-method-action-types.d.ts

@@ -4,49 +4,65 @@
  */
 import type { KycController } from './KycController.js';
 /**
- * Resolves persisted terms + geolocation, and auto-creates a session when
- * terms are already accepted and an email is available.
+ * Starts a KYC session for the given vendor and email. Reuses a latest
+ * vendor session when one exists; otherwise creates a UKYC session.
  *
- * @param params - Optional parameters.
- * @param params.email - The account email to associate with the session.
- * @param params.product - The consuming feature the flow runs for. When
- * provided, the controller automatically runs the KYC-required check once
- * authentication completes (and chains into document verification when KYC
- * is required). When omitted, the flow stops at `form` and the consumer must
- * call `checkKycRequired` manually.
- * @param params.vendor - Identity vendor for this flow. Non-MoonPay vendors
- * skip Check/Auth frames and use the consents path. Defaults to `moonpay`.
+ * @param params - The session parameters.
+ * @param params.vendor - Identity vendor for the session.
+ * @param params.email - Account email associated with the session.
+ * @returns The current or newly created session status.
  */
-export type KycControllerInitializeAction = {
-    type: `KycController:initialize`;
-    handler: KycController['initialize'];
+export type KycControllerStartSessionAction = {
+    type: `KycController:startSession`;
+    handler: KycController['startSession'];
 };
 /**
- * Creates (or resumes) an empty-shell customer for the given identity
- * vendor. Exposed so a consumer can ensure the customer exists before
- * showing T&C screens independently of {@link initialize}.
+ * Stops session-status polling and restores default controller state.
+ */
+export type KycControllerResetAction = {
+    type: `KycController:reset`;
+    handler: KycController['reset'];
+};
+/**
+ * Restores the controller to its default state.
+ */
+export type KycControllerClearStateAction = {
+    type: `KycController:clearState`;
+    handler: KycController['clearState'];
+};
+/**
+ * Fetches the latest UKYC session status for a vendor.
  *
- * A call while a session flow is already in progress is a no-op — matching
- * {@link initialize} — so a vendor switch cannot leave Check/Auth frames
- * attached to the wrong vendor. Call {@link reset} first to start over.
+ * @param vendor - Identity vendor whose latest session should be queried.
+ * @returns The session status, or `null` when none exists.
+ */
+export type KycControllerGetSessionStatusForVendorAction = {
+    type: `KycController:getSessionStatusForVendor`;
+    handler: KycController['getSessionStatusForVendor'];
+};
+/**
+ * Returns the current session status and starts polling when it is not yet
+ * terminal.
  *
- * @param params - The parameters.
- * @param params.vendor - Identity vendor for the customer.
- * @param params.email - Email for the vendor customer.
+ * @returns The current session status.
+ * @throws If there is no session on state.
  */
-export type KycControllerCreateVendorCustomerAction = {
-    type: `KycController:createVendorCustomer`;
-    handler: KycController['createVendorCustomer'];
+export type KycControllerRefreshSessionStatusAction = {
+    type: `KycController:refreshSessionStatus`;
+    handler: KycController['refreshSessionStatus'];
 };
 /**
- * Loads the disclaimers for the resolved (or provided) country.
+ * Starts polling `GET /sessions/{id}/status` for
+ * {@link KycControllerState.sessionStatus}'s current `id`. Each tick writes
+ * the result onto state only when the payload changed. The loop stops once
+ * `finalStatus` is `approved`, `rejected`, or `retry`, or when
+ * {@link reset} / {@link clearState} runs.
  *
- * @param params - Optional parameters.
- * @param params.country - ISO 3166-1 alpha-3 country code override.
+ * @throws If there is no current session id to poll.
  */
-export type KycControllerLoadDisclaimersAction = {
-    type: `KycController:loadDisclaimers`;
-    handler: KycController['loadDisclaimers'];
+export type KycControllerStartSessionStatusPollingAction = {
+    type: `KycController:startSessionStatusPolling`;
+    handler: KycController['startSessionStatusPolling'];
 };
 /**
  * Fetches the idOS + KYC-provider disclaimer catalog. Pass exactly one of
@@ -71,197 +87,83 @@ export type KycControllerFetchSessionDisclaimersAction = {
     handler: KycController['fetchSessionDisclaimers'];
 };
 /**
- * Captures terms acceptance for the currently loaded disclaimers and creates
- * a session.
+ * Fetches the session-scoped disclaimer catalog and records consents
+ * derived from the T&C2 flags. Already-consented catalog rows are omitted
+ * from the POST. A 409 is re-checked with a GET: continue only when every
+ * accepted document is now consented, otherwise fail closed.
  *
- * @param params - The parameters.
- * @param params.email - The account email to associate with the session.
- * @param params.product - The consuming feature the flow runs for. See
- * {@link initialize} for how the product drives the automatic post
- * authentication continuation.
- * @param params.providerDisclaimersAccepted - Sumsub disclaimer documents the
- * customer accepted (`{ key, version }` records). Required for every vendor
- * so callers explicitly declare acceptance.
- * @param params.idosDisclaimersAccepted - idOS disclaimer documents the
- * customer accepted (`{ key, version }` records). Required for every vendor
- * so callers explicitly declare acceptance.
- * @param params.credentialReusabilityConsentGiven - Whether the customer
- * consented to reuse existing idOS credentials. Used when recording
- * session-scoped disclaimers on the consents path. Defaults to `false`.
- */
-export type KycControllerAcceptTermsAndStartSessionAction = {
-    type: `KycController:acceptTermsAndStartSession`;
-    handler: KycController['acceptTermsAndStartSession'];
-};
-/**
- * Clears the persisted terms acceptance.
+ * @param params - Accepted session-disclaimer records.
+ * @param params.providerDisclaimersAccepted - Accepted Sumsub disclaimer records.
+ * @param params.idosDisclaimersAccepted - Accepted idOS disclaimer records.
+ * @param params.credentialReusabilityConsentGiven - Whether credential
+ * reuse was accepted.
  */
-export type KycControllerClearSavedTermsAction = {
-    type: `KycController:clearSavedTerms`;
-    handler: KycController['clearSavedTerms'];
+export type KycControllerRecordSessionDisclaimersAction = {
+    type: `KycController:recordSessionDisclaimers`;
+    handler: KycController['recordSessionDisclaimers'];
 };
 /**
- * Handles a message posted by a Check/Auth frame and advances the flow.
+ * Fetches session-scoped disclaimers and reports whether every document is
+ * consented and credential reuse was accepted.
  *
- * The transport-agnostic caller (WebView on mobile, iframe on web) forwards
- * the raw message and injects the returned `reply` back into the frame.
- *
- * @param params - The parameters.
- * @param params.message - The raw message posted by the frame.
- * @returns An object whose optional `reply` should be posted back.
+ * @returns Whether session disclaimers are complete.
+ * @throws If there is no session on state.
  */
-export type KycControllerHandleFrameMessageAction = {
-    type: `KycController:handleFrameMessage`;
-    handler: KycController['handleFrameMessage'];
+export type KycControllerHasCompletedSessionDisclaimersAction = {
+    type: `KycController:hasCompletedSessionDisclaimers`;
+    handler: KycController['hasCompletedSessionDisclaimers'];
 };
 /**
- * Builds the Check-frame URL, or `null` when no session exists yet.
- *
- * @returns The Check-frame URL or `null`.
- */
-export type KycControllerBuildCheckFrameUrlAction = {
-    type: `KycController:buildCheckFrameUrl`;
-    handler: KycController['buildCheckFrameUrl'];
-};
-/**
- * Builds the Auth-frame URL, or `null` when no client token is available.
- *
- * @returns The Auth-frame URL or `null`.
- */
-export type KycControllerBuildAuthFrameUrlAction = {
-    type: `KycController:buildAuthFrameUrl`;
-    handler: KycController['buildAuthFrameUrl'];
-};
-/**
- * Builds the Reset-frame URL.
- *
- * @returns The Reset-frame URL.
- */
-export type KycControllerBuildResetFrameUrlAction = {
-    type: `KycController:buildResetFrameUrl`;
-    handler: KycController['buildResetFrameUrl'];
-};
-/**
- * Checks whether KYC is required for a product and caches the result.
+ * Fetches the vendor T&Cs the customer must accept before a session is
+ * created (`GET /vendors/{vendor}/disclaimers?country=`).
  *
  * @param params - The parameters.
- * @param params.product - The consuming feature.
- * @param params.country - Optional alpha-3 country override.
- * @returns Whether KYC is required.
+ * @param params.vendor - Identity vendor. Defaults to `moonpay`.
+ * @param params.country - ISO 3166-1 alpha-3 country code.
+ * @returns The disclaimers.
  */
-export type KycControllerCheckKycRequiredAction = {
-    type: `KycController:checkKycRequired`;
-    handler: KycController['checkKycRequired'];
+export type KycControllerFetchVendorDisclaimersAction = {
+    type: `KycController:fetchVendorDisclaimers`;
+    handler: KycController['fetchVendorDisclaimers'];
 };
 /**
- * Reads the cached "is KYC required" result for a product.
+ * Records vendor T&C acceptance via {@link KycService.submitVendorDisclaimers}
+ * and persists the accepted ids on state.
  *
  * @param params - The parameters.
- * @param params.product - The consuming feature.
- * @returns The cached value, or `undefined` if not yet checked.
+ * @param params.disclaimerIds - Accepted vendor T&C ids.
+ * @returns The vendor signing records.
+ * @throws If `vendor` is missing from state.
  */
-export type KycControllerGetKycStatusAction = {
-    type: `KycController:getKycStatus`;
-    handler: KycController['getKycStatus'];
+export type KycControllerRecordVendorDisclaimersAction = {
+    type: `KycController:recordVendorDisclaimers`;
+    handler: KycController['recordVendorDisclaimers'];
 };
 /**
- * Returns the vendor-scoped identity for the currently authenticated
- * customer, or `null` when the flow has not yet captured a vendor customer
- * id (before authentication or after {@link reset}), or when a MoonPay id
- * is present under a different `activeVendor`.
+ * Fetches the current vendor T&C catalog and returns whether every document
+ * is already recorded in {@link KycControllerState.vendorDisclaimersAccepted}.
  *
- * Exposed so consumers (e.g. ramps autoramp creation) can attach the vendor
- * customer id to downstream calls without reading the full KYC state, which
- * also holds session/access tokens. The id is session-scoped and never
- * persisted.
- *
- * @returns The current {@link KycCustomerIdentity}, or `null`.
+ * @returns Whether persisted acceptance covers the fetched catalog.
+ * @throws If `vendor` or `geoCountry` is missing from state.
  */
-export type KycControllerGetCustomerIdentityAction = {
-    type: `KycController:getCustomerIdentity`;
-    handler: KycController['getCustomerIdentity'];
+export type KycControllerHasCompletedVendorDisclaimersAction = {
+    type: `KycController:hasCompletedVendorDisclaimers`;
+    handler: KycController['hasCompletedVendorDisclaimers'];
 };
 /**
- * Runs the SumSub document-verification sub-flow end to end:
- *
- * 1. creates a UKYC session, receiving per-secret encryption schemas;
- * 2. verifies the `encryptionDataKey` schema's `jwtChain` against the
- * idOS enclave JWKS and the `ukycCapabilityToken` schema's `jwtChain` against
- * the idOS relay JWKS, then confirms each attested session server public
- * key;
- * 3. derives the `data_encryption_key` from the wallet's UKYC
- * `local_user_secret` and wraps it for the session server;
- * 4. mints a client-signed, read-only `ukyc_capability_token`, wraps it the
- * same way as the encryption key, and submits both via authorizations;
- * 5. fetches the SumSub applicant access token; and
- * 6. presents the SDK via the injected launcher.
- *
- * If a UKYC session already exists (the consents path creates it before
- * recording session disclaimers), steps 1–4 are skipped.
- *
- * If authorizations report the applicant is already approved on the relay
- * while the vendor is still finalizing (`kycStatus: approved`,
- * `finalStatus: pending`), the sub-flow stops at step 4 with a
- * `vendorProcessing` status and a message rather than launching the SDK.
+ * Presents the identity-provider verification UI. Currently launches SumSub.
  *
- * @param params - Optional parameters.
+ * @param params - Optional SDK presentation options.
  * @param params.locale - BCP-47 locale for the SDK UI.
  * @param params.debug - Enables SDK debug logging.
- * @returns The SDK result.
- */
-export type KycControllerStartSumSubAction = {
-    type: `KycController:startSumSub`;
-    handler: KycController['startSumSub'];
-};
-/**
- * Refreshes the user-keyed simplified KYC status from `GET /kyc/status`,
- * stores it on state, publishes {@link KycControllerStatusChangedEvent}, and
- * schedules short-interval polling while the status is `pending`.
- *
- * Skipped when `userStatus` is already `completed`: a follow-up
- * `GET /kyc/status` can still read a stale `pending` (for example after
- * `session_not_in_valid_state`) and must not undo that decision.
- *
- * @returns The latest status payload.
- */
-export type KycControllerRefreshKycStatusAction = {
-    type: `KycController:refreshKycStatus`;
-    handler: KycController['refreshKycStatus'];
-};
-/**
- * Fetches the current UKYC session status for the active sub-flow and records
- * it on state. Useful for a one-off refresh outside the automatic polling
- * loop that {@link startSumSub} runs.
- *
- * @returns The fetched session status.
- * @throws If there is no active SumSub session to query.
- */
-export type KycControllerGetSessionStatusAction = {
-    type: `KycController:getSessionStatus`;
-    handler: KycController['getSessionStatus'];
-};
-/**
- * Resets the flow to idle, clearing session tokens and sub-flow state while
- * preserving persisted terms acceptance and the per-product cache.
+ * @returns A promise that settles when the provider flow finishes.
  */
-export type KycControllerResetAction = {
-    type: `KycController:reset`;
-    handler: KycController['reset'];
-};
-/**
- * Restores the controller to its default state, discarding everything
- * {@link reset} deliberately keeps: the session email, the persisted terms
- * acceptance, the per-product KYC-required cache and the user-keyed status.
- *
- * Intended for a full wallet reset, where no trace of the previous
- * customer may survive into the next wallet.
- */
-export type KycControllerClearStateAction = {
-    type: `KycController:clearState`;
-    handler: KycController['clearState'];
+export type KycControllerLaunchProviderFlowAction = {
+    type: `KycController:launchProviderFlow`;
+    handler: KycController['launchProviderFlow'];
 };
 /**
  * Union of all KycController action types.
  */
-export type KycControllerMethodActions = KycControllerInitializeAction | KycControllerCreateVendorCustomerAction | KycControllerLoadDisclaimersAction | KycControllerFetchSessionDisclaimersAction | KycControllerAcceptTermsAndStartSessionAction | KycControllerClearSavedTermsAction | KycControllerHandleFrameMessageAction | KycControllerBuildCheckFrameUrlAction | KycControllerBuildAuthFrameUrlAction | KycControllerBuildResetFrameUrlAction | KycControllerCheckKycRequiredAction | KycControllerGetKycStatusAction | KycControllerGetCustomerIdentityAction | KycControllerStartSumSubAction | KycControllerRefreshKycStatusAction | KycControllerGetSessionStatusAction | KycControllerResetAction | KycControllerClearStateAction;
+export type KycControllerMethodActions = KycControllerStartSessionAction | KycControllerResetAction | KycControllerClearStateAction | KycControllerGetSessionStatusForVendorAction | KycControllerRefreshSessionStatusAction | KycControllerStartSessionStatusPollingAction | KycControllerFetchSessionDisclaimersAction | KycControllerRecordSessionDisclaimersAction | KycControllerHasCompletedSessionDisclaimersAction | KycControllerFetchVendorDisclaimersAction | KycControllerRecordVendorDisclaimersAction | KycControllerHasCompletedVendorDisclaimersAction | KycControllerLaunchProviderFlowAction;
 //# sourceMappingURL=KycController-method-action-types.d.ts.map

package/dist/KycController-method-action-types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"KycController-method-action-types.d.ts","sourceRoot":"","sources":["../src/KycController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAExD;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C,IAAI,EAAE,0BAA0B,CAAC;IACjC,OAAO,EAAE,aAAa,CAAC,YAAY,CAAC,CAAC;CACtC,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,uCAAuC,GAAG;IACpD,IAAI,EAAE,oCAAoC,CAAC;IAC3C,OAAO,EAAE,aAAa,CAAC,sBAAsB,CAAC,CAAC;CAChD,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,kCAAkC,GAAG;IAC/C,IAAI,EAAE,+BAA+B,CAAC;IACtC,OAAO,EAAE,aAAa,CAAC,iBAAiB,CAAC,CAAC;CAC3C,CAAC;AAEF;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,MAAM,0CAA0C,GAAG;IACvD,IAAI,EAAE,uCAAuC,CAAC;IAC9C,OAAO,EAAE,aAAa,CAAC,yBAAyB,CAAC,CAAC;CACnD,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,MAAM,6CAA6C,GAAG;IAC1D,IAAI,EAAE,0CAA0C,CAAC;IACjD,OAAO,EAAE,aAAa,CAAC,4BAA4B,CAAC,CAAC;CACtD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kCAAkC,GAAG;IAC/C,IAAI,EAAE,+BAA+B,CAAC;IACtC,OAAO,EAAE,aAAa,CAAC,iBAAiB,CAAC,CAAC;CAC3C,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,qCAAqC,GAAG;IAClD,IAAI,EAAE,kCAAkC,CAAC;IACzC,OAAO,EAAE,aAAa,CAAC,oBAAoB,CAAC,CAAC;CAC9C,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,qCAAqC,GAAG;IAClD,IAAI,EAAE,kCAAkC,CAAC;IACzC,OAAO,EAAE,aAAa,CAAC,oBAAoB,CAAC,CAAC;CAC9C,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,oCAAoC,GAAG;IACjD,IAAI,EAAE,iCAAiC,CAAC;IACxC,OAAO,EAAE,aAAa,CAAC,mBAAmB,CAAC,CAAC;CAC7C,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,qCAAqC,GAAG;IAClD,IAAI,EAAE,kCAAkC,CAAC;IACzC,OAAO,EAAE,aAAa,CAAC,oBAAoB,CAAC,CAAC;CAC9C,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,mCAAmC,GAAG;IAChD,IAAI,EAAE,gCAAgC,CAAC;IACvC,OAAO,EAAE,aAAa,CAAC,kBAAkB,CAAC,CAAC;CAC5C,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,4BAA4B,CAAC;IACnC,OAAO,EAAE,aAAa,CAAC,cAAc,CAAC,CAAC;CACxC,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,sCAAsC,GAAG;IACnD,IAAI,EAAE,mCAAmC,CAAC;IAC1C,OAAO,EAAE,aAAa,CAAC,qBAAqB,CAAC,CAAC;CAC/C,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,MAAM,8BAA8B,GAAG;IAC3C,IAAI,EAAE,2BAA2B,CAAC;IAClC,OAAO,EAAE,aAAa,CAAC,aAAa,CAAC,CAAC;CACvC,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,MAAM,mCAAmC,GAAG;IAChD,IAAI,EAAE,gCAAgC,CAAC;IACvC,OAAO,EAAE,aAAa,CAAC,kBAAkB,CAAC,CAAC;CAC5C,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,mCAAmC,GAAG;IAChD,IAAI,EAAE,gCAAgC,CAAC;IACvC,OAAO,EAAE,aAAa,CAAC,kBAAkB,CAAC,CAAC;CAC5C,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC,IAAI,EAAE,qBAAqB,CAAC;IAC5B,OAAO,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC;CACjC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C,IAAI,EAAE,0BAA0B,CAAC;IACjC,OAAO,EAAE,aAAa,CAAC,YAAY,CAAC,CAAC;CACtC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAClC,6BAA6B,GAC7B,uCAAuC,GACvC,kCAAkC,GAClC,0CAA0C,GAC1C,6CAA6C,GAC7C,kCAAkC,GAClC,qCAAqC,GACrC,qCAAqC,GACrC,oCAAoC,GACpC,qCAAqC,GACrC,mCAAmC,GACnC,+BAA+B,GAC/B,sCAAsC,GACtC,8BAA8B,GAC9B,mCAAmC,GACnC,mCAAmC,GACnC,wBAAwB,GACxB,6BAA6B,CAAC"}
+{"version":3,"file":"KycController-method-action-types.d.ts","sourceRoot":"","sources":["../src/KycController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAExD;;;;;;;;GAQG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,4BAA4B,CAAC;IACnC,OAAO,EAAE,aAAa,CAAC,cAAc,CAAC,CAAC;CACxC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC,IAAI,EAAE,qBAAqB,CAAC;IAC5B,OAAO,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC;CACjC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C,IAAI,EAAE,0BAA0B,CAAC;IACjC,OAAO,EAAE,aAAa,CAAC,YAAY,CAAC,CAAC;CACtC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,4CAA4C,GAAG;IACzD,IAAI,EAAE,yCAAyC,CAAC;IAChD,OAAO,EAAE,aAAa,CAAC,2BAA2B,CAAC,CAAC;CACrD,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,uCAAuC,GAAG;IACpD,IAAI,EAAE,oCAAoC,CAAC;IAC3C,OAAO,EAAE,aAAa,CAAC,sBAAsB,CAAC,CAAC;CAChD,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,4CAA4C,GAAG;IACzD,IAAI,EAAE,yCAAyC,CAAC;IAChD,OAAO,EAAE,aAAa,CAAC,2BAA2B,CAAC,CAAC;CACrD,CAAC;AAEF;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,MAAM,0CAA0C,GAAG;IACvD,IAAI,EAAE,uCAAuC,CAAC;IAC9C,OAAO,EAAE,aAAa,CAAC,yBAAyB,CAAC,CAAC;CACnD,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,2CAA2C,GAAG;IACxD,IAAI,EAAE,wCAAwC,CAAC;IAC/C,OAAO,EAAE,aAAa,CAAC,0BAA0B,CAAC,CAAC;CACpD,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,iDAAiD,GAAG;IAC9D,IAAI,EAAE,8CAA8C,CAAC;IACrD,OAAO,EAAE,aAAa,CAAC,gCAAgC,CAAC,CAAC;CAC1D,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,yCAAyC,GAAG;IACtD,IAAI,EAAE,sCAAsC,CAAC;IAC7C,OAAO,EAAE,aAAa,CAAC,wBAAwB,CAAC,CAAC;CAClD,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,0CAA0C,GAAG;IACvD,IAAI,EAAE,uCAAuC,CAAC;IAC9C,OAAO,EAAE,aAAa,CAAC,yBAAyB,CAAC,CAAC;CACnD,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,gDAAgD,GAAG;IAC7D,IAAI,EAAE,6CAA6C,CAAC;IACpD,OAAO,EAAE,aAAa,CAAC,+BAA+B,CAAC,CAAC;CACzD,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,qCAAqC,GAAG;IAClD,IAAI,EAAE,kCAAkC,CAAC;IACzC,OAAO,EAAE,aAAa,CAAC,oBAAoB,CAAC,CAAC;CAC9C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAClC,+BAA+B,GAC/B,wBAAwB,GACxB,6BAA6B,GAC7B,4CAA4C,GAC5C,uCAAuC,GACvC,4CAA4C,GAC5C,0CAA0C,GAC1C,2CAA2C,GAC3C,iDAAiD,GACjD,yCAAyC,GACzC,0CAA0C,GAC1C,gDAAgD,GAChD,qCAAqC,CAAC"}

package/dist/KycController-method-action-types.js.map

@@ -1 +1 @@
-{"version":3,"file":"KycController-method-action-types.js","sourceRoot":"","sources":["../src/KycController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated.\n * Do not edit manually.\n */\n\nimport type { KycController } from './KycController.js';\n\n/**\n * Resolves persisted terms + geolocation, and auto-creates a session when\n * terms are already accepted and an email is available.\n *\n * @param params - Optional parameters.\n * @param params.email - The account email to associate with the session.\n * @param params.product - The consuming feature the flow runs for. When\n * provided, the controller automatically runs the KYC-required check once\n * authentication completes (and chains into document verification when KYC\n * is required). When omitted, the flow stops at `form` and the consumer must\n * call `checkKycRequired` manually.\n * @param params.vendor - Identity vendor for this flow. Non-MoonPay vendors\n * skip Check/Auth frames and use the consents path. Defaults to `moonpay`.\n */\nexport type KycControllerInitializeAction = {\n  type: `KycController:initialize`;\n  handler: KycController['initialize'];\n};\n\n/**\n * Creates (or resumes) an empty-shell customer for the given identity\n * vendor. Exposed so a consumer can ensure the customer exists before\n * showing T&C screens independently of {@link initialize}.\n *\n * A call while a session flow is already in progress is a no-op — matching\n * {@link initialize} — so a vendor switch cannot leave Check/Auth frames\n * attached to the wrong vendor. Call {@link reset} first to start over.\n *\n * @param params - The parameters.\n * @param params.vendor - Identity vendor for the customer.\n * @param params.email - Email for the vendor customer.\n */\nexport type KycControllerCreateVendorCustomerAction = {\n  type: `KycController:createVendorCustomer`;\n  handler: KycController['createVendorCustomer'];\n};\n\n/**\n * Loads the disclaimers for the resolved (or provided) country.\n *\n * @param params - Optional parameters.\n * @param params.country - ISO 3166-1 alpha-3 country code override.\n */\nexport type KycControllerLoadDisclaimersAction = {\n  type: `KycController:loadDisclaimers`;\n  handler: KycController['loadDisclaimers'];\n};\n\n/**\n * Fetches the idOS + KYC-provider disclaimer catalog. Pass exactly one of\n * `sessionId` or `country`:\n *\n * - `{ sessionId }` → {@link KycService.fetchSessionDisclaimersBySessionId}\n * (`GET /sessions/{sessionId}/disclaimers`)\n * - `{ country }` → {@link KycService.fetchSessionDisclaimersByCountry}\n * (`GET /disclaimers?country=`)\n *\n * A session-id fetch also writes the catalog to `sessionDisclaimers`.\n *\n * @param params - The parameters. Provide exactly one of `sessionId` or\n * `country`.\n * @param params.sessionId - The UKYC session id.\n * @param params.country - ISO 3166-1 alpha-3 country code.\n * @returns The catalog. Session fetches include consent state; country\n * fetches do not.\n */\nexport type KycControllerFetchSessionDisclaimersAction = {\n  type: `KycController:fetchSessionDisclaimers`;\n  handler: KycController['fetchSessionDisclaimers'];\n};\n\n/**\n * Captures terms acceptance for the currently loaded disclaimers and creates\n * a session.\n *\n * @param params - The parameters.\n * @param params.email - The account email to associate with the session.\n * @param params.product - The consuming feature the flow runs for. See\n * {@link initialize} for how the product drives the automatic post\n * authentication continuation.\n * @param params.providerDisclaimersAccepted - Sumsub disclaimer documents the\n * customer accepted (`{ key, version }` records). Required for every vendor\n * so callers explicitly declare acceptance.\n * @param params.idosDisclaimersAccepted - idOS disclaimer documents the\n * customer accepted (`{ key, version }` records). Required for every vendor\n * so callers explicitly declare acceptance.\n * @param params.credentialReusabilityConsentGiven - Whether the customer\n * consented to reuse existing idOS credentials. Used when recording\n * session-scoped disclaimers on the consents path. Defaults to `false`.\n */\nexport type KycControllerAcceptTermsAndStartSessionAction = {\n  type: `KycController:acceptTermsAndStartSession`;\n  handler: KycController['acceptTermsAndStartSession'];\n};\n\n/**\n * Clears the persisted terms acceptance.\n */\nexport type KycControllerClearSavedTermsAction = {\n  type: `KycController:clearSavedTerms`;\n  handler: KycController['clearSavedTerms'];\n};\n\n/**\n * Handles a message posted by a Check/Auth frame and advances the flow.\n *\n * The transport-agnostic caller (WebView on mobile, iframe on web) forwards\n * the raw message and injects the returned `reply` back into the frame.\n *\n * @param params - The parameters.\n * @param params.message - The raw message posted by the frame.\n * @returns An object whose optional `reply` should be posted back.\n */\nexport type KycControllerHandleFrameMessageAction = {\n  type: `KycController:handleFrameMessage`;\n  handler: KycController['handleFrameMessage'];\n};\n\n/**\n * Builds the Check-frame URL, or `null` when no session exists yet.\n *\n * @returns The Check-frame URL or `null`.\n */\nexport type KycControllerBuildCheckFrameUrlAction = {\n  type: `KycController:buildCheckFrameUrl`;\n  handler: KycController['buildCheckFrameUrl'];\n};\n\n/**\n * Builds the Auth-frame URL, or `null` when no client token is available.\n *\n * @returns The Auth-frame URL or `null`.\n */\nexport type KycControllerBuildAuthFrameUrlAction = {\n  type: `KycController:buildAuthFrameUrl`;\n  handler: KycController['buildAuthFrameUrl'];\n};\n\n/**\n * Builds the Reset-frame URL.\n *\n * @returns The Reset-frame URL.\n */\nexport type KycControllerBuildResetFrameUrlAction = {\n  type: `KycController:buildResetFrameUrl`;\n  handler: KycController['buildResetFrameUrl'];\n};\n\n/**\n * Checks whether KYC is required for a product and caches the result.\n *\n * @param params - The parameters.\n * @param params.product - The consuming feature.\n * @param params.country - Optional alpha-3 country override.\n * @returns Whether KYC is required.\n */\nexport type KycControllerCheckKycRequiredAction = {\n  type: `KycController:checkKycRequired`;\n  handler: KycController['checkKycRequired'];\n};\n\n/**\n * Reads the cached \"is KYC required\" result for a product.\n *\n * @param params - The parameters.\n * @param params.product - The consuming feature.\n * @returns The cached value, or `undefined` if not yet checked.\n */\nexport type KycControllerGetKycStatusAction = {\n  type: `KycController:getKycStatus`;\n  handler: KycController['getKycStatus'];\n};\n\n/**\n * Returns the vendor-scoped identity for the currently authenticated\n * customer, or `null` when the flow has not yet captured a vendor customer\n * id (before authentication or after {@link reset}), or when a MoonPay id\n * is present under a different `activeVendor`.\n *\n * Exposed so consumers (e.g. ramps autoramp creation) can attach the vendor\n * customer id to downstream calls without reading the full KYC state, which\n * also holds session/access tokens. The id is session-scoped and never\n * persisted.\n *\n * @returns The current {@link KycCustomerIdentity}, or `null`.\n */\nexport type KycControllerGetCustomerIdentityAction = {\n  type: `KycController:getCustomerIdentity`;\n  handler: KycController['getCustomerIdentity'];\n};\n\n/**\n * Runs the SumSub document-verification sub-flow end to end:\n *\n * 1. creates a UKYC session, receiving per-secret encryption schemas;\n * 2. verifies the `encryptionDataKey` schema's `jwtChain` against the\n * idOS enclave JWKS and the `ukycCapabilityToken` schema's `jwtChain` against\n * the idOS relay JWKS, then confirms each attested session server public\n * key;\n * 3. derives the `data_encryption_key` from the wallet's UKYC\n * `local_user_secret` and wraps it for the session server;\n * 4. mints a client-signed, read-only `ukyc_capability_token`, wraps it the\n * same way as the encryption key, and submits both via authorizations;\n * 5. fetches the SumSub applicant access token; and\n * 6. presents the SDK via the injected launcher.\n *\n * If a UKYC session already exists (the consents path creates it before\n * recording session disclaimers), steps 1–4 are skipped.\n *\n * If authorizations report the applicant is already approved on the relay\n * while the vendor is still finalizing (`kycStatus: approved`,\n * `finalStatus: pending`), the sub-flow stops at step 4 with a\n * `vendorProcessing` status and a message rather than launching the SDK.\n *\n * @param params - Optional parameters.\n * @param params.locale - BCP-47 locale for the SDK UI.\n * @param params.debug - Enables SDK debug logging.\n * @returns The SDK result.\n */\nexport type KycControllerStartSumSubAction = {\n  type: `KycController:startSumSub`;\n  handler: KycController['startSumSub'];\n};\n\n/**\n * Refreshes the user-keyed simplified KYC status from `GET /kyc/status`,\n * stores it on state, publishes {@link KycControllerStatusChangedEvent}, and\n * schedules short-interval polling while the status is `pending`.\n *\n * Skipped when `userStatus` is already `completed`: a follow-up\n * `GET /kyc/status` can still read a stale `pending` (for example after\n * `session_not_in_valid_state`) and must not undo that decision.\n *\n * @returns The latest status payload.\n */\nexport type KycControllerRefreshKycStatusAction = {\n  type: `KycController:refreshKycStatus`;\n  handler: KycController['refreshKycStatus'];\n};\n\n/**\n * Fetches the current UKYC session status for the active sub-flow and records\n * it on state. Useful for a one-off refresh outside the automatic polling\n * loop that {@link startSumSub} runs.\n *\n * @returns The fetched session status.\n * @throws If there is no active SumSub session to query.\n */\nexport type KycControllerGetSessionStatusAction = {\n  type: `KycController:getSessionStatus`;\n  handler: KycController['getSessionStatus'];\n};\n\n/**\n * Resets the flow to idle, clearing session tokens and sub-flow state while\n * preserving persisted terms acceptance and the per-product cache.\n */\nexport type KycControllerResetAction = {\n  type: `KycController:reset`;\n  handler: KycController['reset'];\n};\n\n/**\n * Restores the controller to its default state, discarding everything\n * {@link reset} deliberately keeps: the session email, the persisted terms\n * acceptance, the per-product KYC-required cache and the user-keyed status.\n *\n * Intended for a full wallet reset, where no trace of the previous\n * customer may survive into the next wallet.\n */\nexport type KycControllerClearStateAction = {\n  type: `KycController:clearState`;\n  handler: KycController['clearState'];\n};\n\n/**\n * Union of all KycController action types.\n */\nexport type KycControllerMethodActions =\n  | KycControllerInitializeAction\n  | KycControllerCreateVendorCustomerAction\n  | KycControllerLoadDisclaimersAction\n  | KycControllerFetchSessionDisclaimersAction\n  | KycControllerAcceptTermsAndStartSessionAction\n  | KycControllerClearSavedTermsAction\n  | KycControllerHandleFrameMessageAction\n  | KycControllerBuildCheckFrameUrlAction\n  | KycControllerBuildAuthFrameUrlAction\n  | KycControllerBuildResetFrameUrlAction\n  | KycControllerCheckKycRequiredAction\n  | KycControllerGetKycStatusAction\n  | KycControllerGetCustomerIdentityAction\n  | KycControllerStartSumSubAction\n  | KycControllerRefreshKycStatusAction\n  | KycControllerGetSessionStatusAction\n  | KycControllerResetAction\n  | KycControllerClearStateAction;\n"]}
+{"version":3,"file":"KycController-method-action-types.js","sourceRoot":"","sources":["../src/KycController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated.\n * Do not edit manually.\n */\n\nimport type { KycController } from './KycController.js';\n\n/**\n * Starts a KYC session for the given vendor and email. Reuses a latest\n * vendor session when one exists; otherwise creates a UKYC session.\n *\n * @param params - The session parameters.\n * @param params.vendor - Identity vendor for the session.\n * @param params.email - Account email associated with the session.\n * @returns The current or newly created session status.\n */\nexport type KycControllerStartSessionAction = {\n  type: `KycController:startSession`;\n  handler: KycController['startSession'];\n};\n\n/**\n * Stops session-status polling and restores default controller state.\n */\nexport type KycControllerResetAction = {\n  type: `KycController:reset`;\n  handler: KycController['reset'];\n};\n\n/**\n * Restores the controller to its default state.\n */\nexport type KycControllerClearStateAction = {\n  type: `KycController:clearState`;\n  handler: KycController['clearState'];\n};\n\n/**\n * Fetches the latest UKYC session status for a vendor.\n *\n * @param vendor - Identity vendor whose latest session should be queried.\n * @returns The session status, or `null` when none exists.\n */\nexport type KycControllerGetSessionStatusForVendorAction = {\n  type: `KycController:getSessionStatusForVendor`;\n  handler: KycController['getSessionStatusForVendor'];\n};\n\n/**\n * Returns the current session status and starts polling when it is not yet\n * terminal.\n *\n * @returns The current session status.\n * @throws If there is no session on state.\n */\nexport type KycControllerRefreshSessionStatusAction = {\n  type: `KycController:refreshSessionStatus`;\n  handler: KycController['refreshSessionStatus'];\n};\n\n/**\n * Starts polling `GET /sessions/{id}/status` for\n * {@link KycControllerState.sessionStatus}'s current `id`. Each tick writes\n * the result onto state only when the payload changed. The loop stops once\n * `finalStatus` is `approved`, `rejected`, or `retry`, or when\n * {@link reset} / {@link clearState} runs.\n *\n * @throws If there is no current session id to poll.\n */\nexport type KycControllerStartSessionStatusPollingAction = {\n  type: `KycController:startSessionStatusPolling`;\n  handler: KycController['startSessionStatusPolling'];\n};\n\n/**\n * Fetches the idOS + KYC-provider disclaimer catalog. Pass exactly one of\n * `sessionId` or `country`:\n *\n * - `{ sessionId }` → {@link KycService.fetchSessionDisclaimersBySessionId}\n * (`GET /sessions/{sessionId}/disclaimers`)\n * - `{ country }` → {@link KycService.fetchSessionDisclaimersByCountry}\n * (`GET /disclaimers?country=`)\n *\n * A session-id fetch also writes the catalog to `sessionDisclaimers`.\n *\n * @param params - The parameters. Provide exactly one of `sessionId` or\n * `country`.\n * @param params.sessionId - The UKYC session id.\n * @param params.country - ISO 3166-1 alpha-3 country code.\n * @returns The catalog. Session fetches include consent state; country\n * fetches do not.\n */\nexport type KycControllerFetchSessionDisclaimersAction = {\n  type: `KycController:fetchSessionDisclaimers`;\n  handler: KycController['fetchSessionDisclaimers'];\n};\n\n/**\n * Fetches the session-scoped disclaimer catalog and records consents\n * derived from the T&C2 flags. Already-consented catalog rows are omitted\n * from the POST. A 409 is re-checked with a GET: continue only when every\n * accepted document is now consented, otherwise fail closed.\n *\n * @param params - Accepted session-disclaimer records.\n * @param params.providerDisclaimersAccepted - Accepted Sumsub disclaimer records.\n * @param params.idosDisclaimersAccepted - Accepted idOS disclaimer records.\n * @param params.credentialReusabilityConsentGiven - Whether credential\n * reuse was accepted.\n */\nexport type KycControllerRecordSessionDisclaimersAction = {\n  type: `KycController:recordSessionDisclaimers`;\n  handler: KycController['recordSessionDisclaimers'];\n};\n\n/**\n * Fetches session-scoped disclaimers and reports whether every document is\n * consented and credential reuse was accepted.\n *\n * @returns Whether session disclaimers are complete.\n * @throws If there is no session on state.\n */\nexport type KycControllerHasCompletedSessionDisclaimersAction = {\n  type: `KycController:hasCompletedSessionDisclaimers`;\n  handler: KycController['hasCompletedSessionDisclaimers'];\n};\n\n/**\n * Fetches the vendor T&Cs the customer must accept before a session is\n * created (`GET /vendors/{vendor}/disclaimers?country=`).\n *\n * @param params - The parameters.\n * @param params.vendor - Identity vendor. Defaults to `moonpay`.\n * @param params.country - ISO 3166-1 alpha-3 country code.\n * @returns The disclaimers.\n */\nexport type KycControllerFetchVendorDisclaimersAction = {\n  type: `KycController:fetchVendorDisclaimers`;\n  handler: KycController['fetchVendorDisclaimers'];\n};\n\n/**\n * Records vendor T&C acceptance via {@link KycService.submitVendorDisclaimers}\n * and persists the accepted ids on state.\n *\n * @param params - The parameters.\n * @param params.disclaimerIds - Accepted vendor T&C ids.\n * @returns The vendor signing records.\n * @throws If `vendor` is missing from state.\n */\nexport type KycControllerRecordVendorDisclaimersAction = {\n  type: `KycController:recordVendorDisclaimers`;\n  handler: KycController['recordVendorDisclaimers'];\n};\n\n/**\n * Fetches the current vendor T&C catalog and returns whether every document\n * is already recorded in {@link KycControllerState.vendorDisclaimersAccepted}.\n *\n * @returns Whether persisted acceptance covers the fetched catalog.\n * @throws If `vendor` or `geoCountry` is missing from state.\n */\nexport type KycControllerHasCompletedVendorDisclaimersAction = {\n  type: `KycController:hasCompletedVendorDisclaimers`;\n  handler: KycController['hasCompletedVendorDisclaimers'];\n};\n\n/**\n * Presents the identity-provider verification UI. Currently launches SumSub.\n *\n * @param params - Optional SDK presentation options.\n * @param params.locale - BCP-47 locale for the SDK UI.\n * @param params.debug - Enables SDK debug logging.\n * @returns A promise that settles when the provider flow finishes.\n */\nexport type KycControllerLaunchProviderFlowAction = {\n  type: `KycController:launchProviderFlow`;\n  handler: KycController['launchProviderFlow'];\n};\n\n/**\n * Union of all KycController action types.\n */\nexport type KycControllerMethodActions =\n  | KycControllerStartSessionAction\n  | KycControllerResetAction\n  | KycControllerClearStateAction\n  | KycControllerGetSessionStatusForVendorAction\n  | KycControllerRefreshSessionStatusAction\n  | KycControllerStartSessionStatusPollingAction\n  | KycControllerFetchSessionDisclaimersAction\n  | KycControllerRecordSessionDisclaimersAction\n  | KycControllerHasCompletedSessionDisclaimersAction\n  | KycControllerFetchVendorDisclaimersAction\n  | KycControllerRecordVendorDisclaimersAction\n  | KycControllerHasCompletedVendorDisclaimersAction\n  | KycControllerLaunchProviderFlowAction;\n"]}