@metamask/ramps-controller 2.0.0 → 3.0.0

package/dist/selectors.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"selectors.d.mts","sourceRoot":"","sources":["../src/selectors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,8BAA0B;AAI9D;;;;;;GAMG;AACH,MAAM,MAAM,qBAAqB,CAAC,KAAK,IAAI;IACzC,+EAA+E;IAC/E,IAAI,EAAE,KAAK,GAAG,IAAI,CAAC;IACnB,oDAAoD;IACpD,UAAU,EAAE,OAAO,CAAC;IACpB,uFAAuF;IACvF,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDG;AACH,wBAAgB,qBAAqB,CAAC,UAAU,EAAE,KAAK,EACrD,QAAQ,EAAE,CAAC,SAAS,EAAE,UAAU,KAAK,oBAAoB,GAAG,SAAS,EACrE,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,OAAO,EAAE,GAChB,CAAC,KAAK,EAAE,UAAU,KAAK,qBAAqB,CAAC,KAAK,CAAC,CAsBrD"}

package/dist/selectors.mjs

@@ -0,0 +1,77 @@
+import { RequestStatus, createCacheKey } from "./RequestCache.mjs";
+/**
+ * Creates a memoized selector for a controller method's request state.
+ *
+ * This selector tracks the loading, error, and data state for a specific
+ * controller method call. It's optimized for use with React Redux's `useSelector`
+ * hook - the selector returns the same object reference when the underlying
+ * request state hasn't changed, so no `shallowEqual` is needed.
+ *
+ * The selector uses reference equality on the request object itself, so it
+ * works correctly with arrays and objects without expensive deep equality checks.
+ *
+ * @param getState - Function that extracts RampsControllerState from the root state.
+ *   Typically a reselect selector like `selectRampsControllerState`.
+ * @param method - The controller method name (e.g., 'updateUserRegion').
+ * @param params - The parameters passed to the method, used to generate the cache key.
+ *   Must match the params used when calling the controller method.
+ * @returns A selector function that returns `{ data, isFetching, error }`.
+ *
+ * @example
+ * ```ts
+ * // In selectors file - create once at module level
+ * import { createRequestSelector } from '@metamask/ramps-controller';
+ * import { createSelector } from 'reselect';
+ *
+ * const selectRampsControllerState = createSelector(
+ *   (state: RootState) => state.engine.backgroundState.RampsController,
+ *   (rampsControllerState) => rampsControllerState,
+ * );
+ *
+ * export const selectUserRegionRequest = createRequestSelector<
+ *   RootState,
+ *   string
+ * >(selectRampsControllerState, 'updateUserRegion', []);
+ *
+ * // In hook - use directly with useSelector, no shallowEqual needed
+ * export function useRampsUserRegion() {
+ *   const { isFetching, error } = useSelector(selectUserRegionRequest);
+ *   // ... rest of hook
+ * }
+ * ```
+ *
+ * @example
+ * ```ts
+ * // For methods with parameters
+ * export const selectCryptoCurrenciesRequest = (region: string) =>
+ *   createRequestSelector<RootState, CryptoCurrency[]>(
+ *     selectRampsControllerState,
+ *     'getCryptoCurrencies',
+ *     [region],
+ *   );
+ *
+ * // In component
+ * const { data, isFetching, error } = useSelector(
+ *   selectCryptoCurrenciesRequest('US')
+ * );
+ * ```
+ */
+export function createRequestSelector(getState, method, params) {
+    const cacheKey = createCacheKey(method, params);
+    let lastRequest;
+    let lastResult = null;
+    return (state) => {
+        const request = getState(state)?.requests?.[cacheKey];
+        if (request === lastRequest && lastResult !== null) {
+            return lastResult;
+        }
+        lastRequest = request;
+        lastResult = {
+            data: request?.data ?? null,
+            isFetching: request?.status === RequestStatus.LOADING,
+            error: request?.error ?? null,
+        };
+        return lastResult;
+    };
+}
+//# sourceMappingURL=selectors.mjs.map

