@metamask-previews/ramps-controller 5.1.0-preview-8a281087 → 5.1.0-preview-2aeb1204

package/dist/RampsController.cjs

@@ -10,7 +10,7 @@ var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
     return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
 };
-var _RampsController_instances, _RampsController_requestCacheTTL, _RampsController_requestCacheMaxSize, _RampsController_pendingRequests, _RampsController_pendingResourceCount, _RampsController_setUserRegionRefetchCount, _RampsController_clearPendingResourceCountForDependentResources, _RampsController_removeRequestState, _RampsController_cleanupState, _RampsController_fireAndForget, _RampsController_updateResourceField, _RampsController_setResourceLoading, _RampsController_setResourceError, _RampsController_updateRequestState;
+var _RampsController_instances, _RampsController_requestCacheTTL, _RampsController_requestCacheMaxSize, _RampsController_pendingRequests, _RampsController_pendingResourceCount, _RampsController_clearPendingResourceCountForDependentResources, _RampsController_removeRequestState, _RampsController_cleanupState, _RampsController_fireAndForget, _RampsController_updateResourceField, _RampsController_setResourceLoading, _RampsController_setResourceError, _RampsController_updateRequestState;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RampsController = exports.getDefaultRampsControllerState = exports.RAMPS_CONTROLLER_REQUIRED_SERVICE_ACTIONS = exports.controllerName = void 0;
 const base_controller_1 = require("@metamask/base-controller");
