npm - @metamask-previews/base-data-service - Versions diffs - 2.1.0-preview-9fd631f7d → 2.1.0-preview-6fbab7311 - Mend

@metamask-previews/base-data-service 2.1.0-preview-9fd631f7d → 2.1.0-preview-6fbab7311

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.

Files changed (9) hide show

package/CHANGELOG.md +1 -9
package/dist/BaseDataService.d.ts +2 -36
package/dist/BaseDataService.d.ts.map +1 -1
package/dist/BaseDataService.js +4 -111
package/dist/BaseDataService.js.map +1 -1
package/dist/index.d.ts +1 -1
package/dist/index.d.ts.map +1 -1
package/dist/index.js.map +1 -1
package/package.json +3 -3

package/CHANGELOG.md CHANGED Viewed

@@ -10,20 +10,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Add support for Node.js 26 ([#10981](https://github.com/MetaMask/core/pull/10981))
-- Add `onQueryStateChange` option to the protected `fetchQuery` method ([#11162](https://github.com/MetaMask/core/pull/11162))
-  - The callback receives the query state with serialized errors, first with the cached state if one exists, then on every update until the fetch has settled and the query is idle.
-  - Errors thrown by the callback are logged and ignored.
-  - This option is not available on `fetchInfiniteQuery`.
-- Export `CacheUpdatedState`, `DataServiceQueryState`, `QueryStateChangeHandler` and `SerializedQueryError` types ([#11162](https://github.com/MetaMask/core/pull/11162))
 ### Changed
-- **BREAKING:** Serialize query errors in `:cacheUpdated` and `:cacheUpdated:${hash}` event payloads as `{ name, message }` objects instead of the thrown value ([#11162](https://github.com/MetaMask/core/pull/11162))
-  - This applies to both `error` and `fetchFailureReason` on each query state.
-  - Consumers that read properties other than `name` and `message` from these errors, or that relied on `instanceof Error`, must adapt.
-- Queries in `:cacheUpdated` and `:cacheUpdated:${hash}` event payloads no longer include the non serializable `promise` field of an in flight fetch, so payloads stay JSON safe ([#11162](https://github.com/MetaMask/core/pull/11162))
 - Bump `@tanstack/query-core` from `^5.89.0` to `^5.103.2` ([#10511](https://github.com/MetaMask/core/pull/10511))
 - Bump `@metamask/utils` from `^12.0.0` to `^12.0.1` ([#11107](https://github.com/MetaMask/core/pull/11107))
+- Bump `uuid` from `^11.1.1` to `^14.0.0` ([#10941](https://github.com/MetaMask/core/pull/10941))
 ## [2.1.0]

package/dist/BaseDataService.d.ts CHANGED Viewed

@@ -18,40 +18,11 @@ export type MutationKey = Key;
  * events.
  */
 export type BaseMessenger<Namespace extends string> = Messenger<Namespace, ActionConstraint, EventConstraint, any>;
-/**
- * A JSON safe representation of an error thrown by a query.
- */
-export type SerializedQueryError = {
-    name: string;
-    message: string;
-};
-/**
- * The dehydrated state published in `:cacheUpdated` payloads, where query
- * errors are serialized and the in flight `promise` is omitted so the payload
- * survives JSON round trips.
- */
-export type CacheUpdatedState = Omit<DehydratedState, 'queries'> & {
-    queries: (Omit<DehydratedState['queries'][number], 'state' | 'promise'> & {
-        state: DataServiceQueryState;
-    })[];
-};
-/**
- * The state of a single query, as reported to `onQueryStateChange` handlers.
- * Errors are serialized so the state is JSON safe.
- */
-export type DataServiceQueryState = Omit<DehydratedState['queries'][number]['state'], 'error' | 'fetchFailureReason'> & {
-    error: SerializedQueryError | null;
-    fetchFailureReason: SerializedQueryError | null;
-};
-/**
- * A callback that receives the state of a query as it changes.
- */
-export type QueryStateChangeHandler = (state: DataServiceQueryState) => void;
 export type DataServiceGranularCacheUpdatedPayload = {
     objectType: 'query' | 'mutation';
 } & ({
     type: 'added' | 'updated';
-    state: CacheUpdatedState;
+    state: DehydratedState;
 } | {
     type: 'removed';
     state: null;
@@ -112,16 +83,11 @@ export declare class BaseDataService<ServiceName extends string, ServiceMessenge
      * Additionally `retry` and `retryDelay` are not available, retries can be customized using the `servicePolicyOptions`.
      * @param options.queryFn - The query function.
      * @param options.responseStruct - An optional struct for validating the response of the query function.
-     * @param options.onQueryStateChange - An optional callback that receives the
-     * state of the query (with serialized errors) as it changes. It is called
-     * once with the current state if the query is already cached, then with
-     * every update until the fetch has settled and the query is idle.
      * @returns The query results.
      */
-    protected fetchQuery<TQueryFnData extends Json, TError = DefaultError, TDataStruct extends Struct<TQueryFnData> | undefined = undefined, TData = TDataStruct extends Struct<infer StructType> ? StructType : TQueryFnData, TQueryKey extends QueryKey = QueryKey>({ queryFn, responseStruct, onQueryStateChange, ...options }: WithRequired<OmitKeyof<FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'retry' | 'retryDelay' | 'queryFn'>, 'queryKey'> & {
+    protected fetchQuery<TQueryFnData extends Json, TError = DefaultError, TDataStruct extends Struct<TQueryFnData> | undefined = undefined, TData = TDataStruct extends Struct<infer StructType> ? StructType : TQueryFnData, TQueryKey extends QueryKey = QueryKey>({ queryFn, responseStruct, ...options }: WithRequired<OmitKeyof<FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'retry' | 'retryDelay' | 'queryFn'>, 'queryKey'> & {
         queryFn: QueryFunction<TQueryFnData, TQueryKey>;
         responseStruct?: TDataStruct;
-        onQueryStateChange?: QueryStateChangeHandler;
     }): Promise<TData>;
     /**
      * Fetch a paginated query.

package/dist/BaseDataService.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"BaseDataService.d.ts","sourceRoot":"","sources":["../src/BaseDataService.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,gBAAgB,EAChB,eAAe,EACf,gBAAgB,EAChB,eAAe,EAChB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EACV,2BAA2B,EAC3B,8BAA8B,EAC9B,2BAA2B,EAC5B,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAE/C,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EACL,YAAY,EAEZ,eAAe,EACf,iBAAiB,EACjB,YAAY,EACZ,8BAA8B,EAC9B,aAAa,EACb,iBAAiB,EACjB,sBAAsB,EACtB,eAAe,EACf,SAAS,EAET,iBAAiB,EACjB,YAAY,EACZ,aAAa,EACb,YAAY,EAIZ,gBAAgB,EACjB,MAAM,sBAAsB,CAAC;AAK9B,OAAO,EAEL,0BAA0B,EAE3B,MAAM,0BAA0B,CAAC;AAMlC;;;GAGG;AACH,KAAK,GAAG,GAAG,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;AAM9D,MAAM,MAAM,QAAQ,GAAG,GAAG,CAAC;AAM3B,MAAM,MAAM,WAAW,GAAG,GAAG,CAAC;AAE9B;;;;;GAKG;AACH,MAAM,MAAM,aAAa,CAAC,SAAS,SAAS,MAAM,IAAI,SAAS,CAC7D,SAAS,EACT,gBAAgB,EAChB,eAAe,EAIf,GAAG,CACJ,CAAC;AAEF~~;;GAEG;AACH~~,MAAM,MAAM,oBAAoB,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC;AAErE;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,IAAI,CAAC,eAAe,EAAE,SAAS,CAAC,GAAG;IACjE,OAAO,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC,GAAG;QACxE,KAAK,EAAE,qBAAqB,CAAC;KAC9B,CAAC,EAAE,CAAC;CACN,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG,IAAI,CACtC,eAAe,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,EAC3C,OAAO,GAAG,oBAAoB,CAC/B,GAAG;IACF,KAAK,EAAE,oBAAoB,GAAG,IAAI,CAAC;IACnC,kBAAkB,EAAE,oBAAoB,GAAG,IAAI,CAAC;CACjD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,CAAC,KAAK,EAAE,qBAAqB,KAAK,IAAI,CAAC;AAkC7E,MAAM,MAAM,sCAAsC,GAAG;IACnD,UAAU,EAAE,OAAO,GAAG,UAAU,CAAC;CAClC,GAAG,CACA;IAAE,IAAI,EAAE,OAAO,GAAG,SAAS,CAAC;IAAC,KAAK,EAAE,~~iBAAiB~~,CAAA;CAAE,~~GACvD~~;IACE,IAAI,EAAE,SAAS,CAAC;IAChB,KAAK,EAAE,IAAI,CAAC;CACb,CACJ,CAAC;AAEF,MAAM,MAAM,8BAA8B,GACxC,sCAAsC,GAAG;IACvC,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAIJ,MAAM,MAAM,kCAAkC,CAAC,WAAW,SAAS,MAAM,IAAI;IAC3E,IAAI,EAAE,GAAG,WAAW,oBAAoB,CAAC;IACzC,OAAO,EAAE,eAAe,CACtB,WAAW,EACX,aAAa,CAAC,WAAW,CAAC,CAC3B,CAAC,mBAAmB,CAAC,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,kBAAkB,CAAC,WAAW,SAAS,MAAM,IACvD,kCAAkC,CAAC,WAAW,CAAC,CAAC;AAElD,KAAK,yBAAyB,GAC1B,2BAA2B,GAC3B,2BAA2B,GAC3B,8BAA8B,CAAC;AAEnC,MAAM,MAAM,4BAA4B,CAAC,WAAW,SAAS,MAAM,IAAI;IACrE,IAAI,EAAE,GAAG,WAAW,eAAe,CAAC;IACpC,OAAO,EAAE,CAAC,8BAA8B,CAAC,CAAC;CAC3C,CAAC;AAEF,MAAM,MAAM,oCAAoC,CAAC,WAAW,SAAS,MAAM,IAAI;IAC7E,IAAI,EAAE,GAAG,WAAW,iBAAiB,MAAM,EAAE,CAAC;IAC9C,OAAO,EAAE,CAAC,sCAAsC,CAAC,CAAC;CACnD,CAAC;AAEF,MAAM,MAAM,iBAAiB,CAAC,WAAW,SAAS,MAAM,IACpD,4BAA4B,CAAC,WAAW,CAAC,GACzC,oCAAoC,CAAC,WAAW,CAAC,CAAC;AAetD,eAAO,MAAM,mBAAmB,UAAU,CAAC;AAE3C;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAOF,qBAAa,eAAe,CAC1B,WAAW,SAAS,MAAM,EAC1B,gBAAgB,SAAS,aAAa,CAAC,WAAW,CAAC;;IAEnD,SAAgB,IAAI,EAAE,WAAW,CAAC;IAalC,SAAS,CAAC,SAAS,EAAE,gBAAgB,CAAC;IActC,YAAY,EACV,IAAI,EACJ,SAAS,EACT,iBAAsB,EACtB,aAAa,EACb,iBAAiB,GAClB,EAAE;QACD,IAAI,EAAE,WAAW,CAAC;QAClB,SAAS,EAAE,kBAAkB,CAAC,WAAW,CAAC,CAAC,MAAM,CAAC,SAC9C,gBAAgB,CAAC,gBAAgB,CAAC,CAAC,MAAM,CAAC,GAC1C,yBAAyB,CAAC,MAAM,CAAC,GACjC,iBAAiB,CAAC,WAAW,CAAC,CAAC,MAAM,CAAC,SAAS,eAAe,CAAC,gBAAgB,CAAC,CAAC,MAAM,CAAC,GACtF,gBAAgB,GAChB,KAAK,GACP,KAAK,CAAC;QACV,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;QACtC,aAAa,CAAC,EAAE,0BAA0B,CAAC;QAC3C,iBAAiB,CAAC,EAAE,wBAAwB,CAAC;KAC9C,EA6FA;IAED~~;;;;;;;;;;;;OAYG~~;IACH,UAAgB,UAAU,CACxB,YAAY,SAAS,IAAI,EACzB,MAAM,GAAG,YAAY,EACrB,WAAW,SAAS,MAAM,CAAC,YAAY,CAAC,GAAG,SAAS,GAAG,SAAS,EAChE,KAAK,GAAG,WAAW,SAAS,MAAM,CAAC,MAAM,UAAU,CAAC,GAChD,UAAU,GACV,YAAY,EAChB,SAAS,SAAS,QAAQ,GAAG,QAAQ,EACrC,EACA,OAAO,EACP,cAAc,EACd,~~kBAAkB,EAClB,~~GAAG,OAAO,EACX,EAAE,YAAY,CACb,SAAS,CACP,iBAAiB,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,CAAC,EACzD,OAAO,GAAG,YAAY,GAAG,SAAS,CACnC,EACD,UAAU,CACX,GAAG;QACF,OAAO,EAAE,aAAa,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;QAChD,cAAc,CAAC,EAAE,WAAW,CAAC;~~QAC7B~~,~~kBAAkB,CAAC,EAAE,uBAAuB,CAAC;KAC9C,~~GAAG,OAAO,CAAC,KAAK,CAAC,~~CAuBjB~~;IAED;;;;;;;;OAQG;IACH,UAAgB,kBAAkB,CAChC,YAAY,SAAS,IAAI,EACzB,MAAM,GAAG,YAAY,EACrB,WAAW,SAAS,MAAM,CAAC,YAAY,CAAC,GAAG,SAAS,GAAG,SAAS,EAChE,KAAK,SAAS,YAAY,GAAG,WAAW,SAAS,MAAM,CAAC,MAAM,UAAU,CAAC,GACrE,UAAU,GACV,YAAY,EAChB,SAAS,SAAS,QAAQ,GAAG,QAAQ,EACrC,UAAU,SAAS,IAAI,GAAG,IAAI,EAE9B,EACE,cAAc,EACd,GAAG,OAAO,EACX,EAAE,YAAY,CACb,SAAS,CACP,iBAAiB,CACf,YAAY,EACZ,MAAM,EACN,YAAY,CAAC,KAAK,EAAE,UAAU,CAAC,EAC/B,SAAS,EACT,UAAU,CACX,EACD,OAAO,GAAG,YAAY,GAAG,SAAS,GAAG,kBAAkB,CACxD,EACD,UAAU,CACX,GACC,8BAA8B,CAAC,YAAY,EAAE,UAAU,CAAC,GAAG;QACzD,OAAO,EAAE,aAAa,CAAC,YAAY,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC;QAC5D,cAAc,CAAC,EAAE,WAAW,CAAC;KAC9B,EACH,SAAS,CAAC,EAAE,UAAU,GACrB,OAAO,CAAC,KAAK,CAAC,CAqDhB;IAED;;;;;;;;;;;;;;OAcG;IACH,UAAgB,eAAe,CAC7B,eAAe,SAAS,IAAI,EAC5B,WAAW,SAAS,MAAM,CAAC,eAAe,CAAC,GAAG,SAAS,GAAG,SAAS,EACnE,KAAK,GAAG,WAAW,SAAS,MAAM,CAAC,MAAM,UAAU,CAAC,GAChD,UAAU,GACV,eAAe,EACnB,MAAM,GAAG,YAAY,EACrB,eAAe,GAAG,OAAO,EACzB,YAAY,SAAS,WAAW,GAAG,WAAW,EAC9C,EACA,UAAU,EACV,cAAc,EACd,QAAmB,EACnB,GAAG,OAAO,EACX,EAAE,SAAS,CACV,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,eAAe,CAAC,EACrE,OAAO,GAAG,YAAY,GAAG,aAAa,GAAG,YAAY,CACtD,GAAG;QACF,WAAW,EAAE,YAAY,CAAC;QAC1B,UAAU,EAAE,gBAAgB,CAAC,eAAe,EAAE,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;QACpE,cAAc,CAAC,EAAE,WAAW,CAAC;QAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,GAAG,OAAO,CAAC,KAAK,CAAC,CAmCjB;IAED;;;;;;OAMG;IACG,iBAAiB,CACrB,OAAO,CAAC,EAAE,sBAAsB,CAAC,QAAQ,CAAC,EAC1C,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,IAAI,CAAC,CAEf;IAED;;;;;;;;;;OAUG;IACH,UAAgB,aAAa,CAC3B,OAAO,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,EAChC,aAAa,CAAC,EAAE,aAAa,GAC5B,OAAO,CAAC,IAAI,CAAC,CAEf;IAED;;OAEG;IACH,IAAI,IAAI,IAAI,CAKX;IAED;;;OAGG;IACH,OAAO,IAAI,IAAI,CAcd;~~CAqMF~~"}
1	+ {"version":3,"file":"BaseDataService.d.ts","sourceRoot":"","sources":["../src/BaseDataService.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,gBAAgB,EAChB,eAAe,EACf,gBAAgB,EAChB,eAAe,EAChB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EACV,2BAA2B,EAC3B,8BAA8B,EAC9B,2BAA2B,EAC5B,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAE/C,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EACL,YAAY,EAEZ,eAAe,EACf,iBAAiB,EACjB,YAAY,EACZ,8BAA8B,EAC9B,aAAa,EACb,iBAAiB,EACjB,sBAAsB,EACtB,eAAe,EACf,SAAS,EAET,iBAAiB,EACjB,YAAY,EACZ,aAAa,EACb,YAAY,EAIZ,gBAAgB,EACjB,MAAM,sBAAsB,CAAC;AAK9B,OAAO,EAEL,0BAA0B,EAE3B,MAAM,0BAA0B,CAAC;AAMlC;;;GAGG;AACH,KAAK,GAAG,GAAG,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;AAM9D,MAAM,MAAM,QAAQ,GAAG,GAAG,CAAC;AAM3B,MAAM,MAAM,WAAW,GAAG,GAAG,CAAC;AAE9B;;;;;GAKG;AACH,MAAM,MAAM,aAAa,CAAC,SAAS,SAAS,MAAM,IAAI,SAAS,CAC7D,SAAS,EACT,gBAAgB,EAChB,eAAe,EAIf,GAAG,CACJ,CAAC;AAEF,MAAM,MAAM,sCAAsC,GAAG;IACnD,UAAU,EAAE,OAAO,GAAG,UAAU,CAAC;CAClC,GAAG,CACA;IAAE,IAAI,EAAE,OAAO,GAAG,SAAS,CAAC;IAAC,KAAK,EAAE,eAAe,CAAA;CAAE,GACrD;IACE,IAAI,EAAE,SAAS,CAAC;IAChB,KAAK,EAAE,IAAI,CAAC;CACb,CACJ,CAAC;AAEF,MAAM,MAAM,8BAA8B,GACxC,sCAAsC,GAAG;IACvC,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAIJ,MAAM,MAAM,kCAAkC,CAAC,WAAW,SAAS,MAAM,IAAI;IAC3E,IAAI,EAAE,GAAG,WAAW,oBAAoB,CAAC;IACzC,OAAO,EAAE,eAAe,CACtB,WAAW,EACX,aAAa,CAAC,WAAW,CAAC,CAC3B,CAAC,mBAAmB,CAAC,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,kBAAkB,CAAC,WAAW,SAAS,MAAM,IACvD,kCAAkC,CAAC,WAAW,CAAC,CAAC;AAElD,KAAK,yBAAyB,GAC1B,2BAA2B,GAC3B,2BAA2B,GAC3B,8BAA8B,CAAC;AAEnC,MAAM,MAAM,4BAA4B,CAAC,WAAW,SAAS,MAAM,IAAI;IACrE,IAAI,EAAE,GAAG,WAAW,eAAe,CAAC;IACpC,OAAO,EAAE,CAAC,8BAA8B,CAAC,CAAC;CAC3C,CAAC;AAEF,MAAM,MAAM,oCAAoC,CAAC,WAAW,SAAS,MAAM,IAAI;IAC7E,IAAI,EAAE,GAAG,WAAW,iBAAiB,MAAM,EAAE,CAAC;IAC9C,OAAO,EAAE,CAAC,sCAAsC,CAAC,CAAC;CACnD,CAAC;AAEF,MAAM,MAAM,iBAAiB,CAAC,WAAW,SAAS,MAAM,IACpD,4BAA4B,CAAC,WAAW,CAAC,GACzC,oCAAoC,CAAC,WAAW,CAAC,CAAC;AAetD,eAAO,MAAM,mBAAmB,UAAU,CAAC;AAE3C;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAOF,qBAAa,eAAe,CAC1B,WAAW,SAAS,MAAM,EAC1B,gBAAgB,SAAS,aAAa,CAAC,WAAW,CAAC;;IAEnD,SAAgB,IAAI,EAAE,WAAW,CAAC;IAalC,SAAS,CAAC,SAAS,EAAE,gBAAgB,CAAC;IActC,YAAY,EACV,IAAI,EACJ,SAAS,EACT,iBAAsB,EACtB,aAAa,EACb,iBAAiB,GAClB,EAAE;QACD,IAAI,EAAE,WAAW,CAAC;QAClB,SAAS,EAAE,kBAAkB,CAAC,WAAW,CAAC,CAAC,MAAM,CAAC,SAC9C,gBAAgB,CAAC,gBAAgB,CAAC,CAAC,MAAM,CAAC,GAC1C,yBAAyB,CAAC,MAAM,CAAC,GACjC,iBAAiB,CAAC,WAAW,CAAC,CAAC,MAAM,CAAC,SAAS,eAAe,CAAC,gBAAgB,CAAC,CAAC,MAAM,CAAC,GACtF,gBAAgB,GAChB,KAAK,GACP,KAAK,CAAC;QACV,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;QACtC,aAAa,CAAC,EAAE,0BAA0B,CAAC;QAC3C,iBAAiB,CAAC,EAAE,wBAAwB,CAAC;KAC9C,EA6FA;IAED;;;;;;;;OAQG;IACH,UAAgB,UAAU,CACxB,YAAY,SAAS,IAAI,EACzB,MAAM,GAAG,YAAY,EACrB,WAAW,SAAS,MAAM,CAAC,YAAY,CAAC,GAAG,SAAS,GAAG,SAAS,EAChE,KAAK,GAAG,WAAW,SAAS,MAAM,CAAC,MAAM,UAAU,CAAC,GAChD,UAAU,GACV,YAAY,EAChB,SAAS,SAAS,QAAQ,GAAG,QAAQ,EACrC,EACA,OAAO,EACP,cAAc,EACd,GAAG,OAAO,EACX,EAAE,YAAY,CACb,SAAS,CACP,iBAAiB,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,CAAC,EACzD,OAAO,GAAG,YAAY,GAAG,SAAS,CACnC,EACD,UAAU,CACX,GAAG;QACF,OAAO,EAAE,aAAa,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;QAChD,cAAc,CAAC,EAAE,WAAW,CAAC;KAC9B,GAAG,OAAO,CAAC,KAAK,CAAC,CAQjB;IAED;;;;;;;;OAQG;IACH,UAAgB,kBAAkB,CAChC,YAAY,SAAS,IAAI,EACzB,MAAM,GAAG,YAAY,EACrB,WAAW,SAAS,MAAM,CAAC,YAAY,CAAC,GAAG,SAAS,GAAG,SAAS,EAChE,KAAK,SAAS,YAAY,GAAG,WAAW,SAAS,MAAM,CAAC,MAAM,UAAU,CAAC,GACrE,UAAU,GACV,YAAY,EAChB,SAAS,SAAS,QAAQ,GAAG,QAAQ,EACrC,UAAU,SAAS,IAAI,GAAG,IAAI,EAE9B,EACE,cAAc,EACd,GAAG,OAAO,EACX,EAAE,YAAY,CACb,SAAS,CACP,iBAAiB,CACf,YAAY,EACZ,MAAM,EACN,YAAY,CAAC,KAAK,EAAE,UAAU,CAAC,EAC/B,SAAS,EACT,UAAU,CACX,EACD,OAAO,GAAG,YAAY,GAAG,SAAS,GAAG,kBAAkB,CACxD,EACD,UAAU,CACX,GACC,8BAA8B,CAAC,YAAY,EAAE,UAAU,CAAC,GAAG;QACzD,OAAO,EAAE,aAAa,CAAC,YAAY,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC;QAC5D,cAAc,CAAC,EAAE,WAAW,CAAC;KAC9B,EACH,SAAS,CAAC,EAAE,UAAU,GACrB,OAAO,CAAC,KAAK,CAAC,CAqDhB;IAED;;;;;;;;;;;;;;OAcG;IACH,UAAgB,eAAe,CAC7B,eAAe,SAAS,IAAI,EAC5B,WAAW,SAAS,MAAM,CAAC,eAAe,CAAC,GAAG,SAAS,GAAG,SAAS,EACnE,KAAK,GAAG,WAAW,SAAS,MAAM,CAAC,MAAM,UAAU,CAAC,GAChD,UAAU,GACV,eAAe,EACnB,MAAM,GAAG,YAAY,EACrB,eAAe,GAAG,OAAO,EACzB,YAAY,SAAS,WAAW,GAAG,WAAW,EAC9C,EACA,UAAU,EACV,cAAc,EACd,QAAmB,EACnB,GAAG,OAAO,EACX,EAAE,SAAS,CACV,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,eAAe,CAAC,EACrE,OAAO,GAAG,YAAY,GAAG,aAAa,GAAG,YAAY,CACtD,GAAG;QACF,WAAW,EAAE,YAAY,CAAC;QAC1B,UAAU,EAAE,gBAAgB,CAAC,eAAe,EAAE,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;QACpE,cAAc,CAAC,EAAE,WAAW,CAAC;QAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,GAAG,OAAO,CAAC,KAAK,CAAC,CAmCjB;IAED;;;;;;OAMG;IACG,iBAAiB,CACrB,OAAO,CAAC,EAAE,sBAAsB,CAAC,QAAQ,CAAC,EAC1C,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,IAAI,CAAC,CAEf;IAED;;;;;;;;;;OAUG;IACH,UAAgB,aAAa,CAC3B,OAAO,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,EAChC,aAAa,CAAC,EAAE,aAAa,GAC5B,OAAO,CAAC,IAAI,CAAC,CAEf;IAED;;OAEG;IACH,IAAI,IAAI,IAAI,CAKX;IAED;;;OAGG;IACH,OAAO,IAAI,IAAI,CAcd;CAgHF"}

package/dist/BaseDataService.js CHANGED Viewed

@@ -1,4 +1,4 @@
-import { Duration, getErrorMessage, inMilliseconds } from '@metamask/utils';
+import { Duration, inMilliseconds } from '@metamask/utils';
 import { QueryClient, dehydrate, hydrate, hashKey, } from '@tanstack/query-core';
 import deepEqual from 'fast-deep-equal';
 import { debounce } from 'lodash-es';
@@ -7,34 +7,6 @@ import { createServicePolicy, } from './createServicePolicy.js';
 import { createModuleLogger, projectLogger } from './loggers.js';
 import { processMutationResponse, processQueryResponse } from './utils.js';
 const log = createModuleLogger(projectLogger, 'BaseDataService');
-/**
- * Convert a thrown value into a JSON safe error.
- *
- * @param error - The raw error stored on a query, if any.
- * @returns The serialized error, or null if there is no error.
- */
-function serializeQueryError(error) {
-    if (error === null) {
-        return null;
-    }
-    return {
-        name: error instanceof Error ? error.name : 'Error',
-        message: getErrorMessage(error),
-    };
-}
-/**
- * Serialize the errors held by a query state so it survives JSON round trips.
- *
- * @param state - The raw query state.
- * @returns The query state with `error` and `fetchFailureReason` serialized.
- */
-function serializeQueryState(state) {
-    return {
-        ...state,
-        error: serializeQueryError(state.error),
-        fetchFailureReason: serializeQueryError(state.fetchFailureReason),
-    };
-}
 /*
  * Defaults to apply to all data service queries if no default option specified.
  */
@@ -124,24 +96,16 @@ export class BaseDataService {
      * Additionally `retry` and `retryDelay` are not available, retries can be customized using the `servicePolicyOptions`.
      * @param options.queryFn - The query function.
      * @param options.responseStruct - An optional struct for validating the response of the query function.
-     * @param options.onQueryStateChange - An optional callback that receives the
-     * state of the query (with serialized errors) as it changes. It is called
-     * once with the current state if the query is already cached, then with
-     * every update until the fetch has settled and the query is idle.
      * @returns The query results.
      */
-    async fetchQuery({ queryFn, responseStruct, onQueryStateChange, ...options }) {
-        const runFetch = async () => this.#queryClient.fetchQuery({
+    async fetchQuery({ queryFn, responseStruct, ...options }) {
+        return this.#queryClient.fetchQuery({
             ...options,
             queryFn: async (context) => {
                 const response = await this.#policy.execute(() => queryFn(context));
                 return processQueryResponse(options.queryKey, response, responseStruct);
             },
         });
-        if (!onQueryStateChange) {
-            return runFetch();
-        }
-        return this.#withQueryStateChange(options.queryKey, onQueryStateChange, runFetch);
     }
     /**
      * Fetch a paginated query.
@@ -269,69 +233,6 @@ export class BaseDataService {
         this.messenger.clearSubscriptions();
         this.messenger.clearActions();
     }
-    /**
-     * Run a fetch while reporting the state of its query to a handler.
-     *
-     * The handler receives the current state up front if the query is cached,
-     * then every `updated` cache event for the query. It is
-     * unsubscribed once the fetch has settled and the last reported state is
-     * idle, so a background fetch that outlives this call is still reported
-     * until it finishes. Errors thrown by the handler are logged and ignored.
-     *
-     * @param queryKey - The key of the query being fetched.
-     * @param handler - The callback receiving query states.
-     * @param runFetch - The function performing the fetch.
-     * @returns The result of the fetch.
-     */
-    async #withQueryStateChange(queryKey, handler, runFetch) {
-        const notify = (state) => {
-            try {
-                handler(state);
-            }
-            catch (error) {
-                log('onQueryStateChange handler threw', error);
-            }
-        };
-        const eventType = `${this.name}:cacheUpdated:${hashKey(queryKey)}`;
-        let settled = false;
-        let idle = true;
-        const unsubscribe = (handlerToRemove) => {
-            try {
-                this.#messenger.unsubscribe(eventType, handlerToRemove);
-            }
-            catch {
-                // The subscription was already cleared, e.g. by `destroy`.
-            }
-        };
-        const listener = (payload) => {
-            // `added` only carries the blank state built right before the fetch
-            // starts (pending and idle), and `removed` carries no state at all.
-            if (payload.type !== 'updated') {
-                return;
-            }
-            const { state } = payload.state.queries[0];
-            idle = state.fetchStatus === 'idle';
-            notify(state);
-            if (settled && idle) {
-                unsubscribe(listener);
-            }
-        };
-        const current = this.#queryClient.getQueryState(queryKey);
-        if (current) {
-            idle = current.fetchStatus === 'idle';
-            notify(serializeQueryState(current));
-        }
-        this.#messenger.subscribe(eventType, listener);
-        try {
-            return await runFetch();
-        }
-        finally {
-            settled = true;
-            if (idle) {
-                unsubscribe(listener);
-            }
-        }
-    }
     /**
      * Publish `cacheUpdated` events when the query or mutation cache is updated.
      *
@@ -340,7 +241,7 @@ export class BaseDataService {
      * @param hash - The hash of the query or mutation.
      */
     #publishCacheUpdate(objectType, eventType, hash) {
-        const dehydrated = eventType === 'added' || eventType === 'updated'
+        const state = eventType === 'added' || eventType === 'updated'
             ? dehydrate(this.#queryClient, {
                 shouldDehydrateQuery: (query) => objectType === 'query' && query.queryHash === hash,
                 shouldDehydrateMutation: (mutation) => objectType === 'mutation' &&
@@ -348,14 +249,6 @@ export class BaseDataService {
                     hashKey(mutation.options.mutationKey) === hash,
             })
             : null;
-        const state = dehydrated && {
-            ...dehydrated,
-            // The in flight `promise` is not JSON safe, so it is left out.
-            queries: dehydrated.queries.map(({ promise: _promise, ...query }) => ({
-                ...query,
-                state: serializeQueryState(query.state),
-            })),
-        };
         this.#messenger.publish(`${this.name}:cacheUpdated`, {
             type: eventType,
             objectType,

package/dist/BaseDataService.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"BaseDataService.js","sourceRoot":"","sources":["../src/BaseDataService.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,QAAQ,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAE5E,OAAO,EAYL,WAAW,EAKX,SAAS,EACT,OAAO,EACP,OAAO,GAER,MAAM,sBAAsB,CAAC;AAC9B,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,EAAE,QAAQ,EAAiB,MAAM,WAAW,CAAC;AACpD,OAAO,EAAE,EAAE,IAAI,MAAM,EAAE,MAAM,MAAM,CAAC;AAEpC,OAAO,EACL,mBAAmB,GAGpB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AACjE,OAAO,EAAE,uBAAuB,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAE3E,MAAM,GAAG,GAAG,kBAAkB,CAAC,aAAa,EAAE,iBAAiB,CAAC,CAAC;AAqEjE;;;;;GAKG;AACH,SAAS,mBAAmB,CAAC,KAAc;IACzC,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QACnB,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO;QACL,IAAI,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO;QACnD,OAAO,EAAE,eAAe,CAAC,KAAK,CAAC;KAChC,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAS,mBAAmB,CAC1B,KAAkD;IAElD,OAAO;QACL,GAAG,KAAK;QACR,KAAK,EAAE,mBAAmB,CAAC,KAAK,CAAC,KAAK,CAAC;QACvC,kBAAkB,EAAE,mBAAmB,CAAC,KAAK,CAAC,kBAAkB,CAAC;KAClE,CAAC;AACJ,CAAC;AAiDD;;GAEG;AACH,MAAM,qBAAqB,GAAmB;IAC5C,OAAO,EAAE;QACP,KAAK,EAAE,KAAK;QACZ,SAAS,EAAE,cAAc,CAAC,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC;KAC9C;IACD,SAAS,EAAE;QACT,KAAK,EAAE,KAAK;KACb;CACF,CAAC;AAEF,MAAM,CAAC,MAAM,mBAAmB,GAAG,OAAO,CAAC;AA2B3C,MAAM,OAAO,eAAe;IAIV,IAAI,CAAc;IAEzB,UAAU,CAIjB;IAEO,kBAAkB,CAGzB;IAEQ,SAAS,CAAmB;IAE7B,OAAO,CAAgB;IAEvB,YAAY,CAAc;IAE1B,sBAAsB,CAAa;IAEnC,yBAAyB,CAAa;IAEtC,iBAAiB,CAA6B;IAE9C,kBAAkB,CAA4B;IAEvD,YAAY,EACV,IAAI,EACJ,SAAS,EACT,iBAAiB,GAAG,EAAE,EACtB,aAAa,EACb,iBAAiB,GAalB;QACC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QAEjB,2EAA2E;QAC3E,kFAAkF;QAClF,yDAAyD;QACzD,6FAA6F;QAC7F,IAAI,CAAC,UAAU,GAAG,SAIjB,CAAC;QACF,IAAI,CAAC,kBAAkB,GAAG,SAGzB,CAAC;QACF,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAE3B,IAAI,CAAC,YAAY,GAAG,IAAI,WAAW,CAAC;YAClC,GAAG,iBAAiB;YACpB,cAAc,EAAE;gBACd,OAAO,EAAE;oBACP,GAAG,qBAAqB,CAAC,OAAO;oBAChC,GAAG,iBAAiB,CAAC,cAAc,EAAE,OAAO;iBAC7C;gBACD,SAAS,EAAE;oBACT,GAAG,qBAAqB,CAAC,SAAS;oBAClC,GAAG,iBAAiB,CAAC,cAAc,EAAE,SAAS;iBAC/C;aACF;SACF,CAAC,CAAC;QAEH,IAAI,CAAC,kBAAkB,GAAG,iBAAiB,CAAC;QAE5C,IAAI,CAAC,OAAO,GAAG,mBAAmB,CAAC,aAAa,CAAC,CAAC;QAElD,IAAI,CAAC,iBAAiB;YACpB,IAAI,CAAC,kBAAkB;gBACvB,QAAQ,CACN,GAAG,EAAE;oBACH,IAAI,CAAC,aAAa,EAAE,CAAC,KAAK;oBACxB,0BAA0B;oBAC1B,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,gBAAgB,EAAE,CAAC,KAAK,CAAC,CACrD,CAAC;gBACJ,CAAC,EACD,IAAI,CAAC,kBAAkB,CAAC,UAAU;oBAChC,cAAc,CAAC,EAAE,EAAE,QAAQ,CAAC,MAAM,CAAC,EACrC;oBACE,OAAO,EACL,IAAI,CAAC,kBAAkB,CAAC,aAAa;wBACrC,cAAc,CAAC,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC;iBACrC,CACF,CAAC;QAEJ,IAAI,CAAC,sBAAsB,GAAG,IAAI,CAAC,YAAY;aAC5C,aAAa,EAAE;aACf,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;YACnB,GAAG,CAAC,2BAA2B,EAAE,KAAK,CAAC,CAAC;YACxC,IAAI,CAAC,OAAO,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;gBACzD,IAAI,CAAC,mBAAmB,CACtB,OAAO,EACP,KAAK,CAAC,IAAwB,EAC9B,KAAK,CAAC,KAAK,CAAC,SAAS,CACtB,CAAC;gBAEF,IAAI,CAAC,iBAAiB,EAAE,EAAE,CAAC;YAC7B,CAAC;QACH,CAAC,CAAC,CAAC;QAEL,GAAG,CAAC,+BAA+B,CAAC,CAAC;QACrC,IAAI,CAAC,yBAAyB,GAAG,IAAI,CAAC,YAAY;aAC/C,gBAAgB,EAAE;aAClB,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;YACnB,GAAG,CAAC,8BAA8B,EAAE,KAAK,CAAC,CAAC;YAC3C,IACE,CAAC,OAAO,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC;gBACpD,KAAK,CAAC,QAAQ,EAAE,OAAO,CAAC,WAAW,KAAK,SAAS,EACjD,CAAC;gBACD,MAAM,YAAY,GAAG,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;gBACjE,IAAI,CAAC,mBAAmB,CACtB,UAAU,EACV,KAAK,CAAC,IAAwB,EAC9B,YAAY,CACb,CAAC;gBAEF,IAAI,CAAC,iBAAiB,EAAE,EAAE,CAAC;YAC7B,CAAC;QACH,CAAC,CAAC,CAAC;QAEL,IAAI,CAAC,UAAU,CAAC,qBAAqB,CACnC,GAAG,IAAI,CAAC,IAAI,oBAAoB,EAChC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAClC,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;OAYG;IACO,KAAK,CAAC,UAAU,CAQxB,EACA,OAAO,EACP,cAAc,EACd,kBAAkB,EAClB,GAAG,OAAO,EAWX;QACC,MAAM,QAAQ,GAAG,KAAK,IAAoB,EAAE,CAC1C,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC;YAC3B,GAAG,OAAO;YACV,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;gBACzB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;gBACpE,OAAO,oBAAoB,CACzB,OAAO,CAAC,QAAQ,EAChB,QAAQ,EACR,cAAc,CACf,CAAC;YACJ,CAAC;SACF,CAAC,CAAC;QAEL,IAAI,CAAC,kBAAkB,EAAE,CAAC;YACxB,OAAO,QAAQ,EAAE,CAAC;QACpB,CAAC;QAED,OAAO,IAAI,CAAC,qBAAqB,CAC/B,OAAO,CAAC,QAAQ,EAChB,kBAAkB,EAClB,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACO,KAAK,CAAC,kBAAkB,CAUhC,EACE,cAAc,EACd,GAAG,OAAO,EAiBT,EACH,SAAsB;QAEtB,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE,CAAC;QAEhD,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAItB;YACA,QAAQ,EAAE,OAAO,CAAC,QAAQ;SAC3B,CAAC,CAAC;QAEH,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACrC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,kBAAkB,CAAC;gBACxD,GAAG,OAAO;gBACV,gBAAgB,EAAE,SAAS,IAAI,OAAO,CAAC,gBAAgB;gBACvD,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;oBACzB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CACrD,OAAO,CAAC,OAAO,CAAC;wBACd,GAAG,OAAO;wBACV,SAAS,EAAE,OAAO,CAAC,IAAI,EAAE,SAAS,IAAI,OAAO,CAAC,SAAS;qBACxD,CAAC,CACH,CAAC;oBACF,OAAO,oBAAoB,CACzB,OAAO,CAAC,QAAQ,EAChB,QAAQ,EACR,cAAc,CACf,CAAC;gBACJ,CAAC;aACF,CAAC,CAAC;YAEH,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACzB,CAAC;QAED,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC;QAC/C,MAAM,IAAI,GAAG,OAAO,CAAC,gBAAgB,CACnC,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,EACvB,KAAK,EACL,UAAU,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,EACjC,UAAU,CACX,CAAC;QAEF,MAAM,SAAS,GAAG,SAAS,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC;QAEtE,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,KAAK,CAC9B,EAAE,GAAG,KAAK,CAAC,OAAO,EAAE,IAAI,EAAE,EAAE,SAAS,EAAE,EAAE,EACzC,EAAE,IAAI,EAAE,EAAE,SAAS,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,CACvC,CAAC;QAEF,MAAM,SAAS,GAAG,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CACtD,SAAS,CAAC,KAAK,EAAE,SAAS,CAAC,CAC5B,CAAC;QAEF,OAAO,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACO,KAAK,CAAC,eAAe,CAS7B,EACA,UAAU,EACV,cAAc,EACd,QAAQ,GAAG,MAAM,EAAE,EACnB,GAAG,OAAO,EASX;QACC,MAAM,aAAa,GAAG,IAAI,CAAC,YAAY,CAAC,gBAAgB,EAAE,CAAC;QAC3D,MAAM,QAAQ,GAAG,aAAa,CAAC,KAAK,CAKlC,IAAI,CAAC,YAAY,EAAE;YACnB,GAAG,OAAO;YACV,IAAI,EAAE;gBACJ,GAAG,OAAO,CAAC,IAAI;gBACf,QAAQ;aACT;YACD,UAAU,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,EAAE;gBAC5B,wEAAwE;gBACxE,qEAAqE;gBACrE,gEAAgE;gBAChE,4CAA4C;gBAC5C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,oBAAoB,CAAC,OAAO,CAAC,GAAG,EAAE,CACpE,UAAU,CAAC,GAAG,IAAI,CAAC,CACpB,CAAC;gBACF,qEAAqE;gBACrE,wEAAwE;gBACxE,yBAAyB;gBACzB,OAAO,uBAAuB,CAC5B,OAAO,CAAC,WAAW,EACnB,QAAQ,EACR,cAAc,CACN,CAAC;YACb,CAAC;SACF,CAAC,CAAC;QACH,qEAAqE;QACrE,yEAAyE;QACzE,4DAA4D;QAC5D,OAAO,MAAM,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACpC,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAA0C,EAC1C,OAA2B;QAE3B,OAAO,IAAI,CAAC,YAAY,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;;;OAUG;IACO,KAAK,CAAC,aAAa,CAC3B,OAAgC,EAChC,aAA6B;QAE7B,MAAM,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;IAChE,CAAC;IAED;;OAEG;IACH,IAAI;QACF,IAAI,CAAC,UAAU,EAAE,CAAC,KAAK;QACrB,0BAA0B;QAC1B,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,gBAAgB,EAAE,CAAC,KAAK,CAAC,CACrD,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,OAAO;QACL,IAAI,CAAC,iBAAiB,EAAE,MAAM,EAAE,CAAC;QACjC,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAC9B,IAAI,CAAC,yBAAyB,EAAE,CAAC;QACjC,wEAAwE;QACxE,wEAAwE;QACxE,4EAA4E;QAC5E,iDAAiD;QACjD,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,YAAY,CAAC,gBAAgB,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC;YACrE,QAAQ,CAAC,OAAO,EAAE,CAAC;QACrB,CAAC;QACD,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC;QAC1B,IAAI,CAAC,SAAS,CAAC,kBAAkB,EAAE,CAAC;QACpC,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,CAAC;IAChC,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,qBAAqB,CACzB,QAAkB,EAClB,OAAgC,EAChC,QAA+B;QAE/B,MAAM,MAAM,GAAG,CAAC,KAA4B,EAAQ,EAAE;YACpD,IAAI,CAAC;gBACH,OAAO,CAAC,KAAK,CAAC,CAAC;YACjB,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,GAAG,CAAC,kCAAkC,EAAE,KAAK,CAAC,CAAC;YACjD,CAAC;QACH,CAAC,CAAC;QAEF,MAAM,SAAS,GAAG,GAAG,IAAI,CAAC,IAAI,iBAAiB,OAAO,CAAC,QAAQ,CAAC,EAAW,CAAC;QAC5E,IAAI,OAAO,GAAG,KAAK,CAAC;QACpB,IAAI,IAAI,GAAG,IAAI,CAAC;QAEhB,MAAM,WAAW,GAAG,CAClB,eAES,EACH,EAAE;YACR,IAAI,CAAC;gBACH,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;YAC1D,CAAC;YAAC,MAAM,CAAC;gBACP,2DAA2D;YAC7D,CAAC;QACH,CAAC,CAAC;QAEF,MAAM,QAAQ,GAAG,CACf,OAA+C,EACzC,EAAE;YACR,oEAAoE;YACpE,oEAAoE;YACpE,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;gBAC/B,OAAO;YACT,CAAC;YACD,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YAC3C,IAAI,GAAG,KAAK,CAAC,WAAW,KAAK,MAAM,CAAC;YACpC,MAAM,CAAC,KAAK,CAAC,CAAC;YACd,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;gBACpB,WAAW,CAAC,QAAQ,CAAC,CAAC;YACxB,CAAC;QACH,CAAC,CAAC;QAEF,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QAC1D,IAAI,OAAO,EAAE,CAAC;YACZ,IAAI,GAAG,OAAO,CAAC,WAAW,KAAK,MAAM,CAAC;YACtC,MAAM,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC,CAAC;QACvC,CAAC;QAED,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAE/C,IAAI,CAAC;YACH,OAAO,MAAM,QAAQ,EAAE,CAAC;QAC1B,CAAC;gBAAS,CAAC;YACT,OAAO,GAAG,IAAI,CAAC;YACf,IAAI,IAAI,EAAE,CAAC;gBACT,WAAW,CAAC,QAAQ,CAAC,CAAC;YACxB,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,mBAAmB,CACjB,UAAgC,EAChC,SAA2B,EAC3B,IAAY;QAEZ,MAAM,UAAU,GACd,SAAS,KAAK,OAAO,IAAI,SAAS,KAAK,SAAS;YAC9C,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,EAAE;gBAC3B,oBAAoB,EAAE,CAAC,KAAK,EAAE,EAAE,CAC9B,UAAU,KAAK,OAAO,IAAI,KAAK,CAAC,SAAS,KAAK,IAAI;gBACpD,uBAAuB,EAAE,CAAC,QAAQ,EAAE,EAAE,CACpC,UAAU,KAAK,UAAU;oBACzB,QAAQ,CAAC,OAAO,CAAC,WAAW,KAAK,SAAS;oBAC1C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,KAAK,IAAI;aACjD,CAAC;YACJ,CAAC,CAAC,IAAI,CAAC;QACX,MAAM,KAAK,GAAG,UAAU,IAAI;YAC1B,GAAG,UAAU;YACb,+DAA+D;YAC/D,OAAO,EAAE,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC;gBACpE,GAAG,KAAK;gBACR,KAAK,EAAE,mBAAmB,CAAC,KAAK,CAAC,KAAK,CAAC;aACxC,CAAC,CAAC;SACJ,CAAC;QAEF,IAAI,CAAC,UAAU,CAAC,OAAO,CACrB,GAAG,IAAI,CAAC,IAAI,eAAwB,EACpC;YACE,IAAI,EAAE,SAAS;YACf,UAAU;YACV,IAAI;YACJ,KAAK;SAC4B,CACpC,CAAC;QACF,IAAI,CAAC,UAAU,CAAC,OAAO,CACrB,GAAG,IAAI,CAAC,IAAI,iBAAiB,IAAI,EAAW,EAC5C;YACE,IAAI,EAAE,SAAS;YACf,UAAU;YACV,KAAK;SACoC,CAC5C,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,aAAa;QACjB,MAAM,KAAK,GAAG,SAAS,CAAC,IAAI,CAAC,YAAY,EAAE;YACzC,yDAAyD;YACzD,oBAAoB,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,KAAK,SAAS;SAClE,CAAC,CAAC;QAEH,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,IAAI,KAAK,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC/D,MAAM,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAChC,2BAA2B,EAC3B,IAAI,CAAC,IAAI,EACT,mBAAmB,CACpB,CAAC;YACF,OAAO;QACT,CAAC;QAED,MAAM,KAAK,GAAmB;YAC5B,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;YACrB,KAAK;SACN,CAAC;QAEF,MAAM,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAChC,wBAAwB,EACxB,IAAI,CAAC,IAAI,EACT,mBAAmB,EACnB,KAAwB,CACzB,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,UAAU;QACd,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC7B,OAAO;QACT,CAAC;QAED,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,IAAI,CACjE,wBAAwB,EACxB,IAAI,CAAC,IAAI,EACT,mBAAmB,CACpB,CAAC;QAEF,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,OAAO;QACT,CAAC;QAED,MAAM,KAAK,GAAG,YAAyC,CAAC;QAExD,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC,SAAS,IAAI,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE,CAAC;YACnE,MAAM,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAChC,2BAA2B,EAC3B,IAAI,CAAC,IAAI,EACT,mBAAmB,CACpB,CAAC;YACF,OAAO;QACT,CAAC;QAED,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IAC1C,CAAC;CACF","sourcesContent":["import {\n Messenger,\n ActionConstraint,\n EventConstraint,\n MessengerActions,\n MessengerEvents,\n} from '@metamask/messenger';\nimport type {\n StorageServiceGetItemAction,\n StorageServiceRemoveItemAction,\n StorageServiceSetItemAction,\n} from '@metamask/storage-service';\nimport { Struct } from '@metamask/superstruct';\nimport { Duration, getErrorMessage, inMilliseconds } from '@metamask/utils';\nimport type { Json } from '@metamask/utils';\nimport {\n DefaultError,\n DefaultOptions,\n DehydratedState,\n FetchQueryOptions,\n InfiniteData,\n InfiniteQueryPageParamsOptions,\n CancelOptions,\n InvalidateOptions,\n InvalidateQueryFilters,\n MutationOptions,\n OmitKeyof,\n QueryClient,\n QueryClientConfig,\n QueryFilters,\n QueryFunction,\n WithRequired,\n dehydrate,\n hydrate,\n hashKey,\n MutationFunction,\n} from '@tanstack/query-core';\nimport deepEqual from 'fast-deep-equal';\nimport { debounce, DebouncedFunc } from 'lodash-es';\nimport { v4 as uuidV4 } from 'uuid';\n\nimport {\n createServicePolicy,\n CreateServicePolicyOptions,\n ServicePolicy,\n} from './createServicePolicy.js';\nimport { createModuleLogger, projectLogger } from './loggers.js';\nimport { processMutationResponse, processQueryResponse } from './utils.js';\n\nconst log = createModuleLogger(projectLogger, 'BaseDataService');\n\n/*\n Data service mutations and queries use the following format:\n * `['${ServiceName}:${ActionName}', ...params]`\n /\ntype Key = [string, ...Json[]] \| readonly [string, ...Json[]];\n\n/\n * Data service queries use the following format:\n * `['${ServiceName}:${ActionName}', ...params]`\n /\nexport type QueryKey = Key;\n\n/\n * Data service mutations use the following format:\n * `['${ServiceName}:${ActionName}', ...params]`\n /\nexport type MutationKey = Key;\n\n/\n The supertype of all messengers, scoped to a namespace.\n \n @template Namespace - The namespace for the messenger's own actions and\n * events.\n /\nexport type BaseMessenger<Namespace extends string> = Messenger<\n Namespace,\n ActionConstraint,\n EventConstraint,\n // Use `any` to allow any parent to be set. `any` is harmless in a type constraint anyway,\n // it's the one totally safe place to use it.\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n any\n>;\n\n/\n A JSON safe representation of an error thrown by a query.\n /\nexport type SerializedQueryError = { name: string; message: string };\n\n/\n The dehydrated state published in `:cacheUpdated` payloads, where query\n * errors are serialized and the in flight `promise` is omitted so the payload\n * survives JSON round trips.\n /\nexport type CacheUpdatedState = Omit<DehydratedState, 'queries'> & {\n queries: (Omit<DehydratedState['queries'][number], 'state' \| 'promise'> & {\n state: DataServiceQueryState;\n })[];\n};\n\n/\n The state of a single query, as reported to `onQueryStateChange` handlers.\n * Errors are serialized so the state is JSON safe.\n /\nexport type DataServiceQueryState = Omit<\n DehydratedState['queries'][number]['state'],\n 'error' \| 'fetchFailureReason'\n> & {\n error: SerializedQueryError \| null;\n fetchFailureReason: SerializedQueryError \| null;\n};\n\n/\n A callback that receives the state of a query as it changes.\n /\nexport type QueryStateChangeHandler = (state: DataServiceQueryState) => void;\n\n/\n Convert a thrown value into a JSON safe error.\n \n @param error - The raw error stored on a query, if any.\n * @returns The serialized error, or null if there is no error.\n /\nfunction serializeQueryError(error: unknown): SerializedQueryError \| null {\n if (error === null) {\n return null;\n }\n return {\n name: error instanceof Error ? error.name : 'Error',\n message: getErrorMessage(error),\n };\n}\n\n/\n Serialize the errors held by a query state so it survives JSON round trips.\n \n @param state - The raw query state.\n * @returns The query state with `error` and `fetchFailureReason` serialized.\n /\nfunction serializeQueryState(\n state: DehydratedState['queries'][number]['state'],\n): DataServiceQueryState {\n return {\n ...state,\n error: serializeQueryError(state.error),\n fetchFailureReason: serializeQueryError(state.fetchFailureReason),\n };\n}\n\nexport type DataServiceGranularCacheUpdatedPayload = {\n objectType: 'query' \| 'mutation';\n} & (\n \| { type: 'added' \| 'updated'; state: CacheUpdatedState }\n \| {\n type: 'removed';\n state: null;\n }\n);\n\nexport type DataServiceCacheUpdatedPayload =\n DataServiceGranularCacheUpdatedPayload & {\n hash: string;\n };\n\ntype CacheUpdatedType = DataServiceCacheUpdatedPayload['type'];\n\nexport type DataServiceInvalidateQueriesAction<ServiceName extends string> = {\n type: `${ServiceName}:invalidateQueries`;\n handler: BaseDataService<\n ServiceName,\n BaseMessenger<ServiceName>\n >['invalidateQueries'];\n};\n\nexport type DataServiceActions<ServiceName extends string> =\n DataServiceInvalidateQueriesAction<ServiceName>;\n\ntype DataServiceAllowedActions =\n \| StorageServiceGetItemAction\n \| StorageServiceSetItemAction\n \| StorageServiceRemoveItemAction;\n\nexport type DataServiceCacheUpdatedEvent<ServiceName extends string> = {\n type: `${ServiceName}:cacheUpdated`;\n payload: [DataServiceCacheUpdatedPayload];\n};\n\nexport type DataServiceGranularCacheUpdatedEvent<ServiceName extends string> = {\n type: `${ServiceName}:cacheUpdated:${string}`;\n payload: [DataServiceGranularCacheUpdatedPayload];\n};\n\nexport type DataServiceEvents<ServiceName extends string> =\n \| DataServiceCacheUpdatedEvent<ServiceName>\n \| DataServiceGranularCacheUpdatedEvent<ServiceName>;\n\n/\n * Defaults to apply to all data service queries if no default option specified.\n /\nconst QUERY_CLIENT_DEFAULTS: DefaultOptions = {\n queries: {\n retry: false,\n staleTime: inMilliseconds(1, Duration.Minute),\n },\n mutations: {\n retry: false,\n },\n};\n\nexport const STORAGE_SERVICE_KEY = 'cache';\n\n/\n Options for persistence configuration.\n /\nexport type PersistenceConfiguration = {\n /\n The maximum age before the cache is treated as expired in milliseconds.\n * This is relevant for rehydrating the state during initialization,\n * if the cached state is too old it will be discarded.\n /\n maxAge: number;\n /\n The number of milliseconds to wait before triggering persistence following a cache update.\n /\n writeDelay?: number;\n /\n The maximum number of milliseconds to wait between persistence writes.\n /\n maxWriteDelay?: number;\n};\n\ntype PersistedCache = {\n state: DehydratedState;\n timestamp: number;\n};\n\nexport class BaseDataService<\n ServiceName extends string,\n ServiceMessenger extends BaseMessenger<ServiceName>,\n> {\n public readonly name: ServiceName;\n\n readonly #messenger: Messenger<\n ServiceName,\n DataServiceActions<ServiceName>,\n DataServiceEvents<ServiceName>\n >;\n\n readonly #externalMessenger: Messenger<\n ServiceName,\n DataServiceAllowedActions\n >;\n\n protected messenger: ServiceMessenger;\n\n readonly #policy: ServicePolicy;\n\n readonly #queryClient: QueryClient;\n\n readonly #queryCacheUnsubscribe: () => void;\n\n readonly #mutationCacheUnsubscribe: () => void;\n\n readonly #debouncedPersist?: DebouncedFunc<() => void>;\n\n readonly #persistenceConfig?: PersistenceConfiguration;\n\n constructor({\n name,\n messenger,\n queryClientConfig = {},\n policyOptions,\n persistenceConfig,\n }: {\n name: ServiceName;\n messenger: DataServiceActions<ServiceName>['type'] extends\n \| MessengerActions<ServiceMessenger>['type']\n \| DataServiceAllowedActions['type']\n ? DataServiceEvents<ServiceName>['type'] extends MessengerEvents<ServiceMessenger>['type']\n ? ServiceMessenger\n : never\n : never;\n queryClientConfig?: QueryClientConfig;\n policyOptions?: CreateServicePolicyOptions;\n persistenceConfig?: PersistenceConfiguration;\n }) {\n this.name = name;\n\n // We store two narrowly-typed messengers alongside the generic public one:\n // - #messenger handles the service's own action registration and event publishing\n // - #externalMessenger handles calls to external actions\n // Splitting them avoids TypeScript issues with mixing template-literals with regular strings\n this.#messenger = messenger as unknown as Messenger<\n ServiceName,\n DataServiceActions<ServiceName>,\n DataServiceEvents<ServiceName>\n >;\n this.#externalMessenger = messenger as unknown as Messenger<\n ServiceName,\n DataServiceAllowedActions\n >;\n this.messenger = messenger;\n\n this.#queryClient = new QueryClient({\n ...queryClientConfig,\n defaultOptions: {\n queries: {\n ...QUERY_CLIENT_DEFAULTS.queries,\n ...queryClientConfig.defaultOptions?.queries,\n },\n mutations: {\n ...QUERY_CLIENT_DEFAULTS.mutations,\n ...queryClientConfig.defaultOptions?.mutations,\n },\n },\n });\n\n this.#persistenceConfig = persistenceConfig;\n\n this.#policy = createServicePolicy(policyOptions);\n\n this.#debouncedPersist =\n this.#persistenceConfig &&\n debounce(\n () => {\n this.#persistCache().catch(\n / istanbul ignore next /\n (error) => this.#messenger.captureException?.(error),\n );\n },\n this.#persistenceConfig.writeDelay ??\n inMilliseconds(10, Duration.Second),\n {\n maxWait:\n this.#persistenceConfig.maxWriteDelay ??\n inMilliseconds(1, Duration.Minute),\n },\n );\n\n this.#queryCacheUnsubscribe = this.#queryClient\n .getQueryCache()\n .subscribe((event) => {\n log('Query cache event emitted', event);\n if (['added', 'updated', 'removed'].includes(event.type)) {\n this.#publishCacheUpdate(\n 'query',\n event.type as CacheUpdatedType,\n event.query.queryHash,\n );\n\n this.#debouncedPersist?.();\n }\n });\n\n log('Subscribing to mutation cache');\n this.#mutationCacheUnsubscribe = this.#queryClient\n .getMutationCache()\n .subscribe((event) => {\n log('Mutation cache event emitted', event);\n if (\n ['added', 'updated', 'removed'].includes(event.type) &&\n event.mutation?.options.mutationKey !== undefined\n ) {\n const mutationHash = hashKey(event.mutation.options.mutationKey);\n this.#publishCacheUpdate(\n 'mutation',\n event.type as CacheUpdatedType,\n mutationHash,\n );\n\n this.#debouncedPersist?.();\n }\n });\n\n this.#messenger.registerActionHandler(\n `${this.name}:invalidateQueries`,\n this.invalidateQueries.bind(this),\n );\n }\n\n /\n Fetch a query.\n \n @param options - The options defining the query. Keep in mind that `queryKey` and `queryFn` are required when using data services.\n * Additionally `retry` and `retryDelay` are not available, retries can be customized using the `servicePolicyOptions`.\n * @param options.queryFn - The query function.\n * @param options.responseStruct - An optional struct for validating the response of the query function.\n * @param options.onQueryStateChange - An optional callback that receives the\n * state of the query (with serialized errors) as it changes. It is called\n * once with the current state if the query is already cached, then with\n * every update until the fetch has settled and the query is idle.\n * @returns The query results.\n /\n protected async fetchQuery<\n TQueryFnData extends Json,\n TError = DefaultError,\n TDataStruct extends Struct<TQueryFnData> \| undefined = undefined,\n TData = TDataStruct extends Struct<infer StructType>\n ? StructType\n : TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n >({\n queryFn,\n responseStruct,\n onQueryStateChange,\n ...options\n }: WithRequired<\n OmitKeyof<\n FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n 'retry' \| 'retryDelay' \| 'queryFn'\n >,\n 'queryKey'\n > & {\n queryFn: QueryFunction<TQueryFnData, TQueryKey>;\n responseStruct?: TDataStruct;\n onQueryStateChange?: QueryStateChangeHandler;\n }): Promise<TData> {\n const runFetch = async (): Promise<TData> =>\n this.#queryClient.fetchQuery({\n ...options,\n queryFn: async (context) => {\n const response = await this.#policy.execute(() => queryFn(context));\n return processQueryResponse(\n options.queryKey,\n response,\n responseStruct,\n );\n },\n });\n\n if (!onQueryStateChange) {\n return runFetch();\n }\n\n return this.#withQueryStateChange(\n options.queryKey,\n onQueryStateChange,\n runFetch,\n );\n }\n\n /\n Fetch a paginated query.\n \n @param options - The options defining the query. Keep in mind that `queryKey` and `queryFn` are required when using data services.\n * Additionally `retry` and `retryDelay` are not available, retries can be customized using the `servicePolicyOptions`.\n * @param options.responseStruct - An optional struct for validating the response of the query function.\n * @param pageParam - An optional page parameter.\n * @returns The query result, exclusively the requested page is returned.\n /\n protected async fetchInfiniteQuery<\n TQueryFnData extends Json,\n TError = DefaultError,\n TDataStruct extends Struct<TQueryFnData> \| undefined = undefined,\n TData extends TQueryFnData = TDataStruct extends Struct<infer StructType>\n ? StructType\n : TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam extends Json = Json,\n >(\n {\n responseStruct,\n ...options\n }: WithRequired<\n OmitKeyof<\n FetchQueryOptions<\n TQueryFnData,\n TError,\n InfiniteData<TData, TPageParam>,\n TQueryKey,\n TPageParam\n >,\n 'retry' \| 'retryDelay' \| 'queryFn' \| 'initialPageParam'\n >,\n 'queryKey'\n > &\n InfiniteQueryPageParamsOptions<TQueryFnData, TPageParam> & {\n queryFn: QueryFunction<TQueryFnData, TQueryKey, TPageParam>;\n responseStruct?: TDataStruct;\n },\n pageParam?: TPageParam,\n ): Promise<TData> {\n const cache = this.#queryClient.getQueryCache();\n\n const query = cache.find<\n TQueryFnData,\n TError,\n InfiniteData<TData, TPageParam>\n >({\n queryKey: options.queryKey,\n });\n\n if (!query?.state.data \|\| !pageParam) {\n const result = await this.#queryClient.fetchInfiniteQuery({\n ...options,\n initialPageParam: pageParam ?? options.initialPageParam,\n queryFn: async (context) => {\n const response = await this.#policy.execute(async () =>\n options.queryFn({\n ...context,\n pageParam: context.meta?.pageParam ?? context.pageParam,\n }),\n );\n return processQueryResponse(\n options.queryKey,\n response,\n responseStruct,\n );\n },\n });\n\n return result.pages[0];\n }\n\n const { pages, pageParams } = query.state.data;\n const next = options.getNextPageParam(\n pages[pages.length - 1],\n pages,\n pageParams[pageParams.length - 1],\n pageParams,\n );\n\n const direction = deepEqual(pageParam, next) ? 'forward' : 'backward';\n\n const result = await query.fetch(\n { ...query.options, meta: { pageParam } },\n { meta: { fetchMore: { direction } } },\n );\n\n const pageIndex = result.pageParams.findIndex((param) =>\n deepEqual(param, pageParam),\n );\n\n return result.pages[pageIndex];\n }\n\n /\n Execute a mutation (e.g. a request that is expected to change server-side data).\n * Unlike `fetchQuery`, the request will not be cached or retried.\n \n @param options - The options defining the mutation. Keep in mind that `mutationKey` and `mutationFn` are required when using data services.\n * Additionally, `retry` and `retryDelay` are not available.\n * @param options.mutationFn - The mutation function.\n * @param options.responseStruct - An optional struct for validating the response of the mutation function.\n * @param options.globalId - A string which uniquely identifies this mutation\n * between the query client in this data service\n * and the one that `createUIQueryClient` in `@metamask/react-data-query` holds.\n * This global ID will be stored in the `meta` data of the created mutation\n * and included in `:cacheUpdated` payloads. Defaults to a UUID.\n * @returns The mutation results.\n /\n protected async executeMutation<\n TMutationFnData extends Json,\n TDataStruct extends Struct<TMutationFnData> \| undefined = undefined,\n TData = TDataStruct extends Struct<infer StructType>\n ? StructType\n : TMutationFnData,\n TError = DefaultError,\n TOnMutateResult = unknown,\n TMutationKey extends MutationKey = MutationKey,\n >({\n mutationFn,\n responseStruct,\n globalId = uuidV4(),\n ...options\n }: OmitKeyof<\n MutationOptions<TData, TError, Record<never, never>, TOnMutateResult>,\n 'retry' \| 'retryDelay' \| 'mutationKey' \| 'mutationFn'\n > & {\n mutationKey: TMutationKey;\n mutationFn: MutationFunction<TMutationFnData, Record<never, never>>;\n responseStruct?: TDataStruct;\n globalId?: string;\n }): Promise<TData> {\n const mutationCache = this.#queryClient.getMutationCache();\n const mutation = mutationCache.build<\n TData,\n TError,\n Record<never, never>,\n TOnMutateResult\n >(this.#queryClient, {\n ...options,\n meta: {\n ...options.meta,\n globalId,\n },\n mutationFn: async (...args) => {\n // To guard against mutations being retried, we deliberately execute the\n // mutation function through the circuit breaker policy alone, rather\n // than through `this.#policy` (which is a combination of both a\n // circuit breaker policy and retry policy).\n const response = await this.#policy.circuitBreakerPolicy.execute(() =>\n mutationFn(...args),\n );\n // Type assertion: TypeScript is not able to unify the type that this\n // function returns with `TData` at compile-time. We can still typecheck\n // the arguments, though.\n return processMutationResponse(\n options.mutationKey,\n response,\n responseStruct,\n ) as TData;\n },\n });\n // We purposely pass an empty set of variables because this method is\n // intended to be used internally by the data service, not end users, and\n // the data service has full control of `mutationFn` anyway.\n return await mutation.execute({});\n }\n\n /\n Invalidate queries serviced by this data service.\n \n @param filters - Optional filter for selecting specific queries.\n * @param options - Additional optional options for query invalidations.\n * @returns Nothing.\n /\n async invalidateQueries(\n filters?: InvalidateQueryFilters<QueryKey>,\n options?: InvalidateOptions,\n ): Promise<void> {\n return this.#queryClient.invalidateQueries(filters, options);\n }\n\n /\n Cancel in-flight queries serviced by this data service.\n \n Use this in your subclass if you need to abort a concurrent fetch before\n * starting a forced refresh (e.g. `Cache-Control: no-cache` reads), so a\n * slower non-fresh request cannot overwrite the result.\n \n @param filters - Optional filter for selecting specific queries.\n * @param cancelOptions - Optional options for cancelling the queries.\n * @returns Nothing.\n /\n protected async cancelQueries(\n filters?: QueryFilters<QueryKey>,\n cancelOptions?: CancelOptions,\n ): Promise<void> {\n await this.#queryClient.cancelQueries(filters, cancelOptions);\n }\n\n /\n Initialize the service, rehydrating the cache with persisted data if possible.\n /\n init(): void {\n this.#loadCache().catch(\n / istanbul ignore next /\n (error) => this.#messenger.captureException?.(error),\n );\n }\n\n /\n Prepares the service for garbage collection. This should be extended\n * by any subclasses to clean up any additional connections or events.\n /\n destroy(): void {\n this.#debouncedPersist?.cancel();\n this.#queryCacheUnsubscribe();\n this.#mutationCacheUnsubscribe();\n // `QueryClient.clear()` clears both caches, but `MutationCache.clear()`\n // only drops its references to mutations without clearing their pending\n // garbage-collection timers. We destroy each mutation first so those timers\n // are cleared and do not keep the process alive.\n for (const mutation of this.#queryClient.getMutationCache().getAll()) {\n mutation.destroy();\n }\n this.#queryClient.clear();\n this.messenger.clearSubscriptions();\n this.messenger.clearActions();\n }\n\n /\n Run a fetch while reporting the state of its query to a handler.\n \n The handler receives the current state up front if the query is cached,\n * then every `updated` cache event for the query. It is\n * unsubscribed once the fetch has settled and the last reported state is\n * idle, so a background fetch that outlives this call is still reported\n * until it finishes. Errors thrown by the handler are logged and ignored.\n \n @param queryKey - The key of the query being fetched.\n * @param handler - The callback receiving query states.\n * @param runFetch - The function performing the fetch.\n * @returns The result of the fetch.\n /\n async #withQueryStateChange<Result>(\n queryKey: QueryKey,\n handler: QueryStateChangeHandler,\n runFetch: () => Promise<Result>,\n ): Promise<Result> {\n const notify = (state: DataServiceQueryState): void => {\n try {\n handler(state);\n } catch (error) {\n log('onQueryStateChange handler threw', error);\n }\n };\n\n const eventType = `${this.name}:cacheUpdated:${hashKey(queryKey)}` as const;\n let settled = false;\n let idle = true;\n\n const unsubscribe = (\n handlerToRemove: (\n payload: DataServiceGranularCacheUpdatedPayload,\n ) => void,\n ): void => {\n try {\n this.#messenger.unsubscribe(eventType, handlerToRemove);\n } catch {\n // The subscription was already cleared, e.g. by `destroy`.\n }\n };\n\n const listener = (\n payload: DataServiceGranularCacheUpdatedPayload,\n ): void => {\n // `added` only carries the blank state built right before the fetch\n // starts (pending and idle), and `removed` carries no state at all.\n if (payload.type !== 'updated') {\n return;\n }\n const { state } = payload.state.queries[0];\n idle = state.fetchStatus === 'idle';\n notify(state);\n if (settled && idle) {\n unsubscribe(listener);\n }\n };\n\n const current = this.#queryClient.getQueryState(queryKey);\n if (current) {\n idle = current.fetchStatus === 'idle';\n notify(serializeQueryState(current));\n }\n\n this.#messenger.subscribe(eventType, listener);\n\n try {\n return await runFetch();\n } finally {\n settled = true;\n if (idle) {\n unsubscribe(listener);\n }\n }\n }\n\n /\n Publish `cacheUpdated` events when the query or mutation cache is updated.\n \n @param objectType - The type of object updated (\"query\" or \"mutation\").\n * @param eventType - What happened to the query or mutation (\"added\" or \"updated\").\n * @param hash - The hash of the query or mutation.\n /\n #publishCacheUpdate(\n objectType: 'query' \| 'mutation',\n eventType: CacheUpdatedType,\n hash: string,\n ): void {\n const dehydrated =\n eventType === 'added' \|\| eventType === 'updated'\n ? dehydrate(this.#queryClient, {\n shouldDehydrateQuery: (query) =>\n objectType === 'query' && query.queryHash === hash,\n shouldDehydrateMutation: (mutation) =>\n objectType === 'mutation' &&\n mutation.options.mutationKey !== undefined &&\n hashKey(mutation.options.mutationKey) === hash,\n })\n : null;\n const state = dehydrated && {\n ...dehydrated,\n // The in flight `promise` is not JSON safe, so it is left out.\n queries: dehydrated.queries.map(({ promise: _promise, ...query }) => ({\n ...query,\n state: serializeQueryState(query.state),\n })),\n };\n\n this.#messenger.publish(\n `${this.name}:cacheUpdated` as const,\n {\n type: eventType,\n objectType,\n hash,\n state,\n } as DataServiceCacheUpdatedPayload,\n );\n this.#messenger.publish(\n `${this.name}:cacheUpdated:${hash}` as const,\n {\n type: eventType,\n objectType,\n state,\n } as DataServiceGranularCacheUpdatedPayload,\n );\n }\n\n /\n Persist the query client cache using the StorageService, if the cache is not empty.\n \n @returns Nothing.\n /\n async #persistCache(): Promise<void> {\n const state = dehydrate(this.#queryClient, {\n // This is the default, but we specify it to be explicit.\n shouldDehydrateQuery: (query) => query.state.status === 'success',\n });\n\n if (state.queries.length === 0 && state.mutations.length === 0) {\n await this.#externalMessenger.call(\n 'StorageService:removeItem',\n this.name,\n STORAGE_SERVICE_KEY,\n );\n return;\n }\n\n const cache: PersistedCache = {\n timestamp: Date.now(),\n state,\n };\n\n await this.#externalMessenger.call(\n 'StorageService:setItem',\n this.name,\n STORAGE_SERVICE_KEY,\n cache as unknown as Json,\n );\n }\n\n /\n Load the query client cache from the StorageService, if persistence is configured\n * and the persisted cache is not expired.\n \n @returns Nothing.\n */\n async #loadCache(): Promise<void> {\n if (!this.#persistenceConfig) {\n return;\n }\n\n const { result: untypedCache } = await this.#externalMessenger.call(\n 'StorageService:getItem',\n this.name,\n STORAGE_SERVICE_KEY,\n );\n\n if (!untypedCache) {\n return;\n }\n\n const cache = untypedCache as unknown as PersistedCache;\n\n if (Date.now() - cache.timestamp >= this.#persistenceConfig.maxAge) {\n await this.#externalMessenger.call(\n 'StorageService:removeItem',\n this.name,\n STORAGE_SERVICE_KEY,\n );\n return;\n }\n\n hydrate(this.#queryClient, cache.state);\n }\n}\n"]}
1	+ {"version":3,"file":"BaseDataService.js","sourceRoot":"","sources":["../src/BaseDataService.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAE3D,OAAO,EAYL,WAAW,EAKX,SAAS,EACT,OAAO,EACP,OAAO,GAER,MAAM,sBAAsB,CAAC;AAC9B,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,EAAE,QAAQ,EAAiB,MAAM,WAAW,CAAC;AACpD,OAAO,EAAE,EAAE,IAAI,MAAM,EAAE,MAAM,MAAM,CAAC;AAEpC,OAAO,EACL,mBAAmB,GAGpB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AACjE,OAAO,EAAE,uBAAuB,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAE3E,MAAM,GAAG,GAAG,kBAAkB,CAAC,aAAa,EAAE,iBAAiB,CAAC,CAAC;AAmFjE;;GAEG;AACH,MAAM,qBAAqB,GAAmB;IAC5C,OAAO,EAAE;QACP,KAAK,EAAE,KAAK;QACZ,SAAS,EAAE,cAAc,CAAC,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC;KAC9C;IACD,SAAS,EAAE;QACT,KAAK,EAAE,KAAK;KACb;CACF,CAAC;AAEF,MAAM,CAAC,MAAM,mBAAmB,GAAG,OAAO,CAAC;AA2B3C,MAAM,OAAO,eAAe;IAIV,IAAI,CAAc;IAEzB,UAAU,CAIjB;IAEO,kBAAkB,CAGzB;IAEQ,SAAS,CAAmB;IAE7B,OAAO,CAAgB;IAEvB,YAAY,CAAc;IAE1B,sBAAsB,CAAa;IAEnC,yBAAyB,CAAa;IAEtC,iBAAiB,CAA6B;IAE9C,kBAAkB,CAA4B;IAEvD,YAAY,EACV,IAAI,EACJ,SAAS,EACT,iBAAiB,GAAG,EAAE,EACtB,aAAa,EACb,iBAAiB,GAalB;QACC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QAEjB,2EAA2E;QAC3E,kFAAkF;QAClF,yDAAyD;QACzD,6FAA6F;QAC7F,IAAI,CAAC,UAAU,GAAG,SAIjB,CAAC;QACF,IAAI,CAAC,kBAAkB,GAAG,SAGzB,CAAC;QACF,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAE3B,IAAI,CAAC,YAAY,GAAG,IAAI,WAAW,CAAC;YAClC,GAAG,iBAAiB;YACpB,cAAc,EAAE;gBACd,OAAO,EAAE;oBACP,GAAG,qBAAqB,CAAC,OAAO;oBAChC,GAAG,iBAAiB,CAAC,cAAc,EAAE,OAAO;iBAC7C;gBACD,SAAS,EAAE;oBACT,GAAG,qBAAqB,CAAC,SAAS;oBAClC,GAAG,iBAAiB,CAAC,cAAc,EAAE,SAAS;iBAC/C;aACF;SACF,CAAC,CAAC;QAEH,IAAI,CAAC,kBAAkB,GAAG,iBAAiB,CAAC;QAE5C,IAAI,CAAC,OAAO,GAAG,mBAAmB,CAAC,aAAa,CAAC,CAAC;QAElD,IAAI,CAAC,iBAAiB;YACpB,IAAI,CAAC,kBAAkB;gBACvB,QAAQ,CACN,GAAG,EAAE;oBACH,IAAI,CAAC,aAAa,EAAE,CAAC,KAAK;oBACxB,0BAA0B;oBAC1B,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,gBAAgB,EAAE,CAAC,KAAK,CAAC,CACrD,CAAC;gBACJ,CAAC,EACD,IAAI,CAAC,kBAAkB,CAAC,UAAU;oBAChC,cAAc,CAAC,EAAE,EAAE,QAAQ,CAAC,MAAM,CAAC,EACrC;oBACE,OAAO,EACL,IAAI,CAAC,kBAAkB,CAAC,aAAa;wBACrC,cAAc,CAAC,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC;iBACrC,CACF,CAAC;QAEJ,IAAI,CAAC,sBAAsB,GAAG,IAAI,CAAC,YAAY;aAC5C,aAAa,EAAE;aACf,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;YACnB,GAAG,CAAC,2BAA2B,EAAE,KAAK,CAAC,CAAC;YACxC,IAAI,CAAC,OAAO,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;gBACzD,IAAI,CAAC,mBAAmB,CACtB,OAAO,EACP,KAAK,CAAC,IAAwB,EAC9B,KAAK,CAAC,KAAK,CAAC,SAAS,CACtB,CAAC;gBAEF,IAAI,CAAC,iBAAiB,EAAE,EAAE,CAAC;YAC7B,CAAC;QACH,CAAC,CAAC,CAAC;QAEL,GAAG,CAAC,+BAA+B,CAAC,CAAC;QACrC,IAAI,CAAC,yBAAyB,GAAG,IAAI,CAAC,YAAY;aAC/C,gBAAgB,EAAE;aAClB,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;YACnB,GAAG,CAAC,8BAA8B,EAAE,KAAK,CAAC,CAAC;YAC3C,IACE,CAAC,OAAO,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC;gBACpD,KAAK,CAAC,QAAQ,EAAE,OAAO,CAAC,WAAW,KAAK,SAAS,EACjD,CAAC;gBACD,MAAM,YAAY,GAAG,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;gBACjE,IAAI,CAAC,mBAAmB,CACtB,UAAU,EACV,KAAK,CAAC,IAAwB,EAC9B,YAAY,CACb,CAAC;gBAEF,IAAI,CAAC,iBAAiB,EAAE,EAAE,CAAC;YAC7B,CAAC;QACH,CAAC,CAAC,CAAC;QAEL,IAAI,CAAC,UAAU,CAAC,qBAAqB,CACnC,GAAG,IAAI,CAAC,IAAI,oBAAoB,EAChC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAClC,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACO,KAAK,CAAC,UAAU,CAQxB,EACA,OAAO,EACP,cAAc,EACd,GAAG,OAAO,EAUX;QACC,OAAO,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC;YAClC,GAAG,OAAO;YACV,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;gBACzB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;gBACpE,OAAO,oBAAoB,CAAC,OAAO,CAAC,QAAQ,EAAE,QAAQ,EAAE,cAAc,CAAC,CAAC;YAC1E,CAAC;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACO,KAAK,CAAC,kBAAkB,CAUhC,EACE,cAAc,EACd,GAAG,OAAO,EAiBT,EACH,SAAsB;QAEtB,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE,CAAC;QAEhD,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAItB;YACA,QAAQ,EAAE,OAAO,CAAC,QAAQ;SAC3B,CAAC,CAAC;QAEH,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACrC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,kBAAkB,CAAC;gBACxD,GAAG,OAAO;gBACV,gBAAgB,EAAE,SAAS,IAAI,OAAO,CAAC,gBAAgB;gBACvD,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;oBACzB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CACrD,OAAO,CAAC,OAAO,CAAC;wBACd,GAAG,OAAO;wBACV,SAAS,EAAE,OAAO,CAAC,IAAI,EAAE,SAAS,IAAI,OAAO,CAAC,SAAS;qBACxD,CAAC,CACH,CAAC;oBACF,OAAO,oBAAoB,CACzB,OAAO,CAAC,QAAQ,EAChB,QAAQ,EACR,cAAc,CACf,CAAC;gBACJ,CAAC;aACF,CAAC,CAAC;YAEH,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACzB,CAAC;QAED,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC;QAC/C,MAAM,IAAI,GAAG,OAAO,CAAC,gBAAgB,CACnC,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,EACvB,KAAK,EACL,UAAU,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,EACjC,UAAU,CACX,CAAC;QAEF,MAAM,SAAS,GAAG,SAAS,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC;QAEtE,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,KAAK,CAC9B,EAAE,GAAG,KAAK,CAAC,OAAO,EAAE,IAAI,EAAE,EAAE,SAAS,EAAE,EAAE,EACzC,EAAE,IAAI,EAAE,EAAE,SAAS,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,CACvC,CAAC;QAEF,MAAM,SAAS,GAAG,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CACtD,SAAS,CAAC,KAAK,EAAE,SAAS,CAAC,CAC5B,CAAC;QAEF,OAAO,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACO,KAAK,CAAC,eAAe,CAS7B,EACA,UAAU,EACV,cAAc,EACd,QAAQ,GAAG,MAAM,EAAE,EACnB,GAAG,OAAO,EASX;QACC,MAAM,aAAa,GAAG,IAAI,CAAC,YAAY,CAAC,gBAAgB,EAAE,CAAC;QAC3D,MAAM,QAAQ,GAAG,aAAa,CAAC,KAAK,CAKlC,IAAI,CAAC,YAAY,EAAE;YACnB,GAAG,OAAO;YACV,IAAI,EAAE;gBACJ,GAAG,OAAO,CAAC,IAAI;gBACf,QAAQ;aACT;YACD,UAAU,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,EAAE;gBAC5B,wEAAwE;gBACxE,qEAAqE;gBACrE,gEAAgE;gBAChE,4CAA4C;gBAC5C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,oBAAoB,CAAC,OAAO,CAAC,GAAG,EAAE,CACpE,UAAU,CAAC,GAAG,IAAI,CAAC,CACpB,CAAC;gBACF,qEAAqE;gBACrE,wEAAwE;gBACxE,yBAAyB;gBACzB,OAAO,uBAAuB,CAC5B,OAAO,CAAC,WAAW,EACnB,QAAQ,EACR,cAAc,CACN,CAAC;YACb,CAAC;SACF,CAAC,CAAC;QACH,qEAAqE;QACrE,yEAAyE;QACzE,4DAA4D;QAC5D,OAAO,MAAM,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACpC,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAA0C,EAC1C,OAA2B;QAE3B,OAAO,IAAI,CAAC,YAAY,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;;;OAUG;IACO,KAAK,CAAC,aAAa,CAC3B,OAAgC,EAChC,aAA6B;QAE7B,MAAM,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;IAChE,CAAC;IAED;;OAEG;IACH,IAAI;QACF,IAAI,CAAC,UAAU,EAAE,CAAC,KAAK;QACrB,0BAA0B;QAC1B,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,gBAAgB,EAAE,CAAC,KAAK,CAAC,CACrD,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,OAAO;QACL,IAAI,CAAC,iBAAiB,EAAE,MAAM,EAAE,CAAC;QACjC,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAC9B,IAAI,CAAC,yBAAyB,EAAE,CAAC;QACjC,wEAAwE;QACxE,wEAAwE;QACxE,4EAA4E;QAC5E,iDAAiD;QACjD,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,YAAY,CAAC,gBAAgB,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC;YACrE,QAAQ,CAAC,OAAO,EAAE,CAAC;QACrB,CAAC;QACD,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC;QAC1B,IAAI,CAAC,SAAS,CAAC,kBAAkB,EAAE,CAAC;QACpC,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,CAAC;IAChC,CAAC;IAED;;;;;;OAMG;IACH,mBAAmB,CACjB,UAAgC,EAChC,SAA2B,EAC3B,IAAY;QAEZ,MAAM,KAAK,GACT,SAAS,KAAK,OAAO,IAAI,SAAS,KAAK,SAAS;YAC9C,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,EAAE;gBAC3B,oBAAoB,EAAE,CAAC,KAAK,EAAE,EAAE,CAC9B,UAAU,KAAK,OAAO,IAAI,KAAK,CAAC,SAAS,KAAK,IAAI;gBACpD,uBAAuB,EAAE,CAAC,QAAQ,EAAE,EAAE,CACpC,UAAU,KAAK,UAAU;oBACzB,QAAQ,CAAC,OAAO,CAAC,WAAW,KAAK,SAAS;oBAC1C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,KAAK,IAAI;aACjD,CAAC;YACJ,CAAC,CAAC,IAAI,CAAC;QAEX,IAAI,CAAC,UAAU,CAAC,OAAO,CACrB,GAAG,IAAI,CAAC,IAAI,eAAwB,EACpC;YACE,IAAI,EAAE,SAAS;YACf,UAAU;YACV,IAAI;YACJ,KAAK;SAC4B,CACpC,CAAC;QACF,IAAI,CAAC,UAAU,CAAC,OAAO,CACrB,GAAG,IAAI,CAAC,IAAI,iBAAiB,IAAI,EAAW,EAC5C;YACE,IAAI,EAAE,SAAS;YACf,UAAU;YACV,KAAK;SACoC,CAC5C,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,aAAa;QACjB,MAAM,KAAK,GAAG,SAAS,CAAC,IAAI,CAAC,YAAY,EAAE;YACzC,yDAAyD;YACzD,oBAAoB,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,KAAK,SAAS;SAClE,CAAC,CAAC;QAEH,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,IAAI,KAAK,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC/D,MAAM,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAChC,2BAA2B,EAC3B,IAAI,CAAC,IAAI,EACT,mBAAmB,CACpB,CAAC;YACF,OAAO;QACT,CAAC;QAED,MAAM,KAAK,GAAmB;YAC5B,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;YACrB,KAAK;SACN,CAAC;QAEF,MAAM,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAChC,wBAAwB,EACxB,IAAI,CAAC,IAAI,EACT,mBAAmB,EACnB,KAAwB,CACzB,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,UAAU;QACd,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC7B,OAAO;QACT,CAAC;QAED,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,IAAI,CACjE,wBAAwB,EACxB,IAAI,CAAC,IAAI,EACT,mBAAmB,CACpB,CAAC;QAEF,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,OAAO;QACT,CAAC;QAED,MAAM,KAAK,GAAG,YAAyC,CAAC;QAExD,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC,SAAS,IAAI,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE,CAAC;YACnE,MAAM,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAChC,2BAA2B,EAC3B,IAAI,CAAC,IAAI,EACT,mBAAmB,CACpB,CAAC;YACF,OAAO;QACT,CAAC;QAED,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IAC1C,CAAC;CACF","sourcesContent":["import {\n Messenger,\n ActionConstraint,\n EventConstraint,\n MessengerActions,\n MessengerEvents,\n} from '@metamask/messenger';\nimport type {\n StorageServiceGetItemAction,\n StorageServiceRemoveItemAction,\n StorageServiceSetItemAction,\n} from '@metamask/storage-service';\nimport { Struct } from '@metamask/superstruct';\nimport { Duration, inMilliseconds } from '@metamask/utils';\nimport type { Json } from '@metamask/utils';\nimport {\n DefaultError,\n DefaultOptions,\n DehydratedState,\n FetchQueryOptions,\n InfiniteData,\n InfiniteQueryPageParamsOptions,\n CancelOptions,\n InvalidateOptions,\n InvalidateQueryFilters,\n MutationOptions,\n OmitKeyof,\n QueryClient,\n QueryClientConfig,\n QueryFilters,\n QueryFunction,\n WithRequired,\n dehydrate,\n hydrate,\n hashKey,\n MutationFunction,\n} from '@tanstack/query-core';\nimport deepEqual from 'fast-deep-equal';\nimport { debounce, DebouncedFunc } from 'lodash-es';\nimport { v4 as uuidV4 } from 'uuid';\n\nimport {\n createServicePolicy,\n CreateServicePolicyOptions,\n ServicePolicy,\n} from './createServicePolicy.js';\nimport { createModuleLogger, projectLogger } from './loggers.js';\nimport { processMutationResponse, processQueryResponse } from './utils.js';\n\nconst log = createModuleLogger(projectLogger, 'BaseDataService');\n\n/*\n Data service mutations and queries use the following format:\n * `['${ServiceName}:${ActionName}', ...params]`\n /\ntype Key = [string, ...Json[]] \| readonly [string, ...Json[]];\n\n/\n * Data service queries use the following format:\n * `['${ServiceName}:${ActionName}', ...params]`\n /\nexport type QueryKey = Key;\n\n/\n * Data service mutations use the following format:\n * `['${ServiceName}:${ActionName}', ...params]`\n /\nexport type MutationKey = Key;\n\n/\n The supertype of all messengers, scoped to a namespace.\n \n @template Namespace - The namespace for the messenger's own actions and\n * events.\n /\nexport type BaseMessenger<Namespace extends string> = Messenger<\n Namespace,\n ActionConstraint,\n EventConstraint,\n // Use `any` to allow any parent to be set. `any` is harmless in a type constraint anyway,\n // it's the one totally safe place to use it.\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n any\n>;\n\nexport type DataServiceGranularCacheUpdatedPayload = {\n objectType: 'query' \| 'mutation';\n} & (\n \| { type: 'added' \| 'updated'; state: DehydratedState }\n \| {\n type: 'removed';\n state: null;\n }\n);\n\nexport type DataServiceCacheUpdatedPayload =\n DataServiceGranularCacheUpdatedPayload & {\n hash: string;\n };\n\ntype CacheUpdatedType = DataServiceCacheUpdatedPayload['type'];\n\nexport type DataServiceInvalidateQueriesAction<ServiceName extends string> = {\n type: `${ServiceName}:invalidateQueries`;\n handler: BaseDataService<\n ServiceName,\n BaseMessenger<ServiceName>\n >['invalidateQueries'];\n};\n\nexport type DataServiceActions<ServiceName extends string> =\n DataServiceInvalidateQueriesAction<ServiceName>;\n\ntype DataServiceAllowedActions =\n \| StorageServiceGetItemAction\n \| StorageServiceSetItemAction\n \| StorageServiceRemoveItemAction;\n\nexport type DataServiceCacheUpdatedEvent<ServiceName extends string> = {\n type: `${ServiceName}:cacheUpdated`;\n payload: [DataServiceCacheUpdatedPayload];\n};\n\nexport type DataServiceGranularCacheUpdatedEvent<ServiceName extends string> = {\n type: `${ServiceName}:cacheUpdated:${string}`;\n payload: [DataServiceGranularCacheUpdatedPayload];\n};\n\nexport type DataServiceEvents<ServiceName extends string> =\n \| DataServiceCacheUpdatedEvent<ServiceName>\n \| DataServiceGranularCacheUpdatedEvent<ServiceName>;\n\n/\n * Defaults to apply to all data service queries if no default option specified.\n /\nconst QUERY_CLIENT_DEFAULTS: DefaultOptions = {\n queries: {\n retry: false,\n staleTime: inMilliseconds(1, Duration.Minute),\n },\n mutations: {\n retry: false,\n },\n};\n\nexport const STORAGE_SERVICE_KEY = 'cache';\n\n/\n Options for persistence configuration.\n /\nexport type PersistenceConfiguration = {\n /\n The maximum age before the cache is treated as expired in milliseconds.\n * This is relevant for rehydrating the state during initialization,\n * if the cached state is too old it will be discarded.\n /\n maxAge: number;\n /\n The number of milliseconds to wait before triggering persistence following a cache update.\n /\n writeDelay?: number;\n /\n The maximum number of milliseconds to wait between persistence writes.\n /\n maxWriteDelay?: number;\n};\n\ntype PersistedCache = {\n state: DehydratedState;\n timestamp: number;\n};\n\nexport class BaseDataService<\n ServiceName extends string,\n ServiceMessenger extends BaseMessenger<ServiceName>,\n> {\n public readonly name: ServiceName;\n\n readonly #messenger: Messenger<\n ServiceName,\n DataServiceActions<ServiceName>,\n DataServiceEvents<ServiceName>\n >;\n\n readonly #externalMessenger: Messenger<\n ServiceName,\n DataServiceAllowedActions\n >;\n\n protected messenger: ServiceMessenger;\n\n readonly #policy: ServicePolicy;\n\n readonly #queryClient: QueryClient;\n\n readonly #queryCacheUnsubscribe: () => void;\n\n readonly #mutationCacheUnsubscribe: () => void;\n\n readonly #debouncedPersist?: DebouncedFunc<() => void>;\n\n readonly #persistenceConfig?: PersistenceConfiguration;\n\n constructor({\n name,\n messenger,\n queryClientConfig = {},\n policyOptions,\n persistenceConfig,\n }: {\n name: ServiceName;\n messenger: DataServiceActions<ServiceName>['type'] extends\n \| MessengerActions<ServiceMessenger>['type']\n \| DataServiceAllowedActions['type']\n ? DataServiceEvents<ServiceName>['type'] extends MessengerEvents<ServiceMessenger>['type']\n ? ServiceMessenger\n : never\n : never;\n queryClientConfig?: QueryClientConfig;\n policyOptions?: CreateServicePolicyOptions;\n persistenceConfig?: PersistenceConfiguration;\n }) {\n this.name = name;\n\n // We store two narrowly-typed messengers alongside the generic public one:\n // - #messenger handles the service's own action registration and event publishing\n // - #externalMessenger handles calls to external actions\n // Splitting them avoids TypeScript issues with mixing template-literals with regular strings\n this.#messenger = messenger as unknown as Messenger<\n ServiceName,\n DataServiceActions<ServiceName>,\n DataServiceEvents<ServiceName>\n >;\n this.#externalMessenger = messenger as unknown as Messenger<\n ServiceName,\n DataServiceAllowedActions\n >;\n this.messenger = messenger;\n\n this.#queryClient = new QueryClient({\n ...queryClientConfig,\n defaultOptions: {\n queries: {\n ...QUERY_CLIENT_DEFAULTS.queries,\n ...queryClientConfig.defaultOptions?.queries,\n },\n mutations: {\n ...QUERY_CLIENT_DEFAULTS.mutations,\n ...queryClientConfig.defaultOptions?.mutations,\n },\n },\n });\n\n this.#persistenceConfig = persistenceConfig;\n\n this.#policy = createServicePolicy(policyOptions);\n\n this.#debouncedPersist =\n this.#persistenceConfig &&\n debounce(\n () => {\n this.#persistCache().catch(\n / istanbul ignore next /\n (error) => this.#messenger.captureException?.(error),\n );\n },\n this.#persistenceConfig.writeDelay ??\n inMilliseconds(10, Duration.Second),\n {\n maxWait:\n this.#persistenceConfig.maxWriteDelay ??\n inMilliseconds(1, Duration.Minute),\n },\n );\n\n this.#queryCacheUnsubscribe = this.#queryClient\n .getQueryCache()\n .subscribe((event) => {\n log('Query cache event emitted', event);\n if (['added', 'updated', 'removed'].includes(event.type)) {\n this.#publishCacheUpdate(\n 'query',\n event.type as CacheUpdatedType,\n event.query.queryHash,\n );\n\n this.#debouncedPersist?.();\n }\n });\n\n log('Subscribing to mutation cache');\n this.#mutationCacheUnsubscribe = this.#queryClient\n .getMutationCache()\n .subscribe((event) => {\n log('Mutation cache event emitted', event);\n if (\n ['added', 'updated', 'removed'].includes(event.type) &&\n event.mutation?.options.mutationKey !== undefined\n ) {\n const mutationHash = hashKey(event.mutation.options.mutationKey);\n this.#publishCacheUpdate(\n 'mutation',\n event.type as CacheUpdatedType,\n mutationHash,\n );\n\n this.#debouncedPersist?.();\n }\n });\n\n this.#messenger.registerActionHandler(\n `${this.name}:invalidateQueries`,\n this.invalidateQueries.bind(this),\n );\n }\n\n /\n Fetch a query.\n \n @param options - The options defining the query. Keep in mind that `queryKey` and `queryFn` are required when using data services.\n * Additionally `retry` and `retryDelay` are not available, retries can be customized using the `servicePolicyOptions`.\n * @param options.queryFn - The query function.\n * @param options.responseStruct - An optional struct for validating the response of the query function.\n * @returns The query results.\n /\n protected async fetchQuery<\n TQueryFnData extends Json,\n TError = DefaultError,\n TDataStruct extends Struct<TQueryFnData> \| undefined = undefined,\n TData = TDataStruct extends Struct<infer StructType>\n ? StructType\n : TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n >({\n queryFn,\n responseStruct,\n ...options\n }: WithRequired<\n OmitKeyof<\n FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n 'retry' \| 'retryDelay' \| 'queryFn'\n >,\n 'queryKey'\n > & {\n queryFn: QueryFunction<TQueryFnData, TQueryKey>;\n responseStruct?: TDataStruct;\n }): Promise<TData> {\n return this.#queryClient.fetchQuery({\n ...options,\n queryFn: async (context) => {\n const response = await this.#policy.execute(() => queryFn(context));\n return processQueryResponse(options.queryKey, response, responseStruct);\n },\n });\n }\n\n /\n Fetch a paginated query.\n \n @param options - The options defining the query. Keep in mind that `queryKey` and `queryFn` are required when using data services.\n * Additionally `retry` and `retryDelay` are not available, retries can be customized using the `servicePolicyOptions`.\n * @param options.responseStruct - An optional struct for validating the response of the query function.\n * @param pageParam - An optional page parameter.\n * @returns The query result, exclusively the requested page is returned.\n /\n protected async fetchInfiniteQuery<\n TQueryFnData extends Json,\n TError = DefaultError,\n TDataStruct extends Struct<TQueryFnData> \| undefined = undefined,\n TData extends TQueryFnData = TDataStruct extends Struct<infer StructType>\n ? StructType\n : TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam extends Json = Json,\n >(\n {\n responseStruct,\n ...options\n }: WithRequired<\n OmitKeyof<\n FetchQueryOptions<\n TQueryFnData,\n TError,\n InfiniteData<TData, TPageParam>,\n TQueryKey,\n TPageParam\n >,\n 'retry' \| 'retryDelay' \| 'queryFn' \| 'initialPageParam'\n >,\n 'queryKey'\n > &\n InfiniteQueryPageParamsOptions<TQueryFnData, TPageParam> & {\n queryFn: QueryFunction<TQueryFnData, TQueryKey, TPageParam>;\n responseStruct?: TDataStruct;\n },\n pageParam?: TPageParam,\n ): Promise<TData> {\n const cache = this.#queryClient.getQueryCache();\n\n const query = cache.find<\n TQueryFnData,\n TError,\n InfiniteData<TData, TPageParam>\n >({\n queryKey: options.queryKey,\n });\n\n if (!query?.state.data \|\| !pageParam) {\n const result = await this.#queryClient.fetchInfiniteQuery({\n ...options,\n initialPageParam: pageParam ?? options.initialPageParam,\n queryFn: async (context) => {\n const response = await this.#policy.execute(async () =>\n options.queryFn({\n ...context,\n pageParam: context.meta?.pageParam ?? context.pageParam,\n }),\n );\n return processQueryResponse(\n options.queryKey,\n response,\n responseStruct,\n );\n },\n });\n\n return result.pages[0];\n }\n\n const { pages, pageParams } = query.state.data;\n const next = options.getNextPageParam(\n pages[pages.length - 1],\n pages,\n pageParams[pageParams.length - 1],\n pageParams,\n );\n\n const direction = deepEqual(pageParam, next) ? 'forward' : 'backward';\n\n const result = await query.fetch(\n { ...query.options, meta: { pageParam } },\n { meta: { fetchMore: { direction } } },\n );\n\n const pageIndex = result.pageParams.findIndex((param) =>\n deepEqual(param, pageParam),\n );\n\n return result.pages[pageIndex];\n }\n\n /\n Execute a mutation (e.g. a request that is expected to change server-side data).\n * Unlike `fetchQuery`, the request will not be cached or retried.\n \n @param options - The options defining the mutation. Keep in mind that `mutationKey` and `mutationFn` are required when using data services.\n * Additionally, `retry` and `retryDelay` are not available.\n * @param options.mutationFn - The mutation function.\n * @param options.responseStruct - An optional struct for validating the response of the mutation function.\n * @param options.globalId - A string which uniquely identifies this mutation\n * between the query client in this data service\n * and the one that `createUIQueryClient` in `@metamask/react-data-query` holds.\n * This global ID will be stored in the `meta` data of the created mutation\n * and included in `:cacheUpdated` payloads. Defaults to a UUID.\n * @returns The mutation results.\n /\n protected async executeMutation<\n TMutationFnData extends Json,\n TDataStruct extends Struct<TMutationFnData> \| undefined = undefined,\n TData = TDataStruct extends Struct<infer StructType>\n ? StructType\n : TMutationFnData,\n TError = DefaultError,\n TOnMutateResult = unknown,\n TMutationKey extends MutationKey = MutationKey,\n >({\n mutationFn,\n responseStruct,\n globalId = uuidV4(),\n ...options\n }: OmitKeyof<\n MutationOptions<TData, TError, Record<never, never>, TOnMutateResult>,\n 'retry' \| 'retryDelay' \| 'mutationKey' \| 'mutationFn'\n > & {\n mutationKey: TMutationKey;\n mutationFn: MutationFunction<TMutationFnData, Record<never, never>>;\n responseStruct?: TDataStruct;\n globalId?: string;\n }): Promise<TData> {\n const mutationCache = this.#queryClient.getMutationCache();\n const mutation = mutationCache.build<\n TData,\n TError,\n Record<never, never>,\n TOnMutateResult\n >(this.#queryClient, {\n ...options,\n meta: {\n ...options.meta,\n globalId,\n },\n mutationFn: async (...args) => {\n // To guard against mutations being retried, we deliberately execute the\n // mutation function through the circuit breaker policy alone, rather\n // than through `this.#policy` (which is a combination of both a\n // circuit breaker policy and retry policy).\n const response = await this.#policy.circuitBreakerPolicy.execute(() =>\n mutationFn(...args),\n );\n // Type assertion: TypeScript is not able to unify the type that this\n // function returns with `TData` at compile-time. We can still typecheck\n // the arguments, though.\n return processMutationResponse(\n options.mutationKey,\n response,\n responseStruct,\n ) as TData;\n },\n });\n // We purposely pass an empty set of variables because this method is\n // intended to be used internally by the data service, not end users, and\n // the data service has full control of `mutationFn` anyway.\n return await mutation.execute({});\n }\n\n /\n Invalidate queries serviced by this data service.\n \n @param filters - Optional filter for selecting specific queries.\n * @param options - Additional optional options for query invalidations.\n * @returns Nothing.\n /\n async invalidateQueries(\n filters?: InvalidateQueryFilters<QueryKey>,\n options?: InvalidateOptions,\n ): Promise<void> {\n return this.#queryClient.invalidateQueries(filters, options);\n }\n\n /\n Cancel in-flight queries serviced by this data service.\n \n Use this in your subclass if you need to abort a concurrent fetch before\n * starting a forced refresh (e.g. `Cache-Control: no-cache` reads), so a\n * slower non-fresh request cannot overwrite the result.\n \n @param filters - Optional filter for selecting specific queries.\n * @param cancelOptions - Optional options for cancelling the queries.\n * @returns Nothing.\n /\n protected async cancelQueries(\n filters?: QueryFilters<QueryKey>,\n cancelOptions?: CancelOptions,\n ): Promise<void> {\n await this.#queryClient.cancelQueries(filters, cancelOptions);\n }\n\n /\n Initialize the service, rehydrating the cache with persisted data if possible.\n /\n init(): void {\n this.#loadCache().catch(\n / istanbul ignore next /\n (error) => this.#messenger.captureException?.(error),\n );\n }\n\n /\n Prepares the service for garbage collection. This should be extended\n * by any subclasses to clean up any additional connections or events.\n /\n destroy(): void {\n this.#debouncedPersist?.cancel();\n this.#queryCacheUnsubscribe();\n this.#mutationCacheUnsubscribe();\n // `QueryClient.clear()` clears both caches, but `MutationCache.clear()`\n // only drops its references to mutations without clearing their pending\n // garbage-collection timers. We destroy each mutation first so those timers\n // are cleared and do not keep the process alive.\n for (const mutation of this.#queryClient.getMutationCache().getAll()) {\n mutation.destroy();\n }\n this.#queryClient.clear();\n this.messenger.clearSubscriptions();\n this.messenger.clearActions();\n }\n\n /\n Publish `cacheUpdated` events when the query or mutation cache is updated.\n \n @param objectType - The type of object updated (\"query\" or \"mutation\").\n * @param eventType - What happened to the query or mutation (\"added\" or \"updated\").\n * @param hash - The hash of the query or mutation.\n /\n #publishCacheUpdate(\n objectType: 'query' \| 'mutation',\n eventType: CacheUpdatedType,\n hash: string,\n ): void {\n const state =\n eventType === 'added' \|\| eventType === 'updated'\n ? dehydrate(this.#queryClient, {\n shouldDehydrateQuery: (query) =>\n objectType === 'query' && query.queryHash === hash,\n shouldDehydrateMutation: (mutation) =>\n objectType === 'mutation' &&\n mutation.options.mutationKey !== undefined &&\n hashKey(mutation.options.mutationKey) === hash,\n })\n : null;\n\n this.#messenger.publish(\n `${this.name}:cacheUpdated` as const,\n {\n type: eventType,\n objectType,\n hash,\n state,\n } as DataServiceCacheUpdatedPayload,\n );\n this.#messenger.publish(\n `${this.name}:cacheUpdated:${hash}` as const,\n {\n type: eventType,\n objectType,\n state,\n } as DataServiceGranularCacheUpdatedPayload,\n );\n }\n\n /\n Persist the query client cache using the StorageService, if the cache is not empty.\n \n @returns Nothing.\n /\n async #persistCache(): Promise<void> {\n const state = dehydrate(this.#queryClient, {\n // This is the default, but we specify it to be explicit.\n shouldDehydrateQuery: (query) => query.state.status === 'success',\n });\n\n if (state.queries.length === 0 && state.mutations.length === 0) {\n await this.#externalMessenger.call(\n 'StorageService:removeItem',\n this.name,\n STORAGE_SERVICE_KEY,\n );\n return;\n }\n\n const cache: PersistedCache = {\n timestamp: Date.now(),\n state,\n };\n\n await this.#externalMessenger.call(\n 'StorageService:setItem',\n this.name,\n STORAGE_SERVICE_KEY,\n cache as unknown as Json,\n );\n }\n\n /\n Load the query client cache from the StorageService, if persistence is configured\n * and the persisted cache is not expired.\n \n @returns Nothing.\n */\n async #loadCache(): Promise<void> {\n if (!this.#persistenceConfig) {\n return;\n }\n\n const { result: untypedCache } = await this.#externalMessenger.call(\n 'StorageService:getItem',\n this.name,\n STORAGE_SERVICE_KEY,\n );\n\n if (!untypedCache) {\n return;\n }\n\n const cache = untypedCache as unknown as PersistedCache;\n\n if (Date.now() - cache.timestamp >= this.#persistenceConfig.maxAge) {\n await this.#externalMessenger.call(\n 'StorageService:removeItem',\n this.name,\n STORAGE_SERVICE_KEY,\n );\n return;\n }\n\n hydrate(this.#queryClient, cache.state);\n }\n}\n"]}

package/dist/index.d.ts CHANGED Viewed

@@ -1,6 +1,6 @@
 export type { Event as CockatielEvent, FailureReason as CockatielFailureReason, } from 'cockatiel';
 export { BrokenCircuitError, EventEmitter as CockatielEventEmitter, CircuitState, ConstantBackoff, ExponentialBackoff, handleAll, handleWhen, } from 'cockatiel';
-export type { CacheUpdatedState, DataServiceActions, DataServiceEvents, DataServiceCacheUpdatedPayload, DataServiceGranularCacheUpdatedPayload, DataServiceInvalidateQueriesAction, DataServiceCacheUpdatedEvent, DataServiceGranularCacheUpdatedEvent, DataServiceQueryState, QueryKey, QueryStateChangeHandler, SerializedQueryError, MutationKey, PersistenceConfiguration, } from './BaseDataService.js';
+export type { DataServiceActions, DataServiceEvents, DataServiceCacheUpdatedPayload, DataServiceGranularCacheUpdatedPayload, DataServiceInvalidateQueriesAction, DataServiceCacheUpdatedEvent, DataServiceGranularCacheUpdatedEvent, QueryKey, MutationKey, PersistenceConfiguration, } from './BaseDataService.js';
 export { BaseDataService } from './BaseDataService.js';
 export { DEFAULT_CIRCUIT_BREAK_DURATION, DEFAULT_DEGRADED_THRESHOLD, DEFAULT_MAX_CONSECUTIVE_FAILURES, DEFAULT_MAX_RETRIES, createServicePolicy, } from './createServicePolicy.js';
 export type { CreateServicePolicyOptions, ServicePolicy, } from './createServicePolicy.js';

package/dist/index.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,KAAK,IAAI,cAAc,EACvB,aAAa,IAAI,sBAAsB,GACxC,MAAM,WAAW,CAAC;AAEnB,OAAO,EACL,kBAAkB,EAClB,YAAY,IAAI,qBAAqB,EACrC,YAAY,EACZ,eAAe,EACf,kBAAkB,EAClB,SAAS,EACT,UAAU,GACX,MAAM,WAAW,CAAC;AAEnB,YAAY,EACV,~~iBAAiB,EACjB,~~kBAAkB,EAClB,iBAAiB,EACjB,8BAA8B,EAC9B,sCAAsC,EACtC,kCAAkC,EAClC,4BAA4B,EAC5B,oCAAoC,EACpC,~~qBAAqB,EACrB,~~QAAQ,EACR,~~uBAAuB,EACvB,oBAAoB,EACpB,~~WAAW,EACX,wBAAwB,GACzB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAEvD,OAAO,EACL,8BAA8B,EAC9B,0BAA0B,EAC1B,gCAAgC,EAChC,mBAAmB,EACnB,mBAAmB,GACpB,MAAM,0BAA0B,CAAC;AAClC,YAAY,EACV,0BAA0B,EAC1B,aAAa,GACd,MAAM,0BAA0B,CAAC"}
1	+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,KAAK,IAAI,cAAc,EACvB,aAAa,IAAI,sBAAsB,GACxC,MAAM,WAAW,CAAC;AAEnB,OAAO,EACL,kBAAkB,EAClB,YAAY,IAAI,qBAAqB,EACrC,YAAY,EACZ,eAAe,EACf,kBAAkB,EAClB,SAAS,EACT,UAAU,GACX,MAAM,WAAW,CAAC;AAEnB,YAAY,EACV,kBAAkB,EAClB,iBAAiB,EACjB,8BAA8B,EAC9B,sCAAsC,EACtC,kCAAkC,EAClC,4BAA4B,EAC5B,oCAAoC,EACpC,QAAQ,EACR,WAAW,EACX,wBAAwB,GACzB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAEvD,OAAO,EACL,8BAA8B,EAC9B,0BAA0B,EAC1B,gCAAgC,EAChC,mBAAmB,EACnB,mBAAmB,GACpB,MAAM,0BAA0B,CAAC;AAClC,YAAY,EACV,0BAA0B,EAC1B,aAAa,GACd,MAAM,0BAA0B,CAAC"}

package/dist/index.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAKA,OAAO,EACL,kBAAkB,EAClB,YAAY,IAAI,qBAAqB,EACrC,YAAY,EACZ,eAAe,EACf,kBAAkB,EAClB,SAAS,EACT,UAAU,GACX,MAAM,WAAW,CAAC;~~AAkBnB~~,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAEvD,OAAO,EACL,8BAA8B,EAC9B,0BAA0B,EAC1B,gCAAgC,EAChC,mBAAmB,EACnB,mBAAmB,GACpB,MAAM,0BAA0B,CAAC","sourcesContent":["export type {\n Event as CockatielEvent,\n FailureReason as CockatielFailureReason,\n} from 'cockatiel';\n\nexport {\n BrokenCircuitError,\n EventEmitter as CockatielEventEmitter,\n CircuitState,\n ConstantBackoff,\n ExponentialBackoff,\n handleAll,\n handleWhen,\n} from 'cockatiel';\n\nexport type {\n ~~CacheUpdatedState,\n~~ DataServiceActions,\n DataServiceEvents,\n DataServiceCacheUpdatedPayload,\n DataServiceGranularCacheUpdatedPayload,\n DataServiceInvalidateQueriesAction,\n DataServiceCacheUpdatedEvent,\n DataServiceGranularCacheUpdatedEvent,\n ~~DataServiceQueryState,\n~~ QueryKey,\n ~~QueryStateChangeHandler,\n SerializedQueryError,\n~~ MutationKey,\n PersistenceConfiguration,\n} from './BaseDataService.js';\nexport { BaseDataService } from './BaseDataService.js';\n\nexport {\n DEFAULT_CIRCUIT_BREAK_DURATION,\n DEFAULT_DEGRADED_THRESHOLD,\n DEFAULT_MAX_CONSECUTIVE_FAILURES,\n DEFAULT_MAX_RETRIES,\n createServicePolicy,\n} from './createServicePolicy.js';\nexport type {\n CreateServicePolicyOptions,\n ServicePolicy,\n} from './createServicePolicy.js';\n"]}
1	+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAKA,OAAO,EACL,kBAAkB,EAClB,YAAY,IAAI,qBAAqB,EACrC,YAAY,EACZ,eAAe,EACf,kBAAkB,EAClB,SAAS,EACT,UAAU,GACX,MAAM,WAAW,CAAC;AAcnB,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAEvD,OAAO,EACL,8BAA8B,EAC9B,0BAA0B,EAC1B,gCAAgC,EAChC,mBAAmB,EACnB,mBAAmB,GACpB,MAAM,0BAA0B,CAAC","sourcesContent":["export type {\n Event as CockatielEvent,\n FailureReason as CockatielFailureReason,\n} from 'cockatiel';\n\nexport {\n BrokenCircuitError,\n EventEmitter as CockatielEventEmitter,\n CircuitState,\n ConstantBackoff,\n ExponentialBackoff,\n handleAll,\n handleWhen,\n} from 'cockatiel';\n\nexport type {\n DataServiceActions,\n DataServiceEvents,\n DataServiceCacheUpdatedPayload,\n DataServiceGranularCacheUpdatedPayload,\n DataServiceInvalidateQueriesAction,\n DataServiceCacheUpdatedEvent,\n DataServiceGranularCacheUpdatedEvent,\n QueryKey,\n MutationKey,\n PersistenceConfiguration,\n} from './BaseDataService.js';\nexport { BaseDataService } from './BaseDataService.js';\n\nexport {\n DEFAULT_CIRCUIT_BREAK_DURATION,\n DEFAULT_DEGRADED_THRESHOLD,\n DEFAULT_MAX_CONSECUTIVE_FAILURES,\n DEFAULT_MAX_RETRIES,\n createServicePolicy,\n} from './createServicePolicy.js';\nexport type {\n CreateServicePolicyOptions,\n ServicePolicy,\n} from './createServicePolicy.js';\n"]}

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/base-data-service",
-  "version": "2.1.0-preview-9fd631f7d",
+  "version": "2.1.0-preview-6fbab7311",
   "description": "Provides utilities for building data services",
   "keywords": [
     "Ethereum",
@@ -59,13 +59,13 @@
     "cockatiel": "^3.2.1",
     "fast-deep-equal": "^3.1.3",
     "lodash-es": "^4.18.1",
-    "uuid": "^11.1.1"
+    "uuid": "^14.0.0"
   },
   "devDependencies": {
     "@metamask/auto-changelog": "^6.2.1",
     "@types/lodash-es": "^4.17.12",
     "@typescript/native": "npm:typescript@^7.0.2",
-    "nock": "^13.5.6",
+    "nock": "^15.0.5",
     "rimraf": "^6.1.3",
     "typedoc": "^0.28.20",
     "typedoc-plugin-missing-exports": "^4.1.4",