package/dist/selectors.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"selectors.mjs","sourceRoot":"","sources":["../src/selectors.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,2BAAuB;AAkB/D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDG;AACH,MAAM,UAAU,qBAAqB,CACnC,QAAqE,EACrE,MAAc,EACd,MAAiB;IAEjB,MAAM,QAAQ,GAAG,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEhD,IAAI,WAAqC,CAAC;IAC1C,IAAI,UAAU,GAAwC,IAAI,CAAC;IAE3D,OAAO,CAAC,KAAiB,EAAgC,EAAE;QACzD,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAC,EAAE,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC;QAEtD,IAAI,OAAO,KAAK,WAAW,IAAI,UAAU,KAAK,IAAI,EAAE,CAAC;YACnD,OAAO,UAAU,CAAC;QACpB,CAAC;QAED,WAAW,GAAG,OAAO,CAAC;QACtB,UAAU,GAAG;YACX,IAAI,EAAG,OAAO,EAAE,IAAc,IAAI,IAAI;YACtC,UAAU,EAAE,OAAO,EAAE,MAAM,KAAK,aAAa,CAAC,OAAO;YACrD,KAAK,EAAE,OAAO,EAAE,KAAK,IAAI,IAAI;SAC9B,CAAC;QAEF,OAAO,UAAU,CAAC;IACpB,CAAC,CAAC;AACJ,CAAC","sourcesContent":["import type { RampsControllerState } from './RampsController';\nimport type { RequestState } from './RequestCache';\nimport { RequestStatus, createCacheKey } from './RequestCache';\n\n/**\n * Result shape returned by request selectors.\n *\n * This object is memoized - the same reference is returned when the underlying\n * request state hasn't changed, making it safe to use with React Redux's\n * `useSelector` without `shallowEqual`.\n */\nexport type RequestSelectorResult<TData> = {\n  /** The data returned by the request, or null if not yet loaded or on error. */\n  data: TData | null;\n  /** Whether the request is currently in progress. */\n  isFetching: boolean;\n  /** Error message if the request failed, or null if successful or not yet attempted. */\n  error: string | null;\n};\n\n/**\n * Creates a memoized selector for a controller method's request state.\n *\n * This selector tracks the loading, error, and data state for a specific\n * controller method call. It's optimized for use with React Redux's `useSelector`\n * hook - the selector returns the same object reference when the underlying\n * request state hasn't changed, so no `shallowEqual` is needed.\n *\n * The selector uses reference equality on the request object itself, so it\n * works correctly with arrays and objects without expensive deep equality checks.\n *\n * @param getState - Function that extracts RampsControllerState from the root state.\n *   Typically a reselect selector like `selectRampsControllerState`.\n * @param method - The controller method name (e.g., 'updateUserRegion').\n * @param params - The parameters passed to the method, used to generate the cache key.\n *   Must match the params used when calling the controller method.\n * @returns A selector function that returns `{ data, isFetching, error }`.\n *\n * @example\n * ```ts\n * // In selectors file - create once at module level\n * import { createRequestSelector } from '@metamask/ramps-controller';\n * import { createSelector } from 'reselect';\n *\n * const selectRampsControllerState = createSelector(\n *   (state: RootState) => state.engine.backgroundState.RampsController,\n *   (rampsControllerState) => rampsControllerState,\n * );\n *\n * export const selectUserRegionRequest = createRequestSelector<\n *   RootState,\n *   string\n * >(selectRampsControllerState, 'updateUserRegion', []);\n *\n * // In hook - use directly with useSelector, no shallowEqual needed\n * export function useRampsUserRegion() {\n *   const { isFetching, error } = useSelector(selectUserRegionRequest);\n *   // ... rest of hook\n * }\n * ```\n *\n * @example\n * ```ts\n * // For methods with parameters\n * export const selectCryptoCurrenciesRequest = (region: string) =>\n *   createRequestSelector<RootState, CryptoCurrency[]>(\n *     selectRampsControllerState,\n *     'getCryptoCurrencies',\n *     [region],\n *   );\n *\n * // In component\n * const { data, isFetching, error } = useSelector(\n *   selectCryptoCurrenciesRequest('US')\n * );\n * ```\n */\nexport function createRequestSelector<TRootState, TData>(\n  getState: (rootState: TRootState) => RampsControllerState | undefined,\n  method: string,\n  params: unknown[],\n): (state: TRootState) => RequestSelectorResult<TData> {\n  const cacheKey = createCacheKey(method, params);\n\n  let lastRequest: RequestState | undefined;\n  let lastResult: RequestSelectorResult<TData> | null = null;\n\n  return (state: TRootState): RequestSelectorResult<TData> => {\n    const request = getState(state)?.requests?.[cacheKey];\n\n    if (request === lastRequest && lastResult !== null) {\n      return lastResult;\n    }\n\n    lastRequest = request;\n    lastResult = {\n      data: (request?.data as TData) ?? null,\n      isFetching: request?.status === RequestStatus.LOADING,\n      error: request?.error ?? null,\n    };\n\n    return lastResult;\n  };\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/ramps-controller",
-  "version": "2.0.0",
+  "version": "3.0.0",
   "description": "A controller for managing cryptocurrency on/off ramps functionality",
   "keywords": [
     "MetaMask",
@@ -50,7 +50,7 @@
   },
   "dependencies": {
     "@metamask/base-controller": "^9.0.0",
-    "@metamask/controller-utils": "^11.16.0",
+    "@metamask/controller-utils": "^11.18.0",
     "@metamask/messenger": "^0.3.0"
   },
   "devDependencies": {