@@ -114,7 +114,7 @@ function createDefaultResourceState(data, selected = null) {
  */
 function getDefaultRampsControllerState() {
     return {
-        userRegion: createDefaultResourceState(null),
+        userRegion: null,
         countries: createDefaultResourceState([]),
         providers: createDefaultResourceState([], null),
         tokens: createDefaultResourceState(null, null),
@@ -130,14 +130,12 @@ exports.getDefaultRampsControllerState = getDefaultRampsControllerState;
  *
  * @param state - The state object to mutate.
  * @param options - Options for the reset.
- * @param options.clearUserRegionData - When true, sets userRegion.data to null (e.g. for full cleanup).
+ * @param options.clearUserRegionData - When true, sets userRegion to null (e.g. for full cleanup).
  */
 function resetDependentResources(state, options) {
     if (options?.clearUserRegionData) {
-        state.userRegion.data = null;
+        state.userRegion = null;
     }
-    state.userRegion.isLoading = false;
-    state.userRegion.error = null;
     state.providers.selected = null;
     state.providers.data = [];
     state.providers.isLoading = false;
@@ -262,11 +260,6 @@ class RampsController extends base_controller_1.BaseController {
          * Used so isLoading is only cleared when the last request for that resource finishes.
          */
         _RampsController_pendingResourceCount.set(this, new Map());
-        /**
-         * Count of in-flight setUserRegion refetch batches.
-         * Used so userRegion.isLoading is only cleared when the last batch's refetches finish (avoids race when region is changed rapidly or when init() clears loading before refetches complete).
-         */
-        _RampsController_setUserRegionRefetchCount.set(this, 0);
         __classPrivateFieldSet(this, _RampsController_requestCacheTTL, requestCacheTTL, "f");
         __classPrivateFieldSet(this, _RampsController_requestCacheMaxSize, requestCacheMaxSize, "f");
     }
@@ -398,12 +391,6 @@ class RampsController extends base_controller_1.BaseController {
      * Sets the user's region manually (without fetching geolocation).
      * This allows users to override the detected region.
      *
-     * Sets userRegion.isLoading to true while the region is being applied and
-     * tokens/providers are refetched (when the region actually changes), so
-     * the UI can show a loading indicator when called directly (e.g. from a
-     * region selector). Clears loading when refetches complete or when no
-     * refetch is needed.
-     *
      * @param region - The region code to set (e.g., "US-CA").
      * @param options - Options for cache behavior.
      * @returns The user region object.
@@ -421,13 +408,10 @@ class RampsController extends base_controller_1.BaseController {
                 __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_cleanupState).call(this);
                 throw new Error(`Region "${normalizedRegion}" not found in countries data. Cannot set user region without valid country information.`);
             }
-            const regionChanged = normalizedRegion !== this.state.userRegion.data?.regionCode;
+            const regionChanged = normalizedRegion !== this.state.userRegion?.regionCode;
             const needsRefetch = regionChanged ||
                 !this.state.tokens.data ||
                 this.state.providers.data.length === 0;
-            if (needsRefetch) {
-                __classPrivateFieldSet(this, _RampsController_setUserRegionRefetchCount, __classPrivateFieldGet(this, _RampsController_setUserRegionRefetchCount, "f") + 1, "f");
-            }
             if (regionChanged) {
                 __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_clearPendingResourceCountForDependentResources).call(this);
             }
@@ -435,29 +419,19 @@ class RampsController extends base_controller_1.BaseController {
                 if (regionChanged) {
                     resetDependentResources(state);
                 }
-                state.userRegion.data = userRegion;
+                state.userRegion = userRegion;
             });
             if (needsRefetch) {
-                __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_setResourceLoading).call(this, 'userRegion', true);
-            }
-            // this code is needed to prevent race conditions in the unlikely event that the user's region is changed rapidly
-            const refetchPromises = [];
-            if (regionChanged || !this.state.tokens.data) {
-                refetchPromises.push(this.getTokens(userRegion.regionCode, 'buy', options));
-            }
-            if (regionChanged || this.state.providers.data.length === 0) {
-                refetchPromises.push(this.getProviders(userRegion.regionCode, options));
-            }
-            if (refetchPromises.length > 0) {
-                __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_fireAndForget).call(this, Promise.all(refetchPromises).finally(() => {
-                    __classPrivateFieldSet(this, _RampsController_setUserRegionRefetchCount, Math.max(0, __classPrivateFieldGet(this, _RampsController_setUserRegionRefetchCount, "f") - 1), "f");
-                    if (__classPrivateFieldGet(this, _RampsController_setUserRegionRefetchCount, "f") === 0) {
-                        __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_setResourceLoading).call(this, 'userRegion', false);
-                    }
-                }));
-            }
-            else {
-                __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_setResourceLoading).call(this, 'userRegion', false);
+                const refetchPromises = [];
+                if (regionChanged || !this.state.tokens.data) {
+                    refetchPromises.push(this.getTokens(userRegion.regionCode, 'buy', options));
+                }
+                if (regionChanged || this.state.providers.data.length === 0) {
+                    refetchPromises.push(this.getProviders(userRegion.regionCode, options));
+                }
+                if (refetchPromises.length > 0) {
+                    __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_fireAndForget).call(this, Promise.all(refetchPromises));
+                }
             }
             return userRegion;
         }
@@ -483,7 +457,7 @@ class RampsController extends base_controller_1.BaseController {
             });
             return;
         }
-        const regionCode = this.state.userRegion.data?.regionCode;
+        const regionCode = this.state.userRegion?.regionCode;
         if (!regionCode) {
             throw new Error('Region is required. Cannot set selected provider without valid region information.');
         }
@@ -513,31 +487,16 @@ class RampsController extends base_controller_1.BaseController {
      * @returns Promise that resolves when initialization is complete.
      */
     async init(options) {
-        __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_setResourceLoading).call(this, 'userRegion', true);
-        let setUserRegionCompleted = false;
-        try {
-            await this.getCountries(options);
-            let regionCode = this.state.userRegion.data?.regionCode;
-            regionCode ?? (regionCode = await this.messenger.call('RampsService:getGeolocation'));
-            if (!regionCode) {
-                throw new Error('Failed to fetch geolocation. Cannot initialize controller without valid region information.');
-            }
-            await this.setUserRegion(regionCode, options);
-            setUserRegionCompleted = true;
-            __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_setResourceError).call(this, 'userRegion', null);
-        }
-        catch (error) {
-            __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_setResourceError).call(this, 'userRegion', error?.message ?? 'Unknown error');
-            throw error;
-        }
-        finally {
-            if (!setUserRegionCompleted) {
-                __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_setResourceLoading).call(this, 'userRegion', false);
-            }
+        await this.getCountries(options);
+        let regionCode = this.state.userRegion?.regionCode;
+        regionCode ?? (regionCode = await this.messenger.call('RampsService:getGeolocation'));
+        if (!regionCode) {
+            throw new Error('Failed to fetch geolocation. Cannot initialize controller without valid region information.');
         }
