@metamask-previews/base-data-service 2.0.0-preview-0a1dd02ad → 2.1.0-preview-452564c37

package/CHANGELOG.md

@@ -7,9 +7,24 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.1.0]
+
+### Added
+
+- Add `executeMutation` protected method to `BaseDataService` to allow for making server-state-mutating requests ([#9324](https://github.com/MetaMask/core/pull/9324))
+  - These kinds of requests are never retried, unlike queries.
+  - To use this, create a method in your data service class which takes whatever arguments you need, plus a optional final argument called `globalId`; then call `executeMutation` with a `mutationKey`, `globalId`, and `mutationFn`. See `ExampleDataService` in this package for an example.
+  - A `MutationKey` type is also available.
+- Add protected `cancelQueries` so subclasses can abort in-flight reads before a forced refresh ([#10454](https://github.com/MetaMask/core/pull/10454))
+
 ### Changed
 
+- The payload for `:cacheUpdated` and `:cacheUpdated:${hash}` events now includes an `objectType` property, which is either "query" or "mutation" ([#9324](https://github.com/MetaMask/core/pull/9324))
 - Bump `@metamask/utils` from `^11.12.0` to `^12.0.0` ([#10192](https://github.com/MetaMask/core/pull/10192))
+- Add `uuid` `^11.1.1` as a dependency ([#9324](https://github.com/MetaMask/core/pull/9324))
+- Bump `@tanstack/query-core` from `^5.62.16` to `^5.89.0` ([#9324](https://github.com/MetaMask/core/pull/9324))
+- Bump `cockatiel` from `^3.1.2` to `^3.2.1` ([#10436](https://github.com/MetaMask/core/pull/10436))
+- Bump `lodash-es` from `^4.17.21` to `^4.18.1` ([#10447](https://github.com/MetaMask/core/pull/10447))
 
 ## [2.0.0]
 
@@ -100,7 +115,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Initial release ([#8039](https://github.com/MetaMask/core/pull/8039), [#8292](https://github.com/MetaMask/core/pull/8292))
 
-[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/base-data-service@2.0.0...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/base-data-service@2.1.0...HEAD
+[2.1.0]: https://github.com/MetaMask/core/compare/@metamask/base-data-service@2.0.0...@metamask/base-data-service@2.1.0
 [2.0.0]: https://github.com/MetaMask/core/compare/@metamask/base-data-service@1.0.0...@metamask/base-data-service@2.0.0
 [1.0.0]: https://github.com/MetaMask/core/compare/@metamask/base-data-service@0.1.3...@metamask/base-data-service@1.0.0
 [0.1.3]: https://github.com/MetaMask/core/compare/@metamask/base-data-service@0.1.2...@metamask/base-data-service@0.1.3

package/dist/BaseDataService.d.ts

@@ -2,9 +2,15 @@ import { Messenger, ActionConstraint, EventConstraint, MessengerActions, Messeng
 import type { StorageServiceGetItemAction, StorageServiceRemoveItemAction, StorageServiceSetItemAction } from '@metamask/storage-service';
 import { Struct } from '@metamask/superstruct';
 import type { Json } from '@metamask/utils';
-import { DefaultError, DehydratedState, FetchQueryOptions, InfiniteData, InfiniteQueryPageParamsOptions, InvalidateOptions, InvalidateQueryFilters, OmitKeyof, QueryClientConfig, QueryFunction, WithRequired } from '@tanstack/query-core';
+import { DefaultError, DehydratedState, FetchQueryOptions, InfiniteData, InfiniteQueryPageParamsOptions, CancelOptions, InvalidateOptions, InvalidateQueryFilters, MutationOptions, OmitKeyof, QueryClientConfig, QueryFilters, QueryFunction, WithRequired, MutationFunction } from '@tanstack/query-core';
 import { CreateServicePolicyOptions } from './createServicePolicy.js';
-export type QueryKey = [string, ...Json[]] | readonly [string, ...Json[]];
+/**
+ * Data service mutations and queries use the following format:
+ * `['${ServiceName}:${ActionName}', ...params]`
+ */
+type Key = [string, ...Json[]] | readonly [string, ...Json[]];
+export type QueryKey = Key;
+export type MutationKey = Key;
 /**
  * The supertype of all messengers, scoped to a namespace.
  *
@@ -13,12 +19,14 @@ export type QueryKey = [string, ...Json[]] | readonly [string, ...Json[]];
  */
 export type BaseMessenger<Namespace extends string> = Messenger<Namespace, ActionConstraint, EventConstraint, any>;
 export type DataServiceGranularCacheUpdatedPayload = {
+    objectType: 'query' | 'mutation';
+} & ({
     type: 'added' | 'updated';
     state: DehydratedState;
 } | {
     type: 'removed';
     state: null;
-};
+});
 export type DataServiceCacheUpdatedPayload = DataServiceGranularCacheUpdatedPayload & {
     hash: string;
 };
@@ -73,10 +81,11 @@ export declare class BaseDataService<ServiceName extends string, ServiceMessenge
      *
      * @param options - The options defining the query. Keep in mind that `queryKey` and `queryFn` are required when using data services.
      * 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.
      * @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>({ responseStruct, ...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;
     }): Promise<TData>;
@@ -93,6 +102,27 @@ export declare class BaseDataService<ServiceName extends string, ServiceMessenge
         queryFn: QueryFunction<TQueryFnData, TQueryKey, TPageParam>;
         responseStruct?: TDataStruct;
     }, pageParam?: TPageParam): Promise<TData>;
+    /**
+     * Execute a mutation (e.g. a request that is expected to change server-side data).
+     * Unlike `fetchQuery`, the request will not be cached or retried.
+     *
+     * @param options - The options defining the mutation. Keep in mind that `mutationKey` and `mutationFn` are required when using data services.
+     * Additionally, `retry` and `retryDelay` are not available.
+     * @param options.mutationFn - The mutation function.
+     * @param options.responseStruct - An optional struct for validating the response of the mutation function.
+     * @param options.globalId - A string which uniquely identifies this mutation
+     * between the query client in this data service
+     * and the one that `createUIQueryClient` in `@metamask/react-data-query` holds.
+     * This global ID will be stored in the `meta` data of the created mutation
+     * and included in `:cacheUpdated` payloads. Defaults to a UUID.
+     * @returns The mutation results.
+     */
+    protected executeMutation<TMutationFnData extends Json, TDataStruct extends Struct<TMutationFnData> | undefined = undefined, TData = TDataStruct extends Struct<infer StructType> ? StructType : TMutationFnData, TError = DefaultError, TOnMutateResult = unknown, TMutationKey extends MutationKey = MutationKey>({ mutationFn, responseStruct, globalId, ...options }: OmitKeyof<MutationOptions<TData, TError, Record<never, never>, TOnMutateResult>, 'retry' | 'retryDelay' | 'mutationKey' | 'mutationFn'> & {
+        mutationKey: TMutationKey;
+        mutationFn: MutationFunction<TMutationFnData, Record<never, never>>;
+        responseStruct?: TDataStruct;
+        globalId?: string;
+    }): Promise<TData>;
     /**
      * Invalidate queries serviced by this data service.
      *
@@ -101,6 +131,18 @@ export declare class BaseDataService<ServiceName extends string, ServiceMessenge
      * @returns Nothing.
      */
     invalidateQueries(filters?: InvalidateQueryFilters<QueryKey>, options?: InvalidateOptions): Promise<void>;
+    /**
+     * Cancel in-flight queries serviced by this data service.
+     *
+     * Use this in your subclass if you need to abort a concurrent fetch before
+     * starting a forced refresh (e.g. `Cache-Control: no-cache` reads), so a
+     * slower non-fresh request cannot overwrite the result.
+     *
+     * @param filters - Optional filter for selecting specific queries.
+     * @param cancelOptions - Optional options for cancelling the queries.
+     * @returns Nothing.
+     */
+    protected cancelQueries(filters?: QueryFilters<QueryKey>, cancelOptions?: CancelOptions): Promise<void>;
     /**
      * Initialize the service, rehydrating the cache with persisted data if possible.
      */

package/dist/BaseDataService.d.ts.map

@@ -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,iBAAiB,EACjB,sBAAsB,EACtB,SAAS,EAET,iBAAiB,EACjB,aAAa,EACb,YAAY,EAGb,MAAM,sBAAsB,CAAC;AAI9B,OAAO,EAEL,0BAA0B,EAE3B,MAAM,0BAA0B,CAAC;AAIlC,MAAM,MAAM,QAAQ,GAAG,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;AAE1E;;;;;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,GAC9C;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,CAAC;AAEN,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;AAUtD,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;IAYtC,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,EAoEA;IAED;;;;;;;OAOG;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,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,CAUjB;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;;;;;;OAMG;IACG,iBAAiB,CACrB,OAAO,CAAC,EAAE,sBAAsB,CAAC,QAAQ,CAAC,EAC1C,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,IAAI,CAAC,CAEf;IAED;;OAEG;IACH,IAAI,IAAI,IAAI,CAKX;IAED;;;OAGG;IACH,OAAO,IAAI,IAAI,CAMd;CAqGF"}
+{"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

@@ -1,15 +1,23 @@
 import { Duration, inMilliseconds } from '@metamask/utils';
-import { QueryClient, dehydrate, hydrate, } from '@tanstack/query-core';
+import { QueryClient, dehydrate, hydrate, hashKey, } from '@tanstack/query-core';
 import deepEqual from 'fast-deep-equal';
 import { debounce } from 'lodash-es';
+import { v4 as uuidV4 } from 'uuid';
 import { createServicePolicy, } from './createServicePolicy.js';
-import { processQueryResponse } from './utils.js';
-// Defaults to apply to all data service queries if no default option specified
+import { createModuleLogger, projectLogger } from './loggers.js';
+import { processMutationResponse, processQueryResponse } from './utils.js';
+const log = createModuleLogger(projectLogger, 'BaseDataService');
+/*
+ * Defaults to apply to all data service queries if no default option specified.
+ */
 const QUERY_CLIENT_DEFAULTS = {
     queries: {
         retry: false,
         staleTime: inMilliseconds(1, Duration.Minute),
     },
+    mutations: {
+        retry: false,
+    },
 };
 export const STORAGE_SERVICE_KEY = 'cache';
 export class BaseDataService {
@@ -20,6 +28,7 @@ export class BaseDataService {
     #policy;
     #queryClient;
     #queryCacheUnsubscribe;
+    #mutationCacheUnsubscribe;
     #debouncedPersist;
     #persistenceConfig;
     constructor({ name, messenger, queryClientConfig = {}, policyOptions, persistenceConfig, }) {
@@ -38,7 +47,10 @@ export class BaseDataService {
                     ...QUERY_CLIENT_DEFAULTS.queries,
                     ...queryClientConfig.defaultOptions?.queries,
                 },
-                mutations: queryClientConfig.defaultOptions?.mutations,
+                mutations: {
+                    ...QUERY_CLIENT_DEFAULTS.mutations,
+                    ...queryClientConfig.defaultOptions?.mutations,
+                },
             },
         });
         this.#persistenceConfig = persistenceConfig;
@@ -57,8 +69,21 @@ export class BaseDataService {
         this.#queryCacheUnsubscribe = this.#queryClient
             .getQueryCache()
             .subscribe((event) => {
+            log('Query cache event emitted', event);
             if (['added', 'updated', 'removed'].includes(event.type)) {
-                this.#publishCacheUpdate(event.query.queryHash, event.type);
+                this.#publishCacheUpdate('query', event.type, event.query.queryHash);
+                this.#debouncedPersist?.();
+            }
+        });
+        log('Subscribing to mutation cache');
+        this.#mutationCacheUnsubscribe = this.#queryClient
+            .getMutationCache()
+            .subscribe((event) => {
+            log('Mutation cache event emitted', event);
+            if (['added', 'updated', 'removed'].includes(event.type) &&
+                event.mutation?.options.mutationKey !== undefined) {
+                const mutationHash = hashKey(event.mutation.options.mutationKey);
+                this.#publishCacheUpdate('mutation', event.type, mutationHash);
                 this.#debouncedPersist?.();
             }
         });
@@ -69,14 +94,15 @@ export class BaseDataService {
      *
      * @param options - The options defining the query. Keep in mind that `queryKey` and `queryFn` are required when using data services.
      * 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.
      * @returns The query results.
      */
-    async fetchQuery({ responseStruct, ...options }) {
+    async fetchQuery({ queryFn, responseStruct, ...options }) {
         return this.#queryClient.fetchQuery({
             ...options,
             queryFn: async (context) => {
-                const response = await this.#policy.execute(() => options.queryFn(context));
+                const response = await this.#policy.execute(() => queryFn(context));
                 return processQueryResponse(options.queryKey, response, responseStruct);
             },
         });
@@ -116,6 +142,46 @@ export class BaseDataService {
         const pageIndex = result.pageParams.findIndex((param) => deepEqual(param, pageParam));
         return result.pages[pageIndex];
     }
+    /**
+     * Execute a mutation (e.g. a request that is expected to change server-side data).
+     * Unlike `fetchQuery`, the request will not be cached or retried.
+     *
+     * @param options - The options defining the mutation. Keep in mind that `mutationKey` and `mutationFn` are required when using data services.
+     * Additionally, `retry` and `retryDelay` are not available.
+     * @param options.mutationFn - The mutation function.
+     * @param options.responseStruct - An optional struct for validating the response of the mutation function.
+     * @param options.globalId - A string which uniquely identifies this mutation
+     * between the query client in this data service
+     * and the one that `createUIQueryClient` in `@metamask/react-data-query` holds.
+     * This global ID will be stored in the `meta` data of the created mutation
+     * and included in `:cacheUpdated` payloads. Defaults to a UUID.
+     * @returns The mutation results.
+     */
+    async executeMutation({ mutationFn, responseStruct, globalId = uuidV4(), ...options }) {
+        const mutationCache = this.#queryClient.getMutationCache();
+        const mutation = mutationCache.build(this.#queryClient, {
+            ...options,
+            meta: {
+                ...options.meta,
+                globalId,
+            },
+            mutationFn: async (...args) => {
+                // To guard against mutations being retried, we deliberately execute the
+                // mutation function through the circuit breaker policy alone, rather
+                // than through `this.#policy` (which is a combination of both a
+                // circuit breaker policy and retry policy).
+                const response = await this.#policy.circuitBreakerPolicy.execute(() => mutationFn(...args));
+                // Type assertion: TypeScript is not able to unify the type that this
+                // function returns with `TData` at compile-time. We can still typecheck
+                // the arguments, though.
+                return processMutationResponse(options.mutationKey, response, responseStruct);
+            },
+        });
+        // We purposely pass an empty set of variables because this method is
+        // intended to be used internally by the data service, not end users, and
+        // the data service has full control of `mutationFn` anyway.
+        return await mutation.execute({});
+    }
     /**
      * Invalidate queries serviced by this data service.
      *
@@ -126,6 +192,20 @@ export class BaseDataService {
     async invalidateQueries(filters, options) {
         return this.#queryClient.invalidateQueries(filters, options);
     }
+    /**
+     * Cancel in-flight queries serviced by this data service.
+     *
+     * Use this in your subclass if you need to abort a concurrent fetch before
+     * starting a forced refresh (e.g. `Cache-Control: no-cache` reads), so a
+     * slower non-fresh request cannot overwrite the result.
+     *
+     * @param filters - Optional filter for selecting specific queries.
+     * @param cancelOptions - Optional options for cancelling the queries.
+     * @returns Nothing.
+     */
+    async cancelQueries(filters, cancelOptions) {
+        await this.#queryClient.cancelQueries(filters, cancelOptions);
+    }
     /**
      * Initialize the service, rehydrating the cache with persisted data if possible.
      */
@@ -141,29 +221,43 @@ export class BaseDataService {
     destroy() {
         this.#debouncedPersist?.cancel();
         this.#queryCacheUnsubscribe();
+        this.#mutationCacheUnsubscribe();
+        // `QueryClient.clear()` clears both caches, but `MutationCache.clear()`
+        // only drops its references to mutations without clearing their pending
+        // garbage-collection timers. We destroy each mutation first so those timers
+        // are cleared and do not keep the process alive.
+        for (const mutation of this.#queryClient.getMutationCache().getAll()) {
+            mutation.destroy();
+        }
         this.#queryClient.clear();
         this.messenger.clearSubscriptions();
         this.messenger.clearActions();
     }
     /**
-     * Publish `cacheUpdated` events when a given query changes.
+     * Publish `cacheUpdated` events when the query or mutation cache is updated.
      *
-     * @param hash The hash of the query.
-     * @param type The type of cache update.
+     * @param objectType - The type of object updated ("query" or "mutation").
+     * @param eventType - What happened to the query or mutation ("added" or "updated").
+     * @param hash - The hash of the query or mutation.
      */
-    #publishCacheUpdate(hash, type) {
-        const state = type === 'added' || type === 'updated'
+    #publishCacheUpdate(objectType, eventType, hash) {
+        const state = eventType === 'added' || eventType === 'updated'
             ? dehydrate(this.#queryClient, {
-                shouldDehydrateQuery: (query) => query.queryHash === hash,
+                shouldDehydrateQuery: (query) => objectType === 'query' && query.queryHash === hash,
+                shouldDehydrateMutation: (mutation) => objectType === 'mutation' &&
+                    mutation.options.mutationKey !== undefined &&
+                    hashKey(mutation.options.mutationKey) === hash,
             })
             : null;
         this.#messenger.publish(`${this.name}:cacheUpdated`, {
-            type,
+            type: eventType,
+            objectType,
             hash,
             state,
         });
         this.#messenger.publish(`${this.name}:cacheUpdated:${hash}`, {
-            type,
+            type: eventType,
+            objectType,
             state,
         });
     }

package/dist/BaseDataService.js.map

@@ -1 +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,EAUL,WAAW,EAIX,SAAS,EACT,OAAO,GACR,MAAM,sBAAsB,CAAC;AAC9B,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,EAAE,QAAQ,EAAiB,MAAM,WAAW,CAAC;AAEpD,OAAO,EACL,mBAAmB,GAGpB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAiElD,+EAA+E;AAC/E,MAAM,qBAAqB,GAAmB;IAC5C,OAAO,EAAE;QACP,KAAK,EAAE,KAAK;QACZ,SAAS,EAAE,cAAc,CAAC,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC;KAC9C;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,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,iBAAiB,CAAC,cAAc,EAAE,SAAS;aACvD;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,IAAI,CAAC,OAAO,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;gBACzD,IAAI,CAAC,mBAAmB,CACtB,KAAK,CAAC,KAAK,CAAC,SAAS,EACrB,KAAK,CAAC,IAAwB,CAC/B,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;;;;;;;OAOG;IACO,KAAK,CAAC,UAAU,CAQxB,EACA,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,CAC/C,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CACzB,CAAC;gBACF,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;;;;;;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;;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,YAAY,CAAC,KAAK,EAAE,CAAC;QAC1B,IAAI,CAAC,SAAS,CAAC,kBAAkB,EAAE,CAAC;QACpC,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,CAAC;IAChC,CAAC;IAED;;;;;OAKG;IACH,mBAAmB,CAAC,IAAY,EAAE,IAAsB;QACtD,MAAM,KAAK,GACT,IAAI,KAAK,OAAO,IAAI,IAAI,KAAK,SAAS;YACpC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,EAAE;gBAC3B,oBAAoB,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,SAAS,KAAK,IAAI;aAC1D,CAAC;YACJ,CAAC,CAAC,IAAI,CAAC;QAEX,IAAI,CAAC,UAAU,CAAC,OAAO,CACrB,GAAG,IAAI,CAAC,IAAI,eAAwB,EACpC;YACE,IAAI;YACJ,IAAI;YACJ,KAAK;SAC4B,CACpC,CAAC;QAEF,IAAI,CAAC,UAAU,CAAC,OAAO,CACrB,GAAG,IAAI,CAAC,IAAI,iBAAiB,IAAI,EAAW,EAC5C;YACE,IAAI;YACJ,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  InvalidateOptions,\n  InvalidateQueryFilters,\n  OmitKeyof,\n  QueryClient,\n  QueryClientConfig,\n  QueryFunction,\n  WithRequired,\n  dehydrate,\n  hydrate,\n} from '@tanstack/query-core';\nimport deepEqual from 'fast-deep-equal';\nimport { debounce, DebouncedFunc } from 'lodash-es';\n\nimport {\n  createServicePolicy,\n  CreateServicePolicyOptions,\n  ServicePolicy,\n} from './createServicePolicy.js';\nimport { processQueryResponse } from './utils.js';\n\n// Data service queries use the following format: ['ServiceActionName', ...params]\nexport type QueryKey = [string, ...Json[]] | readonly [string, ...Json[]];\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  | { type: 'added' | 'updated'; state: DehydratedState }\n  | {\n      type: 'removed';\n      state: null;\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// Defaults to apply to all data service queries if no default option specified\nconst QUERY_CLIENT_DEFAULTS: DefaultOptions = {\n  queries: {\n    retry: false,\n    staleTime: inMilliseconds(1, Duration.Minute),\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 #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: queryClientConfig.defaultOptions?.mutations,\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        if (['added', 'updated', 'removed'].includes(event.type)) {\n          this.#publishCacheUpdate(\n            event.query.queryHash,\n            event.type as CacheUpdatedType,\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.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    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(() =>\n          options.queryFn(context),\n        );\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   * 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   * 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.#queryClient.clear();\n    this.messenger.clearSubscriptions();\n    this.messenger.clearActions();\n  }\n\n  /**\n   * Publish `cacheUpdated` events when a given query changes.\n   *\n   * @param hash The hash of the query.\n   * @param type The type of cache update.\n   */\n  #publishCacheUpdate(hash: string, type: CacheUpdatedType): void {\n    const state =\n      type === 'added' || type === 'updated'\n        ? dehydrate(this.#queryClient, {\n            shouldDehydrateQuery: (query) => query.queryHash === hash,\n          })\n        : null;\n\n    this.#messenger.publish(\n      `${this.name}:cacheUpdated` as const,\n      {\n        type,\n        hash,\n        state,\n      } as DataServiceCacheUpdatedPayload,\n    );\n\n    this.#messenger.publish(\n      `${this.name}:cacheUpdated:${hash}` as const,\n      {\n        type,\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"]}
+{"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

@@ -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 { DataServiceActions, DataServiceEvents, DataServiceCacheUpdatedPayload, DataServiceGranularCacheUpdatedPayload, DataServiceInvalidateQueriesAction, DataServiceCacheUpdatedEvent, DataServiceGranularCacheUpdatedEvent, QueryKey, 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

@@ -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,kBAAkB,EAClB,iBAAiB,EACjB,8BAA8B,EAC9B,sCAAsC,EACtC,kCAAkC,EAClC,4BAA4B,EAC5B,oCAAoC,EACpC,QAAQ,EACR,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"}
+{"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

@@ -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;AAanB,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  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"]}
+{"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/dist/loggers.d.ts

@@ -0,0 +1,4 @@
+import { createModuleLogger } from '@metamask/utils';
+export declare const projectLogger: import("debug").Debugger;
+export { createModuleLogger };
+//# sourceMappingURL=loggers.d.ts.map

package/dist/loggers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"loggers.d.ts","sourceRoot":"","sources":["../src/loggers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAuB,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAE1E,eAAO,MAAM,aAAa,0BAA2C,CAAC;AAEtE,OAAO,EAAE,kBAAkB,EAAE,CAAC"}

package/dist/loggers.js

@@ -0,0 +1,4 @@
+import { createProjectLogger, createModuleLogger } from '@metamask/utils';
+export const projectLogger = createProjectLogger('base-data-service');
+export { createModuleLogger };
+//# sourceMappingURL=loggers.js.map

package/dist/loggers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"loggers.js","sourceRoot":"","sources":["../src/loggers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAE1E,MAAM,CAAC,MAAM,aAAa,GAAG,mBAAmB,CAAC,mBAAmB,CAAC,CAAC;AAEtE,OAAO,EAAE,kBAAkB,EAAE,CAAC","sourcesContent":["import { createProjectLogger, createModuleLogger } from '@metamask/utils';\n\nexport const projectLogger = createProjectLogger('base-data-service');\n\nexport { createModuleLogger };\n"]}

package/dist/utils.d.ts

@@ -1,5 +1,5 @@
 import { Struct } from '@metamask/superstruct';
-import type { QueryKey } from './BaseDataService.js';
+import type { MutationKey, QueryKey } from './BaseDataService.js';
 /**
  * Process query responses, validating them using Superstruct if a struct is defined.
  *
@@ -10,4 +10,17 @@ import type { QueryKey } from './BaseDataService.js';
  * @throws If the query response does not match the struct.
  */
 export declare function processQueryResponse<Response>(queryKey: QueryKey, response: Response, struct?: Struct<Response>): Response;
+/**
+ * Process mutation responses, validating them using Superstruct if a struct is defined.
+ *
+ * @param mutationKey - The mutation key.
+ * @param response - The mutation response
+ * @param struct - The struct defining the schema for the mutation response.
+ * @returns The mutation response, coerced by Superstruct if needed.
+ * @throws If the mutation response does not match the struct.
+ * @template InputResponse - The type of the response data being validated, e.g. `Json`.
+ * @template ResponseStruct - The struct used to validate and decode the response,
+ * e.g. `Struct<FetchOrdersResponse>`, or `undefined` when no validation is needed.
+ */
+export declare function processMutationResponse<InputResponse, ResponseStruct extends Struct<any> | undefined = undefined>(mutationKey: MutationKey, response: InputResponse, struct?: ResponseStruct): ResponseStruct extends Struct<infer StructType> ? StructType : InputResponse;
 //# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAY,MAAM,uBAAuB,CAAC;AAEzD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAErD;;;;;;;;GAQG;AACH,wBAAgB,oBAAoB,CAAC,QAAQ,EAC3C,QAAQ,EAAE,QAAQ,EAClB,QAAQ,EAAE,QAAQ,EAClB,MAAM,CAAC,EAAE,MAAM,CAAC,QAAQ,CAAC,GACxB,QAAQ,CAcV"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAY,MAAM,uBAAuB,CAAC;AAEzD,OAAO,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAElE;;;;;;;;GAQG;AACH,wBAAgB,oBAAoB,CAAC,QAAQ,EAC3C,QAAQ,EAAE,QAAQ,EAClB,QAAQ,EAAE,QAAQ,EAClB,MAAM,CAAC,EAAE,MAAM,CAAC,QAAQ,CAAC,GACxB,QAAQ,CAcV;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,uBAAuB,CACrC,aAAa,EAOb,cAAc,SAAS,MAAM,CAAC,GAAG,CAAC,GAAG,SAAS,GAAG,SAAS,EAE1D,WAAW,EAAE,WAAW,EACxB,QAAQ,EAAE,aAAa,EACvB,MAAM,CAAC,EAAE,cAAc,GAGtB,cAAc,SAAS,MAAM,CAAC,MAAM,UAAU,CAAC,GAC9C,UAAU,GACV,aAAa,CA6BhB"}

package/dist/utils.js

@@ -18,4 +18,34 @@ export function processQueryResponse(queryKey, response, struct) {
     }
     return result;
 }
+/**
+ * Process mutation responses, validating them using Superstruct if a struct is defined.
+ *
+ * @param mutationKey - The mutation key.
+ * @param response - The mutation response
+ * @param struct - The struct defining the schema for the mutation response.
+ * @returns The mutation response, coerced by Superstruct if needed.
+ * @throws If the mutation response does not match the struct.
+ * @template InputResponse - The type of the response data being validated, e.g. `Json`.
+ * @template ResponseStruct - The struct used to validate and decode the response,
+ * e.g. `Struct<FetchOrdersResponse>`, or `undefined` when no validation is needed.
+ */
+export function processMutationResponse(mutationKey, response, struct) {
+    if (!struct) {
+        // Type assertion: TypeScript cannot "see" that when `struct` is
+        // `undefined`, `response` satisfies the `InputResponse` branch of
+        // `Response` (even though we stated this fact in the conditional type
+        // above). This is because at this point in time, `ResponseStruct` — being a
+        // generic — is unresolved, which makes `Response` unresolved too. This is a
+        // limitation of the way that generics work. Therefore, we need to help
+        // TypeScript out.
+        return response;
+    }
+    const [error, result] = validate(response, struct);
+    if (error) {
+        throw new Error(`Mutation function for "${mutationKey[0]}" returned an unexpected response: ${error.message}.`);
+    }
+    // Type assertion: See above.
+    return result;
+}
 //# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAIzD;;;;;;;;GAQG;AACH,MAAM,UAAU,oBAAoB,CAClC,QAAkB,EAClB,QAAkB,EAClB,MAAyB;IAEzB,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAEnD,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CACb,uBAAuB,QAAQ,CAAC,CAAC,CAAC,sCAAsC,KAAK,CAAC,OAAO,GAAG,CACzF,CAAC;IACJ,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC","sourcesContent":["import { Struct, validate } from '@metamask/superstruct';\n\nimport type { QueryKey } from './BaseDataService.js';\n\n/**\n * Process query responses, validating them using Superstruct if a struct is defined.\n *\n * @param queryKey - The query key.\n * @param response - The query response\n * @param struct - The struct defining the schema for the query response.\n * @returns The query response, coerced by Superstruct if needed.\n * @throws If the query response does not match the struct.\n */\nexport function processQueryResponse<Response>(\n  queryKey: QueryKey,\n  response: Response,\n  struct?: Struct<Response>,\n): Response {\n  if (!struct) {\n    return response;\n  }\n\n  const [error, result] = validate(response, struct);\n\n  if (error) {\n    throw new Error(\n      `Query function for \"${queryKey[0]}\" returned an unexpected response: ${error.message}.`,\n    );\n  }\n\n  return result;\n}\n"]}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAIzD;;;;;;;;GAQG;AACH,MAAM,UAAU,oBAAoB,CAClC,QAAkB,EAClB,QAAkB,EAClB,MAAyB;IAEzB,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAEnD,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CACb,uBAAuB,QAAQ,CAAC,CAAC,CAAC,sCAAsC,KAAK,CAAC,OAAO,GAAG,CACzF,CAAC;IACJ,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,uBAAuB,CAUrC,WAAwB,EACxB,QAAuB,EACvB,MAAuB;IAavB,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,gEAAgE;QAChE,kEAAkE;QAClE,sEAAsE;QACtE,4EAA4E;QAC5E,4EAA4E;QAC5E,uEAAuE;QACvE,kBAAkB;QAClB,OAAO,QAA+B,CAAC;IACzC,CAAC;IAED,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAEnD,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CACb,0BAA0B,WAAW,CAAC,CAAC,CAAC,sCAAsC,KAAK,CAAC,OAAO,GAAG,CAC/F,CAAC;IACJ,CAAC;IAED,6BAA6B;IAC7B,OAAO,MAAM,CAAC;AAChB,CAAC","sourcesContent":["import { Struct, validate } from '@metamask/superstruct';\n\nimport type { MutationKey, QueryKey } from './BaseDataService.js';\n\n/**\n * Process query responses, validating them using Superstruct if a struct is defined.\n *\n * @param queryKey - The query key.\n * @param response - The query response\n * @param struct - The struct defining the schema for the query response.\n * @returns The query response, coerced by Superstruct if needed.\n * @throws If the query response does not match the struct.\n */\nexport function processQueryResponse<Response>(\n  queryKey: QueryKey,\n  response: Response,\n  struct?: Struct<Response>,\n): Response {\n  if (!struct) {\n    return response;\n  }\n\n  const [error, result] = validate(response, struct);\n\n  if (error) {\n    throw new Error(\n      `Query function for \"${queryKey[0]}\" returned an unexpected response: ${error.message}.`,\n    );\n  }\n\n  return result;\n}\n\n/**\n * Process mutation responses, validating them using Superstruct if a struct is defined.\n *\n * @param mutationKey - The mutation key.\n * @param response - The mutation response\n * @param struct - The struct defining the schema for the mutation response.\n * @returns The mutation response, coerced by Superstruct if needed.\n * @throws If the mutation response does not match the struct.\n * @template InputResponse - The type of the response data being validated, e.g. `Json`.\n * @template ResponseStruct - The struct used to validate and decode the response,\n * e.g. `Struct<FetchOrdersResponse>`, or `undefined` when no validation is needed.\n */\nexport function processMutationResponse<\n  InputResponse,\n  // We have to use `Struct<any>` here, as using `Struct<InputResponse>` (or\n  // even `Struct<unknown>`) would reject a more concrete, \"real world\" struct.\n  // The reason is that `Struct` is an object type with methods whose signatures\n  // feature the struct's content type, making `Struct` contravariant in its\n  // content type. The only way to get around this is to use `any`.\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  ResponseStruct extends Struct<any> | undefined = undefined,\n>(\n  mutationKey: MutationKey,\n  response: InputResponse,\n  struct?: ResponseStruct,\n  // We don't want this to be a type parameter as it should not be customizable\n  // (it is only derived).\n): ResponseStruct extends Struct<infer StructType>\n  ? StructType\n  : InputResponse {\n  // Because we aren't defining the return type as a type parameter,\n  // we need to restate it so we can reuse it below.\n  type Response =\n    ResponseStruct extends Struct<infer StructType>\n      ? StructType\n      : InputResponse;\n\n  if (!struct) {\n    // Type assertion: TypeScript cannot \"see\" that when `struct` is\n    // `undefined`, `response` satisfies the `InputResponse` branch of\n    // `Response` (even though we stated this fact in the conditional type\n    // above). This is because at this point in time, `ResponseStruct` — being a\n    // generic — is unresolved, which makes `Response` unresolved too. This is a\n    // limitation of the way that generics work. Therefore, we need to help\n    // TypeScript out.\n    return response as unknown as Response;\n  }\n\n  const [error, result] = validate(response, struct);\n\n  if (error) {\n    throw new Error(\n      `Mutation function for \"${mutationKey[0]}\" returned an unexpected response: ${error.message}.`,\n    );\n  }\n\n  // Type assertion: See above.\n  return result;\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/base-data-service",
-  "version": "2.0.0-preview-0a1dd02ad",
+  "version": "2.1.0-preview-452564c37",
   "description": "Provides utilities for building data services",
   "keywords": [
     "Ethereum",
@@ -55,22 +55,23 @@
     "@metamask/storage-service": "^2.0.0",
     "@metamask/superstruct": "^3.4.1",
     "@metamask/utils": "^12.0.0",
-    "@tanstack/query-core": "^5.62.16",
-    "cockatiel": "^3.1.2",
+    "@tanstack/query-core": "^5.89.0",
+    "cockatiel": "^3.2.1",
     "fast-deep-equal": "^3.1.3",
-    "lodash-es": "^4.17.21"
+    "lodash-es": "^4.18.1",
+    "uuid": "^11.1.1"
   },
   "devDependencies": {
-    "@metamask/auto-changelog": "^6.1.0",
+    "@metamask/auto-changelog": "^6.2.1",
     "@types/jest": "^30.0.0",
     "@types/lodash-es": "^4.17.12",
     "@typescript/native": "npm:typescript@^7.0.2",
-    "deepmerge": "^4.2.2",
+    "deepmerge": "^4.3.1",
     "jest": "^30.4.2",
-    "nock": "^13.3.1",
-    "rimraf": "^5.0.5",
-    "ts-jest": "^29.4.11",
-    "tsx": "^4.20.5",
+    "nock": "^13.5.6",
+    "rimraf": "^6.1.3",
+    "ts-jest": "^29.4.12",
+    "tsx": "^4.23.15",
     "typedoc": "^0.25.13",
     "typedoc-plugin-missing-exports": "^2.0.0",
     "typescript": "npm:@typescript/typescript6@^6.0.2"