+        await this.setUserRegion(regionCode, options);
     }
     hydrateState(options) {
-        const regionCode = this.state.userRegion.data?.regionCode;
+        const regionCode = this.state.userRegion?.regionCode;
         if (!regionCode) {
             throw new Error('Region code is required. Cannot hydrate state without valid region information.');
         }
@@ -573,7 +532,7 @@ class RampsController extends base_controller_1.BaseController {
      * @returns The tokens response containing topTokens and allTokens.
      */
     async getTokens(region, action = 'buy', options) {
-        const regionToUse = region ?? this.state.userRegion.data?.regionCode;
+        const regionToUse = region ?? this.state.userRegion?.regionCode;
         if (!regionToUse) {
             throw new Error('Region is required. Either provide a region parameter or ensure userRegion is set in controller state.');
         }
@@ -590,11 +549,11 @@ class RampsController extends base_controller_1.BaseController {
         }, {
             ...options,
             resourceType: 'tokens',
-            isResultCurrent: () => this.state.userRegion.data?.regionCode === undefined ||
-                this.state.userRegion.data?.regionCode === normalizedRegion,
+            isResultCurrent: () => this.state.userRegion?.regionCode === undefined ||
+                this.state.userRegion?.regionCode === normalizedRegion,
         });
         this.update((state) => {
-            const userRegionCode = state.userRegion.data?.regionCode;
+            const userRegionCode = state.userRegion?.regionCode;
             if (userRegionCode === undefined || userRegionCode === normalizedRegion) {
                 state.tokens.data = tokens;
             }
@@ -618,7 +577,7 @@ class RampsController extends base_controller_1.BaseController {
             });
             return;
         }
-        const regionCode = this.state.userRegion.data?.regionCode;
+        const regionCode = this.state.userRegion?.regionCode;
         if (!regionCode) {
             throw new Error('Region is required. Cannot set selected token without valid region information.');
         }
@@ -651,7 +610,7 @@ class RampsController extends base_controller_1.BaseController {
      * @returns The providers response containing providers array.
      */
     async getProviders(region, options) {
-        const regionToUse = region ?? this.state.userRegion.data?.regionCode;
+        const regionToUse = region ?? this.state.userRegion?.regionCode;
         if (!regionToUse) {
             throw new Error('Region is required. Either provide a region parameter or ensure userRegion is set in controller state.');
         }
@@ -673,11 +632,11 @@ class RampsController extends base_controller_1.BaseController {
         }, {
             ...options,
             resourceType: 'providers',
-            isResultCurrent: () => this.state.userRegion.data?.regionCode === undefined ||
-                this.state.userRegion.data?.regionCode === normalizedRegion,
+            isResultCurrent: () => this.state.userRegion?.regionCode === undefined ||
+                this.state.userRegion?.regionCode === normalizedRegion,
         });
         this.update((state) => {
-            const userRegionCode = state.userRegion.data?.regionCode;
+            const userRegionCode = state.userRegion?.regionCode;
             if (userRegionCode === undefined || userRegionCode === normalizedRegion) {
                 state.providers.data = providers;
             }
@@ -696,8 +655,8 @@ class RampsController extends base_controller_1.BaseController {
      * @returns The payment methods response containing payments array.
      */
     async getPaymentMethods(region, options) {
-        const regionCode = region ?? this.state.userRegion.data?.regionCode ?? null;
-        const fiatToUse = options?.fiat ?? this.state.userRegion.data?.country?.currency ?? null;
+        const regionCode = region ?? this.state.userRegion?.regionCode ?? null;
+        const fiatToUse = options?.fiat ?? this.state.userRegion?.country?.currency ?? null;
         const assetIdToUse = options?.assetId ?? this.state.tokens.selected?.assetId ?? '';
         const providerToUse = options?.provider ?? this.state.providers.selected?.id ?? '';
         if (!regionCode) {
@@ -725,8 +684,8 @@ class RampsController extends base_controller_1.BaseController {
             ...options,
             resourceType: 'paymentMethods',
             isResultCurrent: () => {
-                const regionMatch = this.state.userRegion.data?.regionCode === undefined ||
-                    this.state.userRegion.data?.regionCode === normalizedRegion;
+                const regionMatch = this.state.userRegion?.regionCode === undefined ||
+                    this.state.userRegion?.regionCode === normalizedRegion;
                 const tokenMatch = (this.state.tokens.selected?.assetId ?? '') === assetIdToUse;
                 const providerMatch = (this.state.providers.selected?.id ?? '') === providerToUse;
                 return regionMatch && tokenMatch && providerMatch;
@@ -796,8 +755,8 @@ class RampsController extends base_controller_1.BaseController {
      * @returns The quotes response containing success, sorted, error, and customActions.
      */
     async getQuotes(options) {
-        const regionToUse = options.region ?? this.state.userRegion.data?.regionCode;
-        const fiatToUse = options.fiat ?? this.state.userRegion.data?.country?.currency;
+        const regionToUse = options.region ?? this.state.userRegion?.regionCode;
+        const fiatToUse = options.fiat ?? this.state.userRegion?.country?.currency;
         const paymentMethodsToUse = options.paymentMethods ??
             this.state.paymentMethods.data.map((pm) => pm.id);
         const action = options.action ?? 'buy';
@@ -851,11 +810,11 @@ class RampsController extends base_controller_1.BaseController {
             forceRefresh: options.forceRefresh,
             ttl: options.ttl ?? DEFAULT_QUOTES_TTL,
             resourceType: 'quotes',
-            isResultCurrent: () => this.state.userRegion.data?.regionCode === undefined ||
-                this.state.userRegion.data?.regionCode === normalizedRegion,
+            isResultCurrent: () => this.state.userRegion?.regionCode === undefined ||
+                this.state.userRegion?.regionCode === normalizedRegion,
         });
         this.update((state) => {
-            const userRegionCode = state.userRegion.data?.regionCode;
+            const userRegionCode = state.userRegion?.regionCode;
             if (userRegionCode === undefined || userRegionCode === normalizedRegion) {
                 state.quotes.data = response;
             }
@@ -874,9 +833,8 @@ class RampsController extends base_controller_1.BaseController {
     }
 }
 exports.RampsController = RampsController;
-_RampsController_requestCacheTTL = new WeakMap(), _RampsController_requestCacheMaxSize = new WeakMap(), _RampsController_pendingRequests = new WeakMap(), _RampsController_pendingResourceCount = new WeakMap(), _RampsController_setUserRegionRefetchCount = new WeakMap(), _RampsController_instances = new WeakSet(), _RampsController_clearPendingResourceCountForDependentResources = function _RampsController_clearPendingResourceCountForDependentResources() {
+_RampsController_requestCacheTTL = new WeakMap(), _RampsController_requestCacheMaxSize = new WeakMap(), _RampsController_pendingRequests = new WeakMap(), _RampsController_pendingResourceCount = new WeakMap(), _RampsController_instances = new WeakSet(), _RampsController_clearPendingResourceCountForDependentResources = function _RampsController_clearPendingResourceCountForDependentResources() {
     const types = [
-        'userRegion',
         'providers',
         'tokens',
         'paymentMethods',