@metamask-previews/base-data-service 0.1.3-preview-72f0609be → 0.1.3-preview-6756b9ebc

package/CHANGELOG.md

@@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- Add support for cache persistence ([#9445](https://github.com/MetaMask/core/pull/9445))
+  - Persistence can be configured by passing a `persistenceConfig` option to the constructor.
 - Add `createServicePolicy` and related symbols, copied from `@metamask/controller-utils` ([#9418](https://github.com/MetaMask/core/pull/9418))
   - Added functions:
     `createServicePolicy`

package/dist/BaseDataService.cjs

@@ -13,13 +13,14 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-var _BaseDataService_instances, _BaseDataService_messenger, _BaseDataService_policy, _BaseDataService_queryClient, _BaseDataService_queryCacheUnsubscribe, _BaseDataService_publishCacheUpdate;
+var _BaseDataService_instances, _BaseDataService_messenger, _BaseDataService_externalMessenger, _BaseDataService_policy, _BaseDataService_queryClient, _BaseDataService_queryCacheUnsubscribe, _BaseDataService_debouncedPersist, _BaseDataService_persistenceConfig, _BaseDataService_publishCacheUpdate, _BaseDataService_persistCache, _BaseDataService_loadCache;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BaseDataService = void 0;
+exports.BaseDataService = exports.STORAGE_SERVICE_KEY = void 0;
 const messenger_1 = require("@metamask/messenger");
 const utils_1 = require("@metamask/utils");
 const query_core_1 = require("@tanstack/query-core");
 const fast_deep_equal_1 = __importDefault(require("fast-deep-equal"));
+const lodash_1 = require("lodash");
 const createServicePolicy_1 = require("./createServicePolicy.cjs");
 // Defaults to apply to all data service queries if no default option specified
 const QUERY_CLIENT_DEFAULTS = {
@@ -28,17 +29,24 @@ const QUERY_CLIENT_DEFAULTS = {
         staleTime: (0, utils_1.inMilliseconds)(1, utils_1.Duration.Minute),
     },
 };
+exports.STORAGE_SERVICE_KEY = 'cache';
 class BaseDataService {
-    constructor({ name, messenger, queryClientConfig = {}, policyOptions, }) {
+    constructor({ name, messenger, queryClientConfig = {}, policyOptions, persistenceConfig, }) {
         _BaseDataService_instances.add(this);
         _BaseDataService_messenger.set(this, void 0);
+        _BaseDataService_externalMessenger.set(this, void 0);
         _BaseDataService_policy.set(this, void 0);
         _BaseDataService_queryClient.set(this, void 0);
         _BaseDataService_queryCacheUnsubscribe.set(this, void 0);
+        _BaseDataService_debouncedPersist.set(this, void 0);
+        _BaseDataService_persistenceConfig.set(this, void 0);
         this.name = name;
-        // We are storing a separately typed messenger for known actions and events provided by data services
-        // and a generic public one that is typed using the generic parameters and accessible to implementations.
+        // We store two narrowly-typed messengers alongside the generic public one:
+        // - #messenger handles the service's own action registration and event publishing
+        // - #externalMessenger handles calls to external actions
+        // Splitting them avoids TypeScript issues with mixing template-literals with regular strings
         __classPrivateFieldSet(this, _BaseDataService_messenger, messenger, "f");
+        __classPrivateFieldSet(this, _BaseDataService_externalMessenger, messenger, "f");
         this.messenger = messenger;
         __classPrivateFieldSet(this, _BaseDataService_queryClient, new query_core_1.QueryClient({
             ...queryClientConfig,
@@ -50,12 +58,24 @@ class BaseDataService {
                 mutations: queryClientConfig.defaultOptions?.mutations,
             },
         }), "f");
+        __classPrivateFieldSet(this, _BaseDataService_persistenceConfig, persistenceConfig, "f");
         __classPrivateFieldSet(this, _BaseDataService_policy, (0, createServicePolicy_1.createServicePolicy)(policyOptions), "f");
+        __classPrivateFieldSet(this, _BaseDataService_debouncedPersist, __classPrivateFieldGet(this, _BaseDataService_persistenceConfig, "f") &&
+            (0, lodash_1.debounce)(() => {
+                __classPrivateFieldGet(this, _BaseDataService_instances, "m", _BaseDataService_persistCache).call(this).catch(
+                /* istanbul ignore next */
+                (error) => __classPrivateFieldGet(this, _BaseDataService_messenger, "f").captureException?.(error));
+            }, __classPrivateFieldGet(this, _BaseDataService_persistenceConfig, "f").writeDelay ??
+                (0, utils_1.inMilliseconds)(10, utils_1.Duration.Second), {
+                maxWait: __classPrivateFieldGet(this, _BaseDataService_persistenceConfig, "f").maxWriteDelay ??
+                    (0, utils_1.inMilliseconds)(1, utils_1.Duration.Minute),
+            }), "f");
         __classPrivateFieldSet(this, _BaseDataService_queryCacheUnsubscribe, __classPrivateFieldGet(this, _BaseDataService_queryClient, "f")
             .getQueryCache()
             .subscribe((event) => {
             if (['added', 'updated', 'removed'].includes(event.type)) {
                 __classPrivateFieldGet(this, _BaseDataService_instances, "m", _BaseDataService_publishCacheUpdate).call(this, event.query.queryHash, event.type);
+                __classPrivateFieldGet(this, _BaseDataService_debouncedPersist, "f")?.call(this);
             }
         }), "f");
         __classPrivateFieldGet(this, _BaseDataService_messenger, "f").registerActionHandler(`${this.name}:invalidateQueries`, this.invalidateQueries.bind(this));
@@ -120,11 +140,20 @@ class BaseDataService {
     async invalidateQueries(filters, options) {
         return __classPrivateFieldGet(this, _BaseDataService_queryClient, "f").invalidateQueries(filters, options);
     }
+    /**
+     * Initialize the service, rehydrating the cache with persisted data if possible.
+     */
+    init() {
+        __classPrivateFieldGet(this, _BaseDataService_instances, "m", _BaseDataService_loadCache).call(this).catch(
+        /* istanbul ignore next */
+        (error) => __classPrivateFieldGet(this, _BaseDataService_messenger, "f").captureException?.(error));
+    }
     /**
      * Prepares the service for garbage collection. This should be extended
      * by any subclasses to clean up any additional connections or events.
      */
     destroy() {
+        __classPrivateFieldGet(this, _BaseDataService_debouncedPersist, "f")?.cancel();
         __classPrivateFieldGet(this, _BaseDataService_queryCacheUnsubscribe, "f").call(this);
         __classPrivateFieldGet(this, _BaseDataService_queryClient, "f").clear();
         this.messenger.clearSubscriptions();
@@ -132,7 +161,7 @@ class BaseDataService {
     }
 }
 exports.BaseDataService = BaseDataService;
-_BaseDataService_messenger = new WeakMap(), _BaseDataService_policy = new WeakMap(), _BaseDataService_queryClient = new WeakMap(), _BaseDataService_queryCacheUnsubscribe = new WeakMap(), _BaseDataService_instances = new WeakSet(), _BaseDataService_publishCacheUpdate = function _BaseDataService_publishCacheUpdate(hash, type) {
+_BaseDataService_messenger = new WeakMap(), _BaseDataService_externalMessenger = new WeakMap(), _BaseDataService_policy = new WeakMap(), _BaseDataService_queryClient = new WeakMap(), _BaseDataService_queryCacheUnsubscribe = new WeakMap(), _BaseDataService_debouncedPersist = new WeakMap(), _BaseDataService_persistenceConfig = new WeakMap(), _BaseDataService_instances = new WeakSet(), _BaseDataService_publishCacheUpdate = function _BaseDataService_publishCacheUpdate(hash, type) {
     const state = type === 'added' || type === 'updated'
         ? (0, query_core_1.dehydrate)(__classPrivateFieldGet(this, _BaseDataService_queryClient, "f"), {
             shouldDehydrateQuery: (query) => query.queryHash === hash,
@@ -147,5 +176,46 @@ _BaseDataService_messenger = new WeakMap(), _BaseDataService_policy = new WeakMa
         type,
         state,
     });
+}, _BaseDataService_persistCache = 
+/**
+ * Persist the query client cache using the StorageService, if the cache is not empty.
+ *
+ * @returns Nothing.
+ */
+async function _BaseDataService_persistCache() {
+    const state = (0, query_core_1.dehydrate)(__classPrivateFieldGet(this, _BaseDataService_queryClient, "f"), {
+        // This is the default, but we specify it to be explicit.
+        shouldDehydrateQuery: (query) => query.state.status === 'success',
+    });
+    if (state.queries.length === 0 && state.mutations.length === 0) {
+        await __classPrivateFieldGet(this, _BaseDataService_externalMessenger, "f").call('StorageService:removeItem', this.name, exports.STORAGE_SERVICE_KEY);
+        return;
+    }
+    const cache = {
+        timestamp: Date.now(),
+        state,
+    };
+    await __classPrivateFieldGet(this, _BaseDataService_externalMessenger, "f").call('StorageService:setItem', this.name, exports.STORAGE_SERVICE_KEY, cache);
+}, _BaseDataService_loadCache = 
+/**
+ * Load the query client cache from the StorageService, if persistence is configured
+ * and the persisted cache is not expired.
+ *
+ * @returns Nothing.
+ */
+async function _BaseDataService_loadCache() {
+    if (!__classPrivateFieldGet(this, _BaseDataService_persistenceConfig, "f")) {
+        return;
+    }
+    const { result: untypedCache } = await __classPrivateFieldGet(this, _BaseDataService_externalMessenger, "f").call('StorageService:getItem', this.name, exports.STORAGE_SERVICE_KEY);
+    if (!untypedCache) {
+        return;
+    }
+    const cache = untypedCache;
+    if (Date.now() - cache.timestamp >= __classPrivateFieldGet(this, _BaseDataService_persistenceConfig, "f").maxAge) {
+        await __classPrivateFieldGet(this, _BaseDataService_externalMessenger, "f").call('StorageService:removeItem', this.name, exports.STORAGE_SERVICE_KEY);
+        return;
+    }
+    (0, query_core_1.hydrate)(__classPrivateFieldGet(this, _BaseDataService_queryClient, "f"), cache.state);
 };
 //# sourceMappingURL=BaseDataService.cjs.map

package/dist/BaseDataService.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"BaseDataService.cjs","sourceRoot":"","sources":["../src/BaseDataService.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,mDAI6B;AAC7B,2CAA2D;AAE3D,qDAa8B;AAC9B,sEAAwC;AAExC,mEAI+B;AA4C/B,+EAA+E;AAC/E,MAAM,qBAAqB,GAAmB;IAC5C,OAAO,EAAE;QACP,KAAK,EAAE,KAAK;QACZ,SAAS,EAAE,IAAA,sBAAc,EAAC,CAAC,EAAE,gBAAQ,CAAC,MAAM,CAAC;KAC9C;CACF,CAAC;AAEF,MAAa,eAAe;IA4B1B,YAAY,EACV,IAAI,EACJ,SAAS,EACT,iBAAiB,GAAG,EAAE,EACtB,aAAa,GAMd;;QAxBQ,6CAIP;QAIO,0CAAuB;QAEvB,+CAA0B;QAE1B,yDAAmC;QAa1C,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QAEjB,qGAAqG;QACrG,yGAAyG;QACzG,uBAAA,IAAI,8BAAc,SAIjB,MAAA,CAAC;QACF,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAE3B,uBAAA,IAAI,gCAAgB,IAAI,wBAAW,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,MAAA,CAAC;QAEH,uBAAA,IAAI,2BAAW,IAAA,yCAAmB,EAAC,aAAa,CAAC,MAAA,CAAC;QAElD,uBAAA,IAAI,0CAA0B,uBAAA,IAAI,oCAAa;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,uBAAA,IAAI,uEAAoB,MAAxB,IAAI,EACF,KAAK,CAAC,KAAK,CAAC,SAAS,EACrB,KAAK,CAAC,IAAwB,CAC/B,CAAC;YACJ,CAAC;QACH,CAAC,CAAC,MAAA,CAAC;QAEL,uBAAA,IAAI,kCAAW,CAAC,qBAAqB,CACnC,GAAG,IAAI,CAAC,IAAI,oBAAoB,EAChC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAClC,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACO,KAAK,CAAC,UAAU,CAMxB,OAMC;QAED,OAAO,uBAAA,IAAI,oCAAa,CAAC,UAAU,CAAC;YAClC,GAAG,OAAO;YACV,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,CACnB,uBAAA,IAAI,+BAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;SACvD,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACO,KAAK,CAAC,kBAAkB,CAOhC,OAMC,EACD,SAAsB;QAEtB,MAAM,KAAK,GAAG,uBAAA,IAAI,oCAAa,CAAC,aAAa,EAAE,CAAC;QAEhD,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAA4C;YAClE,QAAQ,EAAE,OAAO,CAAC,QAAQ;SAC3B,CAAC,CAAC;QAEH,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAClD,MAAM,MAAM,GAAG,MAAM,uBAAA,IAAI,oCAAa,CAAC,kBAAkB,CAAC;gBACxD,GAAG,OAAO;gBACV,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,CACnB,uBAAA,IAAI,+BAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,CACxB,OAAO,CAAC,OAAO,CAAC;oBACd,GAAG,OAAO;oBACV,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,SAAS;iBAC1C,CAAC,CACH;aACJ,CAAC,CAAC;YAEH,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACzB,CAAC;QAED,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC;QACnC,MAAM,QAAQ,GAAG,OAAO,CAAC,oBAAoB,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;QAEjE,MAAM,SAAS,GAAG,IAAA,yBAAS,EAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;QAE1E,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,KAAK,CAAC,SAAS,EAAE;YAC1C,IAAI,EAAE;gBACJ,SAAS,EAAE;oBACT,SAAS;oBACT,SAAS;iBACV;aACF;SACF,CAAC,CAAC;QAEH,MAAM,SAAS,GAAG,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CACtD,IAAA,yBAAS,EAAC,KAAK,EAAE,SAAS,CAAC,CAC5B,CAAC;QAEF,OAAO,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAA2C,EAC3C,OAA2B;QAE3B,OAAO,uBAAA,IAAI,oCAAa,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED;;;OAGG;IACH,OAAO;QACL,uBAAA,IAAI,8CAAuB,MAA3B,IAAI,CAAyB,CAAC;QAC9B,uBAAA,IAAI,oCAAa,CAAC,KAAK,EAAE,CAAC;QAC1B,IAAI,CAAC,SAAS,CAAC,kBAAkB,EAAE,CAAC;QACpC,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,CAAC;IAChC,CAAC;CAiCF;AAtOD,0CAsOC;0TAzBqB,IAAY,EAAE,IAAsB;IACtD,MAAM,KAAK,GACT,IAAI,KAAK,OAAO,IAAI,IAAI,KAAK,SAAS;QACpC,CAAC,CAAC,IAAA,sBAAS,EAAC,uBAAA,IAAI,oCAAa,EAAE;YAC3B,oBAAoB,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,SAAS,KAAK,IAAI;SAC1D,CAAC;QACJ,CAAC,CAAC,IAAI,CAAC;IAEX,uBAAA,IAAI,kCAAW,CAAC,OAAO,CACrB,GAAG,IAAI,CAAC,IAAI,eAAwB,EACpC;QACE,IAAI;QACJ,IAAI;QACJ,KAAK;KAC4B,CACpC,CAAC;IAEF,uBAAA,IAAI,kCAAW,CAAC,OAAO,CACrB,GAAG,IAAI,CAAC,IAAI,iBAAiB,IAAI,EAAW,EAC5C;QACE,IAAI;QACJ,KAAK;KACoC,CAC5C,CAAC;AACJ,CAAC","sourcesContent":["import {\n  Messenger,\n  ActionConstraint,\n  EventConstraint,\n} from '@metamask/messenger';\nimport { Duration, inMilliseconds } from '@metamask/utils';\nimport type { Json } from '@metamask/utils';\nimport {\n  DefaultOptions,\n  DehydratedState,\n  FetchInfiniteQueryOptions,\n  FetchQueryOptions,\n  InfiniteData,\n  InvalidateOptions,\n  InvalidateQueryFilters,\n  OmitKeyof,\n  QueryClient,\n  QueryClientConfig,\n  WithRequired,\n  dehydrate,\n} from '@tanstack/query-core';\nimport deepEqual from 'fast-deep-equal';\n\nimport {\n  createServicePolicy,\n  CreateServicePolicyOptions,\n  ServicePolicy,\n} from './createServicePolicy';\n\n// Data service queries use the following format: ['ServiceActionName', ...params]\nexport type QueryKey = [string, ...Json[]];\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: (\n    filters?: InvalidateQueryFilters<Json>,\n    options?: InvalidateOptions,\n  ) => Promise<void>;\n};\n\ntype DataServiceActions<ServiceName extends string> =\n  DataServiceInvalidateQueriesAction<ServiceName>;\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\ntype 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 class BaseDataService<\n  ServiceName extends string,\n  ServiceMessenger extends Messenger<\n    ServiceName,\n    ActionConstraint,\n    EventConstraint,\n    // Use `any` to allow any parent to be set. `any` is harmless in a type constraint anyway,\n    // it's the one totally safe place to use it.\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    any\n  >,\n> {\n  public readonly name: ServiceName;\n\n  readonly #messenger: Messenger<\n    ServiceName,\n    DataServiceActions<ServiceName>,\n    DataServiceEvents<ServiceName>\n  >;\n\n  protected messenger: ServiceMessenger;\n\n  readonly #policy: ServicePolicy;\n\n  readonly #queryClient: QueryClient;\n\n  readonly #queryCacheUnsubscribe: () => void;\n\n  constructor({\n    name,\n    messenger,\n    queryClientConfig = {},\n    policyOptions,\n  }: {\n    name: ServiceName;\n    messenger: ServiceMessenger;\n    queryClientConfig?: QueryClientConfig;\n    policyOptions?: CreateServicePolicyOptions;\n  }) {\n    this.name = name;\n\n    // We are storing a separately typed messenger for known actions and events provided by data services\n    // and a generic public one that is typed using the generic parameters and accessible to implementations.\n    this.#messenger = messenger as unknown as Messenger<\n      ServiceName,\n      DataServiceActions<ServiceName>,\n      DataServiceEvents<ServiceName>\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.#policy = createServicePolicy(policyOptions);\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      });\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   * @returns The query results.\n   */\n  protected async fetchQuery<\n    TQueryFnData extends Json,\n    TError = unknown,\n    TData = TQueryFnData,\n    TQueryKey extends QueryKey = QueryKey,\n  >(\n    options: WithRequired<\n      OmitKeyof<\n        FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n        'retry' | 'retryDelay'\n      >,\n      'queryKey' | 'queryFn'\n    >,\n  ): Promise<TData> {\n    return this.#queryClient.fetchQuery({\n      ...options,\n      queryFn: (context) =>\n        this.#policy.execute(() => options.queryFn(context)),\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 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 = unknown,\n    TData extends TQueryFnData = TQueryFnData,\n    TQueryKey extends QueryKey = QueryKey,\n    TPageParam extends Json = Json,\n  >(\n    options: WithRequired<\n      OmitKeyof<\n        FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n        'retry' | 'retryDelay'\n      >,\n      'queryKey' | 'queryFn'\n    >,\n    pageParam?: TPageParam,\n  ): Promise<TData> {\n    const cache = this.#queryClient.getQueryCache();\n\n    const query = cache.find<TQueryFnData, TError, InfiniteData<TData>>({\n      queryKey: options.queryKey,\n    });\n\n    if (!query?.state.data || pageParam === undefined) {\n      const result = await this.#queryClient.fetchInfiniteQuery({\n        ...options,\n        queryFn: (context) =>\n          this.#policy.execute(() =>\n            options.queryFn({\n              ...context,\n              pageParam: context.pageParam ?? pageParam,\n            }),\n          ),\n      });\n\n      return result.pages[0];\n    }\n\n    const { pages } = query.state.data;\n    const previous = options.getPreviousPageParam?.(pages[0], pages);\n\n    const direction = deepEqual(pageParam, previous) ? 'backward' : 'forward';\n\n    const result = await query.fetch(undefined, {\n      meta: {\n        fetchMore: {\n          direction,\n          pageParam,\n        },\n      },\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<TPageData extends Json>(\n    filters?: InvalidateQueryFilters<TPageData>,\n    options?: InvalidateOptions,\n  ): Promise<void> {\n    return this.#queryClient.invalidateQueries(filters, options);\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.#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"]}
+{"version":3,"file":"BaseDataService.cjs","sourceRoot":"","sources":["../src/BaseDataService.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,mDAI6B;AAM7B,2CAA2D;AAE3D,qDAc8B;AAC9B,sEAAwC;AACxC,mCAAiD;AAEjD,mEAI+B;AAiD/B,+EAA+E;AAC/E,MAAM,qBAAqB,GAAmB;IAC5C,OAAO,EAAE;QACP,KAAK,EAAE,KAAK;QACZ,SAAS,EAAE,IAAA,sBAAc,EAAC,CAAC,EAAE,gBAAQ,CAAC,MAAM,CAAC;KAC9C;CACF,CAAC;AAEW,QAAA,mBAAmB,GAAG,OAAO,CAAC;AA2B3C,MAAa,eAAe;IAqC1B,YAAY,EACV,IAAI,EACJ,SAAS,EACT,iBAAiB,GAAG,EAAE,EACtB,aAAa,EACb,iBAAiB,GAOlB;;QAnCQ,6CAIP;QAEO,qDAGP;QAIO,0CAAuB;QAEvB,+CAA0B;QAE1B,yDAAmC;QAEnC,oDAA8C;QAE9C,qDAA8C;QAerD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QAEjB,2EAA2E;QAC3E,kFAAkF;QAClF,yDAAyD;QACzD,6FAA6F;QAC7F,uBAAA,IAAI,8BAAc,SAIjB,MAAA,CAAC;QACF,uBAAA,IAAI,sCAAsB,SAGzB,MAAA,CAAC;QACF,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAE3B,uBAAA,IAAI,gCAAgB,IAAI,wBAAW,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,MAAA,CAAC;QAEH,uBAAA,IAAI,sCAAsB,iBAAiB,MAAA,CAAC;QAE5C,uBAAA,IAAI,2BAAW,IAAA,yCAAmB,EAAC,aAAa,CAAC,MAAA,CAAC;QAElD,uBAAA,IAAI,qCACF,uBAAA,IAAI,0CAAmB;YACvB,IAAA,iBAAQ,EACN,GAAG,EAAE;gBACH,uBAAA,IAAI,iEAAc,MAAlB,IAAI,CAAgB,CAAC,KAAK;gBACxB,0BAA0B;gBAC1B,CAAC,KAAK,EAAE,EAAE,CAAC,uBAAA,IAAI,kCAAW,CAAC,gBAAgB,EAAE,CAAC,KAAK,CAAC,CACrD,CAAC;YACJ,CAAC,EACD,uBAAA,IAAI,0CAAmB,CAAC,UAAU;gBAChC,IAAA,sBAAc,EAAC,EAAE,EAAE,gBAAQ,CAAC,MAAM,CAAC,EACrC;gBACE,OAAO,EACL,uBAAA,IAAI,0CAAmB,CAAC,aAAa;oBACrC,IAAA,sBAAc,EAAC,CAAC,EAAE,gBAAQ,CAAC,MAAM,CAAC;aACrC,CACF,MAAA,CAAC;QAEJ,uBAAA,IAAI,0CAA0B,uBAAA,IAAI,oCAAa;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,uBAAA,IAAI,uEAAoB,MAAxB,IAAI,EACF,KAAK,CAAC,KAAK,CAAC,SAAS,EACrB,KAAK,CAAC,IAAwB,CAC/B,CAAC;gBAEF,uBAAA,IAAI,yCAAkB,EAAE,KAAxB,IAAI,CAAsB,CAAC;YAC7B,CAAC;QACH,CAAC,CAAC,MAAA,CAAC;QAEL,uBAAA,IAAI,kCAAW,CAAC,qBAAqB,CACnC,GAAG,IAAI,CAAC,IAAI,oBAAoB,EAChC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAClC,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACO,KAAK,CAAC,UAAU,CAMxB,OAMC;QAED,OAAO,uBAAA,IAAI,oCAAa,CAAC,UAAU,CAAC;YAClC,GAAG,OAAO;YACV,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,CACnB,uBAAA,IAAI,+BAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;SACvD,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACO,KAAK,CAAC,kBAAkB,CAOhC,OAMC,EACD,SAAsB;QAEtB,MAAM,KAAK,GAAG,uBAAA,IAAI,oCAAa,CAAC,aAAa,EAAE,CAAC;QAEhD,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAA4C;YAClE,QAAQ,EAAE,OAAO,CAAC,QAAQ;SAC3B,CAAC,CAAC;QAEH,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAClD,MAAM,MAAM,GAAG,MAAM,uBAAA,IAAI,oCAAa,CAAC,kBAAkB,CAAC;gBACxD,GAAG,OAAO;gBACV,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,CACnB,uBAAA,IAAI,+BAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,CACxB,OAAO,CAAC,OAAO,CAAC;oBACd,GAAG,OAAO;oBACV,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,SAAS;iBAC1C,CAAC,CACH;aACJ,CAAC,CAAC;YAEH,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACzB,CAAC;QAED,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC;QACnC,MAAM,QAAQ,GAAG,OAAO,CAAC,oBAAoB,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;QAEjE,MAAM,SAAS,GAAG,IAAA,yBAAS,EAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;QAE1E,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,KAAK,CAAC,SAAS,EAAE;YAC1C,IAAI,EAAE;gBACJ,SAAS,EAAE;oBACT,SAAS;oBACT,SAAS;iBACV;aACF;SACF,CAAC,CAAC;QAEH,MAAM,SAAS,GAAG,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CACtD,IAAA,yBAAS,EAAC,KAAK,EAAE,SAAS,CAAC,CAC5B,CAAC;QAEF,OAAO,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAA2C,EAC3C,OAA2B;QAE3B,OAAO,uBAAA,IAAI,oCAAa,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED;;OAEG;IACH,IAAI;QACF,uBAAA,IAAI,8DAAW,MAAf,IAAI,CAAa,CAAC,KAAK;QACrB,0BAA0B;QAC1B,CAAC,KAAK,EAAE,EAAE,CAAC,uBAAA,IAAI,kCAAW,CAAC,gBAAgB,EAAE,CAAC,KAAK,CAAC,CACrD,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,OAAO;QACL,uBAAA,IAAI,yCAAkB,EAAE,MAAM,EAAE,CAAC;QACjC,uBAAA,IAAI,8CAAuB,MAA3B,IAAI,CAAyB,CAAC;QAC9B,uBAAA,IAAI,oCAAa,CAAC,KAAK,EAAE,CAAC;QAC1B,IAAI,CAAC,SAAS,CAAC,kBAAkB,EAAE,CAAC;QACpC,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,CAAC;IAChC,CAAC;CAqGF;AA5VD,0CA4VC;qdA7FqB,IAAY,EAAE,IAAsB;IACtD,MAAM,KAAK,GACT,IAAI,KAAK,OAAO,IAAI,IAAI,KAAK,SAAS;QACpC,CAAC,CAAC,IAAA,sBAAS,EAAC,uBAAA,IAAI,oCAAa,EAAE;YAC3B,oBAAoB,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,SAAS,KAAK,IAAI;SAC1D,CAAC;QACJ,CAAC,CAAC,IAAI,CAAC;IAEX,uBAAA,IAAI,kCAAW,CAAC,OAAO,CACrB,GAAG,IAAI,CAAC,IAAI,eAAwB,EACpC;QACE,IAAI;QACJ,IAAI;QACJ,KAAK;KAC4B,CACpC,CAAC;IAEF,uBAAA,IAAI,kCAAW,CAAC,OAAO,CACrB,GAAG,IAAI,CAAC,IAAI,iBAAiB,IAAI,EAAW,EAC5C;QACE,IAAI;QACJ,KAAK;KACoC,CAC5C,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,KAAK;IACH,MAAM,KAAK,GAAG,IAAA,sBAAS,EAAC,uBAAA,IAAI,oCAAa,EAAE;QACzC,yDAAyD;QACzD,oBAAoB,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,KAAK,SAAS;KAClE,CAAC,CAAC;IAEH,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,IAAI,KAAK,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC/D,MAAM,uBAAA,IAAI,0CAAmB,CAAC,IAAI,CAChC,2BAA2B,EAC3B,IAAI,CAAC,IAAI,EACT,2BAAmB,CACpB,CAAC;QACF,OAAO;IACT,CAAC;IAED,MAAM,KAAK,GAAmB;QAC5B,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;QACrB,KAAK;KACN,CAAC;IAEF,MAAM,uBAAA,IAAI,0CAAmB,CAAC,IAAI,CAChC,wBAAwB,EACxB,IAAI,CAAC,IAAI,EACT,2BAAmB,EACnB,KAAwB,CACzB,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,KAAK;IACH,IAAI,CAAC,uBAAA,IAAI,0CAAmB,EAAE,CAAC;QAC7B,OAAO;IACT,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,GAAG,MAAM,uBAAA,IAAI,0CAAmB,CAAC,IAAI,CACjE,wBAAwB,EACxB,IAAI,CAAC,IAAI,EACT,2BAAmB,CACpB,CAAC;IAEF,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,OAAO;IACT,CAAC;IAED,MAAM,KAAK,GAAG,YAAyC,CAAC;IAExD,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC,SAAS,IAAI,uBAAA,IAAI,0CAAmB,CAAC,MAAM,EAAE,CAAC;QACnE,MAAM,uBAAA,IAAI,0CAAmB,CAAC,IAAI,CAChC,2BAA2B,EAC3B,IAAI,CAAC,IAAI,EACT,2BAAmB,CACpB,CAAC;QACF,OAAO;IACT,CAAC;IAED,IAAA,oBAAO,EAAC,uBAAA,IAAI,oCAAa,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;AAC1C,CAAC","sourcesContent":["import {\n  Messenger,\n  ActionConstraint,\n  EventConstraint,\n} from '@metamask/messenger';\nimport type {\n  StorageServiceGetItemAction,\n  StorageServiceRemoveItemAction,\n  StorageServiceSetItemAction,\n} from '@metamask/storage-service';\nimport { Duration, inMilliseconds } from '@metamask/utils';\nimport type { Json } from '@metamask/utils';\nimport {\n  DefaultOptions,\n  DehydratedState,\n  FetchInfiniteQueryOptions,\n  FetchQueryOptions,\n  InfiniteData,\n  InvalidateOptions,\n  InvalidateQueryFilters,\n  OmitKeyof,\n  QueryClient,\n  QueryClientConfig,\n  WithRequired,\n  dehydrate,\n  hydrate,\n} from '@tanstack/query-core';\nimport deepEqual from 'fast-deep-equal';\nimport { debounce, DebouncedFunc } from 'lodash';\n\nimport {\n  createServicePolicy,\n  CreateServicePolicyOptions,\n  ServicePolicy,\n} from './createServicePolicy';\n\n// Data service queries use the following format: ['ServiceActionName', ...params]\nexport type QueryKey = [string, ...Json[]];\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: (\n    filters?: InvalidateQueryFilters<Json>,\n    options?: InvalidateOptions,\n  ) => Promise<void>;\n};\n\ntype 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\ntype 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 Messenger<\n    ServiceName,\n    ActionConstraint,\n    EventConstraint,\n    // Use `any` to allow any parent to be set. `any` is harmless in a type constraint anyway,\n    // it's the one totally safe place to use it.\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    any\n  >,\n> {\n  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: ServiceMessenger;\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   * @returns The query results.\n   */\n  protected async fetchQuery<\n    TQueryFnData extends Json,\n    TError = unknown,\n    TData = TQueryFnData,\n    TQueryKey extends QueryKey = QueryKey,\n  >(\n    options: WithRequired<\n      OmitKeyof<\n        FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n        'retry' | 'retryDelay'\n      >,\n      'queryKey' | 'queryFn'\n    >,\n  ): Promise<TData> {\n    return this.#queryClient.fetchQuery({\n      ...options,\n      queryFn: (context) =>\n        this.#policy.execute(() => options.queryFn(context)),\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 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 = unknown,\n    TData extends TQueryFnData = TQueryFnData,\n    TQueryKey extends QueryKey = QueryKey,\n    TPageParam extends Json = Json,\n  >(\n    options: WithRequired<\n      OmitKeyof<\n        FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n        'retry' | 'retryDelay'\n      >,\n      'queryKey' | 'queryFn'\n    >,\n    pageParam?: TPageParam,\n  ): Promise<TData> {\n    const cache = this.#queryClient.getQueryCache();\n\n    const query = cache.find<TQueryFnData, TError, InfiniteData<TData>>({\n      queryKey: options.queryKey,\n    });\n\n    if (!query?.state.data || pageParam === undefined) {\n      const result = await this.#queryClient.fetchInfiniteQuery({\n        ...options,\n        queryFn: (context) =>\n          this.#policy.execute(() =>\n            options.queryFn({\n              ...context,\n              pageParam: context.pageParam ?? pageParam,\n            }),\n          ),\n      });\n\n      return result.pages[0];\n    }\n\n    const { pages } = query.state.data;\n    const previous = options.getPreviousPageParam?.(pages[0], pages);\n\n    const direction = deepEqual(pageParam, previous) ? 'backward' : 'forward';\n\n    const result = await query.fetch(undefined, {\n      meta: {\n        fetchMore: {\n          direction,\n          pageParam,\n        },\n      },\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<TPageData extends Json>(\n    filters?: InvalidateQueryFilters<TPageData>,\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"]}

package/dist/BaseDataService.d.cts

@@ -25,15 +25,36 @@ export type DataServiceGranularCacheUpdatedEvent<ServiceName extends string> = {
     type: `${ServiceName}:cacheUpdated:${string}`;
     payload: [DataServiceGranularCacheUpdatedPayload];
 };
+export declare const STORAGE_SERVICE_KEY = "cache";
+/**
+ * Options for persistence configuration.
+ */
+export type PersistenceConfiguration = {
+    /**
+     * The maximum age before the cache is treated as expired in milliseconds.
+     * This is relevant for rehydrating the state during initialization,
+     * if the cached state is too old it will be discarded.
+     */
+    maxAge: number;
+    /**
+     * The number of milliseconds to wait before triggering persistence following a cache update.
+     */
+    writeDelay?: number;
+    /**
+     * The maximum number of milliseconds to wait between persistence writes.
+     */
+    maxWriteDelay?: number;
+};
 export declare class BaseDataService<ServiceName extends string, ServiceMessenger extends Messenger<ServiceName, ActionConstraint, EventConstraint, any>> {
     #private;
     readonly name: ServiceName;
     protected messenger: ServiceMessenger;
-    constructor({ name, messenger, queryClientConfig, policyOptions, }: {
+    constructor({ name, messenger, queryClientConfig, policyOptions, persistenceConfig, }: {
         name: ServiceName;
         messenger: ServiceMessenger;
         queryClientConfig?: QueryClientConfig;
         policyOptions?: CreateServicePolicyOptions;
+        persistenceConfig?: PersistenceConfiguration;
     });
     /**
      * Fetch a query.
@@ -60,6 +81,10 @@ export declare class BaseDataService<ServiceName extends string, ServiceMessenge
      * @returns Nothing.
      */
     invalidateQueries<TPageData extends Json>(filters?: InvalidateQueryFilters<TPageData>, options?: InvalidateOptions): Promise<void>;
+    /**
+     * Initialize the service, rehydrating the cache with persisted data if possible.
+     */
+    init(): void;
     /**
      * Prepares the service for garbage collection. This should be extended
      * by any subclasses to clean up any additional connections or events.

package/dist/BaseDataService.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"BaseDataService.d.cts","sourceRoot":"","sources":["../src/BaseDataService.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,gBAAgB,EAChB,eAAe,EAChB,4BAA4B;AAE7B,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAC5C,OAAO,EAEL,eAAe,EACf,yBAAyB,EACzB,iBAAiB,EAEjB,iBAAiB,EACjB,sBAAsB,EACtB,SAAS,EAET,iBAAiB,EACjB,YAAY,EAEb,6BAA6B;AAG9B,OAAO,EAEL,0BAA0B,EAE3B,kCAA8B;AAG/B,MAAM,MAAM,QAAQ,GAAG,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;AAE3C,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,CACP,OAAO,CAAC,EAAE,sBAAsB,CAAC,IAAI,CAAC,EACtC,OAAO,CAAC,EAAE,iBAAiB,KACxB,OAAO,CAAC,IAAI,CAAC,CAAC;CACpB,CAAC;AAKF,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;AAcF,qBAAa,eAAe,CAC1B,WAAW,SAAS,MAAM,EAC1B,gBAAgB,SAAS,SAAS,CAChC,WAAW,EACX,gBAAgB,EAChB,eAAe,EAIf,GAAG,CACJ;;IAED,SAAgB,IAAI,EAAE,WAAW,CAAC;IAQlC,SAAS,CAAC,SAAS,EAAE,gBAAgB,CAAC;gBAQ1B,EACV,IAAI,EACJ,SAAS,EACT,iBAAsB,EACtB,aAAa,GACd,EAAE;QACD,IAAI,EAAE,WAAW,CAAC;QAClB,SAAS,EAAE,gBAAgB,CAAC;QAC5B,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;QACtC,aAAa,CAAC,EAAE,0BAA0B,CAAC;KAC5C;IA0CD;;;;;;OAMG;cACa,UAAU,CACxB,YAAY,SAAS,IAAI,EACzB,MAAM,GAAG,OAAO,EAChB,KAAK,GAAG,YAAY,EACpB,SAAS,SAAS,QAAQ,GAAG,QAAQ,EAErC,OAAO,EAAE,YAAY,CACnB,SAAS,CACP,iBAAiB,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,CAAC,EACzD,OAAO,GAAG,YAAY,CACvB,EACD,UAAU,GAAG,SAAS,CACvB,GACA,OAAO,CAAC,KAAK,CAAC;IAQjB;;;;;;;OAOG;cACa,kBAAkB,CAChC,YAAY,SAAS,IAAI,EACzB,MAAM,GAAG,OAAO,EAChB,KAAK,SAAS,YAAY,GAAG,YAAY,EACzC,SAAS,SAAS,QAAQ,GAAG,QAAQ,EACrC,UAAU,SAAS,IAAI,GAAG,IAAI,EAE9B,OAAO,EAAE,YAAY,CACnB,SAAS,CACP,yBAAyB,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,CAAC,EACjE,OAAO,GAAG,YAAY,CACvB,EACD,UAAU,GAAG,SAAS,CACvB,EACD,SAAS,CAAC,EAAE,UAAU,GACrB,OAAO,CAAC,KAAK,CAAC;IA2CjB;;;;;;OAMG;IACG,iBAAiB,CAAC,SAAS,SAAS,IAAI,EAC5C,OAAO,CAAC,EAAE,sBAAsB,CAAC,SAAS,CAAC,EAC3C,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,IAAI,CAAC;IAIhB;;;OAGG;IACH,OAAO,IAAI,IAAI;CAsChB"}
+{"version":3,"file":"BaseDataService.d.cts","sourceRoot":"","sources":["../src/BaseDataService.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,gBAAgB,EAChB,eAAe,EAChB,4BAA4B;AAO7B,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAC5C,OAAO,EAEL,eAAe,EACf,yBAAyB,EACzB,iBAAiB,EAEjB,iBAAiB,EACjB,sBAAsB,EACtB,SAAS,EAET,iBAAiB,EACjB,YAAY,EAGb,6BAA6B;AAI9B,OAAO,EAEL,0BAA0B,EAE3B,kCAA8B;AAG/B,MAAM,MAAM,QAAQ,GAAG,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;AAE3C,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,CACP,OAAO,CAAC,EAAE,sBAAsB,CAAC,IAAI,CAAC,EACtC,OAAO,CAAC,EAAE,iBAAiB,KACxB,OAAO,CAAC,IAAI,CAAC,CAAC;CACpB,CAAC;AAUF,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;AAcF,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,SAAS,CAChC,WAAW,EACX,gBAAgB,EAChB,eAAe,EAIf,GAAG,CACJ;;IAED,SAAgB,IAAI,EAAE,WAAW,CAAC;IAalC,SAAS,CAAC,SAAS,EAAE,gBAAgB,CAAC;gBAY1B,EACV,IAAI,EACJ,SAAS,EACT,iBAAsB,EACtB,aAAa,EACb,iBAAiB,GAClB,EAAE;QACD,IAAI,EAAE,WAAW,CAAC;QAClB,SAAS,EAAE,gBAAgB,CAAC;QAC5B,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;QACtC,aAAa,CAAC,EAAE,0BAA0B,CAAC;QAC3C,iBAAiB,CAAC,EAAE,wBAAwB,CAAC;KAC9C;IAsED;;;;;;OAMG;cACa,UAAU,CACxB,YAAY,SAAS,IAAI,EACzB,MAAM,GAAG,OAAO,EAChB,KAAK,GAAG,YAAY,EACpB,SAAS,SAAS,QAAQ,GAAG,QAAQ,EAErC,OAAO,EAAE,YAAY,CACnB,SAAS,CACP,iBAAiB,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,CAAC,EACzD,OAAO,GAAG,YAAY,CACvB,EACD,UAAU,GAAG,SAAS,CACvB,GACA,OAAO,CAAC,KAAK,CAAC;IAQjB;;;;;;;OAOG;cACa,kBAAkB,CAChC,YAAY,SAAS,IAAI,EACzB,MAAM,GAAG,OAAO,EAChB,KAAK,SAAS,YAAY,GAAG,YAAY,EACzC,SAAS,SAAS,QAAQ,GAAG,QAAQ,EACrC,UAAU,SAAS,IAAI,GAAG,IAAI,EAE9B,OAAO,EAAE,YAAY,CACnB,SAAS,CACP,yBAAyB,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,CAAC,EACjE,OAAO,GAAG,YAAY,CACvB,EACD,UAAU,GAAG,SAAS,CACvB,EACD,SAAS,CAAC,EAAE,UAAU,GACrB,OAAO,CAAC,KAAK,CAAC;IA2CjB;;;;;;OAMG;IACG,iBAAiB,CAAC,SAAS,SAAS,IAAI,EAC5C,OAAO,CAAC,EAAE,sBAAsB,CAAC,SAAS,CAAC,EAC3C,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,IAAI,CAAC;IAIhB;;OAEG;IACH,IAAI,IAAI,IAAI;IAOZ;;;OAGG;IACH,OAAO,IAAI,IAAI;CA2GhB"}

package/dist/BaseDataService.d.mts

@@ -25,15 +25,36 @@ export type DataServiceGranularCacheUpdatedEvent<ServiceName extends string> = {
     type: `${ServiceName}:cacheUpdated:${string}`;
     payload: [DataServiceGranularCacheUpdatedPayload];
 };
+export declare const STORAGE_SERVICE_KEY = "cache";
+/**
+ * Options for persistence configuration.
+ */
+export type PersistenceConfiguration = {
+    /**
+     * The maximum age before the cache is treated as expired in milliseconds.
+     * This is relevant for rehydrating the state during initialization,
+     * if the cached state is too old it will be discarded.
+     */
+    maxAge: number;
+    /**
+     * The number of milliseconds to wait before triggering persistence following a cache update.
+     */
+    writeDelay?: number;
+    /**
+     * The maximum number of milliseconds to wait between persistence writes.
+     */
+    maxWriteDelay?: number;
+};
 export declare class BaseDataService<ServiceName extends string, ServiceMessenger extends Messenger<ServiceName, ActionConstraint, EventConstraint, any>> {
     #private;
     readonly name: ServiceName;
     protected messenger: ServiceMessenger;
-    constructor({ name, messenger, queryClientConfig, policyOptions, }: {
+    constructor({ name, messenger, queryClientConfig, policyOptions, persistenceConfig, }: {
         name: ServiceName;
         messenger: ServiceMessenger;
         queryClientConfig?: QueryClientConfig;
         policyOptions?: CreateServicePolicyOptions;
+        persistenceConfig?: PersistenceConfiguration;
     });
     /**
      * Fetch a query.
@@ -60,6 +81,10 @@ export declare class BaseDataService<ServiceName extends string, ServiceMessenge
      * @returns Nothing.
      */
     invalidateQueries<TPageData extends Json>(filters?: InvalidateQueryFilters<TPageData>, options?: InvalidateOptions): Promise<void>;
+    /**
+     * Initialize the service, rehydrating the cache with persisted data if possible.
+     */
+    init(): void;
     /**
      * Prepares the service for garbage collection. This should be extended
      * by any subclasses to clean up any additional connections or events.

package/dist/BaseDataService.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"BaseDataService.d.mts","sourceRoot":"","sources":["../src/BaseDataService.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,gBAAgB,EAChB,eAAe,EAChB,4BAA4B;AAE7B,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAC5C,OAAO,EAEL,eAAe,EACf,yBAAyB,EACzB,iBAAiB,EAEjB,iBAAiB,EACjB,sBAAsB,EACtB,SAAS,EAET,iBAAiB,EACjB,YAAY,EAEb,6BAA6B;AAG9B,OAAO,EAEL,0BAA0B,EAE3B,kCAA8B;AAG/B,MAAM,MAAM,QAAQ,GAAG,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;AAE3C,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,CACP,OAAO,CAAC,EAAE,sBAAsB,CAAC,IAAI,CAAC,EACtC,OAAO,CAAC,EAAE,iBAAiB,KACxB,OAAO,CAAC,IAAI,CAAC,CAAC;CACpB,CAAC;AAKF,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;AAcF,qBAAa,eAAe,CAC1B,WAAW,SAAS,MAAM,EAC1B,gBAAgB,SAAS,SAAS,CAChC,WAAW,EACX,gBAAgB,EAChB,eAAe,EAIf,GAAG,CACJ;;IAED,SAAgB,IAAI,EAAE,WAAW,CAAC;IAQlC,SAAS,CAAC,SAAS,EAAE,gBAAgB,CAAC;gBAQ1B,EACV,IAAI,EACJ,SAAS,EACT,iBAAsB,EACtB,aAAa,GACd,EAAE;QACD,IAAI,EAAE,WAAW,CAAC;QAClB,SAAS,EAAE,gBAAgB,CAAC;QAC5B,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;QACtC,aAAa,CAAC,EAAE,0BAA0B,CAAC;KAC5C;IA0CD;;;;;;OAMG;cACa,UAAU,CACxB,YAAY,SAAS,IAAI,EACzB,MAAM,GAAG,OAAO,EAChB,KAAK,GAAG,YAAY,EACpB,SAAS,SAAS,QAAQ,GAAG,QAAQ,EAErC,OAAO,EAAE,YAAY,CACnB,SAAS,CACP,iBAAiB,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,CAAC,EACzD,OAAO,GAAG,YAAY,CACvB,EACD,UAAU,GAAG,SAAS,CACvB,GACA,OAAO,CAAC,KAAK,CAAC;IAQjB;;;;;;;OAOG;cACa,kBAAkB,CAChC,YAAY,SAAS,IAAI,EACzB,MAAM,GAAG,OAAO,EAChB,KAAK,SAAS,YAAY,GAAG,YAAY,EACzC,SAAS,SAAS,QAAQ,GAAG,QAAQ,EACrC,UAAU,SAAS,IAAI,GAAG,IAAI,EAE9B,OAAO,EAAE,YAAY,CACnB,SAAS,CACP,yBAAyB,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,CAAC,EACjE,OAAO,GAAG,YAAY,CACvB,EACD,UAAU,GAAG,SAAS,CACvB,EACD,SAAS,CAAC,EAAE,UAAU,GACrB,OAAO,CAAC,KAAK,CAAC;IA2CjB;;;;;;OAMG;IACG,iBAAiB,CAAC,SAAS,SAAS,IAAI,EAC5C,OAAO,CAAC,EAAE,sBAAsB,CAAC,SAAS,CAAC,EAC3C,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,IAAI,CAAC;IAIhB;;;OAGG;IACH,OAAO,IAAI,IAAI;CAsChB"}
+{"version":3,"file":"BaseDataService.d.mts","sourceRoot":"","sources":["../src/BaseDataService.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,gBAAgB,EAChB,eAAe,EAChB,4BAA4B;AAO7B,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAC5C,OAAO,EAEL,eAAe,EACf,yBAAyB,EACzB,iBAAiB,EAEjB,iBAAiB,EACjB,sBAAsB,EACtB,SAAS,EAET,iBAAiB,EACjB,YAAY,EAGb,6BAA6B;AAI9B,OAAO,EAEL,0BAA0B,EAE3B,kCAA8B;AAG/B,MAAM,MAAM,QAAQ,GAAG,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;AAE3C,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,CACP,OAAO,CAAC,EAAE,sBAAsB,CAAC,IAAI,CAAC,EACtC,OAAO,CAAC,EAAE,iBAAiB,KACxB,OAAO,CAAC,IAAI,CAAC,CAAC;CACpB,CAAC;AAUF,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;AAcF,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,SAAS,CAChC,WAAW,EACX,gBAAgB,EAChB,eAAe,EAIf,GAAG,CACJ;;IAED,SAAgB,IAAI,EAAE,WAAW,CAAC;IAalC,SAAS,CAAC,SAAS,EAAE,gBAAgB,CAAC;gBAY1B,EACV,IAAI,EACJ,SAAS,EACT,iBAAsB,EACtB,aAAa,EACb,iBAAiB,GAClB,EAAE;QACD,IAAI,EAAE,WAAW,CAAC;QAClB,SAAS,EAAE,gBAAgB,CAAC;QAC5B,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;QACtC,aAAa,CAAC,EAAE,0BAA0B,CAAC;QAC3C,iBAAiB,CAAC,EAAE,wBAAwB,CAAC;KAC9C;IAsED;;;;;;OAMG;cACa,UAAU,CACxB,YAAY,SAAS,IAAI,EACzB,MAAM,GAAG,OAAO,EAChB,KAAK,GAAG,YAAY,EACpB,SAAS,SAAS,QAAQ,GAAG,QAAQ,EAErC,OAAO,EAAE,YAAY,CACnB,SAAS,CACP,iBAAiB,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,CAAC,EACzD,OAAO,GAAG,YAAY,CACvB,EACD,UAAU,GAAG,SAAS,CACvB,GACA,OAAO,CAAC,KAAK,CAAC;IAQjB;;;;;;;OAOG;cACa,kBAAkB,CAChC,YAAY,SAAS,IAAI,EACzB,MAAM,GAAG,OAAO,EAChB,KAAK,SAAS,YAAY,GAAG,YAAY,EACzC,SAAS,SAAS,QAAQ,GAAG,QAAQ,EACrC,UAAU,SAAS,IAAI,GAAG,IAAI,EAE9B,OAAO,EAAE,YAAY,CACnB,SAAS,CACP,yBAAyB,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,CAAC,EACjE,OAAO,GAAG,YAAY,CACvB,EACD,UAAU,GAAG,SAAS,CACvB,EACD,SAAS,CAAC,EAAE,UAAU,GACrB,OAAO,CAAC,KAAK,CAAC;IA2CjB;;;;;;OAMG;IACG,iBAAiB,CAAC,SAAS,SAAS,IAAI,EAC5C,OAAO,CAAC,EAAE,sBAAsB,CAAC,SAAS,CAAC,EAC3C,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,IAAI,CAAC;IAIhB;;OAEG;IACH,IAAI,IAAI,IAAI;IAOZ;;;OAGG;IACH,OAAO,IAAI,IAAI;CA2GhB"}

package/dist/BaseDataService.mjs

@@ -9,7 +9,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _BaseDataService_instances, _BaseDataService_messenger, _BaseDataService_policy, _BaseDataService_queryClient, _BaseDataService_queryCacheUnsubscribe, _BaseDataService_publishCacheUpdate;
+var _BaseDataService_instances, _BaseDataService_messenger, _BaseDataService_externalMessenger, _BaseDataService_policy, _BaseDataService_queryClient, _BaseDataService_queryCacheUnsubscribe, _BaseDataService_debouncedPersist, _BaseDataService_persistenceConfig, _BaseDataService_publishCacheUpdate, _BaseDataService_persistCache, _BaseDataService_loadCache;
 function $importDefault(module) {
     if (module?.__esModule) {
         return module.default;
@@ -18,9 +18,11 @@ function $importDefault(module) {
 }
 import { Messenger } from "@metamask/messenger";
 import { Duration, inMilliseconds } from "@metamask/utils";
-import { QueryClient, dehydrate } from "@tanstack/query-core";
+import { QueryClient, dehydrate, hydrate } from "@tanstack/query-core";
 import $deepEqual from "fast-deep-equal";
 const deepEqual = $importDefault($deepEqual);
+import $lodash from "lodash";
+const { debounce } = $lodash;
 import { createServicePolicy } from "./createServicePolicy.mjs";
 // Defaults to apply to all data service queries if no default option specified
 const QUERY_CLIENT_DEFAULTS = {
@@ -29,17 +31,24 @@ const QUERY_CLIENT_DEFAULTS = {
         staleTime: inMilliseconds(1, Duration.Minute),
     },
 };
+export const STORAGE_SERVICE_KEY = 'cache';
 export class BaseDataService {
-    constructor({ name, messenger, queryClientConfig = {}, policyOptions, }) {
+    constructor({ name, messenger, queryClientConfig = {}, policyOptions, persistenceConfig, }) {
         _BaseDataService_instances.add(this);
         _BaseDataService_messenger.set(this, void 0);
+        _BaseDataService_externalMessenger.set(this, void 0);
         _BaseDataService_policy.set(this, void 0);
         _BaseDataService_queryClient.set(this, void 0);
         _BaseDataService_queryCacheUnsubscribe.set(this, void 0);
+        _BaseDataService_debouncedPersist.set(this, void 0);
+        _BaseDataService_persistenceConfig.set(this, void 0);
         this.name = name;
-        // We are storing a separately typed messenger for known actions and events provided by data services
-        // and a generic public one that is typed using the generic parameters and accessible to implementations.
+        // We store two narrowly-typed messengers alongside the generic public one:
+        // - #messenger handles the service's own action registration and event publishing
+        // - #externalMessenger handles calls to external actions
+        // Splitting them avoids TypeScript issues with mixing template-literals with regular strings
         __classPrivateFieldSet(this, _BaseDataService_messenger, messenger, "f");
+        __classPrivateFieldSet(this, _BaseDataService_externalMessenger, messenger, "f");
         this.messenger = messenger;
         __classPrivateFieldSet(this, _BaseDataService_queryClient, new QueryClient({
             ...queryClientConfig,
@@ -51,12 +60,24 @@ export class BaseDataService {
                 mutations: queryClientConfig.defaultOptions?.mutations,
             },
         }), "f");
+        __classPrivateFieldSet(this, _BaseDataService_persistenceConfig, persistenceConfig, "f");
         __classPrivateFieldSet(this, _BaseDataService_policy, createServicePolicy(policyOptions), "f");
+        __classPrivateFieldSet(this, _BaseDataService_debouncedPersist, __classPrivateFieldGet(this, _BaseDataService_persistenceConfig, "f") &&
+            debounce(() => {
+                __classPrivateFieldGet(this, _BaseDataService_instances, "m", _BaseDataService_persistCache).call(this).catch(
+                /* istanbul ignore next */
+                (error) => __classPrivateFieldGet(this, _BaseDataService_messenger, "f").captureException?.(error));
+            }, __classPrivateFieldGet(this, _BaseDataService_persistenceConfig, "f").writeDelay ??
+                inMilliseconds(10, Duration.Second), {
+                maxWait: __classPrivateFieldGet(this, _BaseDataService_persistenceConfig, "f").maxWriteDelay ??
+                    inMilliseconds(1, Duration.Minute),
+            }), "f");
         __classPrivateFieldSet(this, _BaseDataService_queryCacheUnsubscribe, __classPrivateFieldGet(this, _BaseDataService_queryClient, "f")
             .getQueryCache()
             .subscribe((event) => {
             if (['added', 'updated', 'removed'].includes(event.type)) {
                 __classPrivateFieldGet(this, _BaseDataService_instances, "m", _BaseDataService_publishCacheUpdate).call(this, event.query.queryHash, event.type);
+                __classPrivateFieldGet(this, _BaseDataService_debouncedPersist, "f")?.call(this);
             }
         }), "f");
         __classPrivateFieldGet(this, _BaseDataService_messenger, "f").registerActionHandler(`${this.name}:invalidateQueries`, this.invalidateQueries.bind(this));
@@ -121,18 +142,27 @@ export class BaseDataService {
     async invalidateQueries(filters, options) {
         return __classPrivateFieldGet(this, _BaseDataService_queryClient, "f").invalidateQueries(filters, options);
     }
+    /**
+     * Initialize the service, rehydrating the cache with persisted data if possible.
+     */
+    init() {
+        __classPrivateFieldGet(this, _BaseDataService_instances, "m", _BaseDataService_loadCache).call(this).catch(
+        /* istanbul ignore next */
+        (error) => __classPrivateFieldGet(this, _BaseDataService_messenger, "f").captureException?.(error));
+    }
     /**
      * Prepares the service for garbage collection. This should be extended
      * by any subclasses to clean up any additional connections or events.
      */
     destroy() {
+        __classPrivateFieldGet(this, _BaseDataService_debouncedPersist, "f")?.cancel();
         __classPrivateFieldGet(this, _BaseDataService_queryCacheUnsubscribe, "f").call(this);
         __classPrivateFieldGet(this, _BaseDataService_queryClient, "f").clear();
         this.messenger.clearSubscriptions();
         this.messenger.clearActions();
     }
 }
-_BaseDataService_messenger = new WeakMap(), _BaseDataService_policy = new WeakMap(), _BaseDataService_queryClient = new WeakMap(), _BaseDataService_queryCacheUnsubscribe = new WeakMap(), _BaseDataService_instances = new WeakSet(), _BaseDataService_publishCacheUpdate = function _BaseDataService_publishCacheUpdate(hash, type) {
+_BaseDataService_messenger = new WeakMap(), _BaseDataService_externalMessenger = new WeakMap(), _BaseDataService_policy = new WeakMap(), _BaseDataService_queryClient = new WeakMap(), _BaseDataService_queryCacheUnsubscribe = new WeakMap(), _BaseDataService_debouncedPersist = new WeakMap(), _BaseDataService_persistenceConfig = new WeakMap(), _BaseDataService_instances = new WeakSet(), _BaseDataService_publishCacheUpdate = function _BaseDataService_publishCacheUpdate(hash, type) {
     const state = type === 'added' || type === 'updated'
         ? dehydrate(__classPrivateFieldGet(this, _BaseDataService_queryClient, "f"), {
             shouldDehydrateQuery: (query) => query.queryHash === hash,
@@ -147,5 +177,46 @@ _BaseDataService_messenger = new WeakMap(), _BaseDataService_policy = new WeakMa
         type,
         state,
     });
+}, _BaseDataService_persistCache = 
+/**
+ * Persist the query client cache using the StorageService, if the cache is not empty.
+ *
+ * @returns Nothing.
+ */
+async function _BaseDataService_persistCache() {
+    const state = dehydrate(__classPrivateFieldGet(this, _BaseDataService_queryClient, "f"), {
+        // This is the default, but we specify it to be explicit.
+        shouldDehydrateQuery: (query) => query.state.status === 'success',
+    });
+    if (state.queries.length === 0 && state.mutations.length === 0) {
+        await __classPrivateFieldGet(this, _BaseDataService_externalMessenger, "f").call('StorageService:removeItem', this.name, STORAGE_SERVICE_KEY);
+        return;
+    }
+    const cache = {
+        timestamp: Date.now(),
+        state,
+    };
+    await __classPrivateFieldGet(this, _BaseDataService_externalMessenger, "f").call('StorageService:setItem', this.name, STORAGE_SERVICE_KEY, cache);
+}, _BaseDataService_loadCache = 
+/**
+ * Load the query client cache from the StorageService, if persistence is configured
+ * and the persisted cache is not expired.
+ *
+ * @returns Nothing.
+ */
+async function _BaseDataService_loadCache() {
+    if (!__classPrivateFieldGet(this, _BaseDataService_persistenceConfig, "f")) {
+        return;
+    }
+    const { result: untypedCache } = await __classPrivateFieldGet(this, _BaseDataService_externalMessenger, "f").call('StorageService:getItem', this.name, STORAGE_SERVICE_KEY);
+    if (!untypedCache) {
+        return;
+    }
+    const cache = untypedCache;
+    if (Date.now() - cache.timestamp >= __classPrivateFieldGet(this, _BaseDataService_persistenceConfig, "f").maxAge) {
+        await __classPrivateFieldGet(this, _BaseDataService_externalMessenger, "f").call('StorageService:removeItem', this.name, STORAGE_SERVICE_KEY);
+        return;
+    }
+    hydrate(__classPrivateFieldGet(this, _BaseDataService_queryClient, "f"), cache.state);
 };
 //# sourceMappingURL=BaseDataService.mjs.map

package/dist/BaseDataService.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"BaseDataService.mjs","sourceRoot":"","sources":["../src/BaseDataService.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,OAAO,EACL,SAAS,EAGV,4BAA4B;AAC7B,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,wBAAwB;AAE3D,OAAO,EASL,WAAW,EAGX,SAAS,EACV,6BAA6B;AAC9B,OAAO,UAAS,wBAAwB;;AAExC,OAAO,EACL,mBAAmB,EAGpB,kCAA8B;AA4C/B,+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,OAAO,eAAe;IA4B1B,YAAY,EACV,IAAI,EACJ,SAAS,EACT,iBAAiB,GAAG,EAAE,EACtB,aAAa,GAMd;;QAxBQ,6CAIP;QAIO,0CAAuB;QAEvB,+CAA0B;QAE1B,yDAAmC;QAa1C,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QAEjB,qGAAqG;QACrG,yGAAyG;QACzG,uBAAA,IAAI,8BAAc,SAIjB,MAAA,CAAC;QACF,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAE3B,uBAAA,IAAI,gCAAgB,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,MAAA,CAAC;QAEH,uBAAA,IAAI,2BAAW,mBAAmB,CAAC,aAAa,CAAC,MAAA,CAAC;QAElD,uBAAA,IAAI,0CAA0B,uBAAA,IAAI,oCAAa;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,uBAAA,IAAI,uEAAoB,MAAxB,IAAI,EACF,KAAK,CAAC,KAAK,CAAC,SAAS,EACrB,KAAK,CAAC,IAAwB,CAC/B,CAAC;YACJ,CAAC;QACH,CAAC,CAAC,MAAA,CAAC;QAEL,uBAAA,IAAI,kCAAW,CAAC,qBAAqB,CACnC,GAAG,IAAI,CAAC,IAAI,oBAAoB,EAChC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAClC,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACO,KAAK,CAAC,UAAU,CAMxB,OAMC;QAED,OAAO,uBAAA,IAAI,oCAAa,CAAC,UAAU,CAAC;YAClC,GAAG,OAAO;YACV,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,CACnB,uBAAA,IAAI,+BAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;SACvD,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACO,KAAK,CAAC,kBAAkB,CAOhC,OAMC,EACD,SAAsB;QAEtB,MAAM,KAAK,GAAG,uBAAA,IAAI,oCAAa,CAAC,aAAa,EAAE,CAAC;QAEhD,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAA4C;YAClE,QAAQ,EAAE,OAAO,CAAC,QAAQ;SAC3B,CAAC,CAAC;QAEH,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAClD,MAAM,MAAM,GAAG,MAAM,uBAAA,IAAI,oCAAa,CAAC,kBAAkB,CAAC;gBACxD,GAAG,OAAO;gBACV,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,CACnB,uBAAA,IAAI,+BAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,CACxB,OAAO,CAAC,OAAO,CAAC;oBACd,GAAG,OAAO;oBACV,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,SAAS;iBAC1C,CAAC,CACH;aACJ,CAAC,CAAC;YAEH,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACzB,CAAC;QAED,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC;QACnC,MAAM,QAAQ,GAAG,OAAO,CAAC,oBAAoB,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;QAEjE,MAAM,SAAS,GAAG,SAAS,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;QAE1E,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,KAAK,CAAC,SAAS,EAAE;YAC1C,IAAI,EAAE;gBACJ,SAAS,EAAE;oBACT,SAAS;oBACT,SAAS;iBACV;aACF;SACF,CAAC,CAAC;QAEH,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,OAA2C,EAC3C,OAA2B;QAE3B,OAAO,uBAAA,IAAI,oCAAa,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED;;;OAGG;IACH,OAAO;QACL,uBAAA,IAAI,8CAAuB,MAA3B,IAAI,CAAyB,CAAC;QAC9B,uBAAA,IAAI,oCAAa,CAAC,KAAK,EAAE,CAAC;QAC1B,IAAI,CAAC,SAAS,CAAC,kBAAkB,EAAE,CAAC;QACpC,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,CAAC;IAChC,CAAC;CAiCF;0TAzBqB,IAAY,EAAE,IAAsB;IACtD,MAAM,KAAK,GACT,IAAI,KAAK,OAAO,IAAI,IAAI,KAAK,SAAS;QACpC,CAAC,CAAC,SAAS,CAAC,uBAAA,IAAI,oCAAa,EAAE;YAC3B,oBAAoB,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,SAAS,KAAK,IAAI;SAC1D,CAAC;QACJ,CAAC,CAAC,IAAI,CAAC;IAEX,uBAAA,IAAI,kCAAW,CAAC,OAAO,CACrB,GAAG,IAAI,CAAC,IAAI,eAAwB,EACpC;QACE,IAAI;QACJ,IAAI;QACJ,KAAK;KAC4B,CACpC,CAAC;IAEF,uBAAA,IAAI,kCAAW,CAAC,OAAO,CACrB,GAAG,IAAI,CAAC,IAAI,iBAAiB,IAAI,EAAW,EAC5C;QACE,IAAI;QACJ,KAAK;KACoC,CAC5C,CAAC;AACJ,CAAC","sourcesContent":["import {\n  Messenger,\n  ActionConstraint,\n  EventConstraint,\n} from '@metamask/messenger';\nimport { Duration, inMilliseconds } from '@metamask/utils';\nimport type { Json } from '@metamask/utils';\nimport {\n  DefaultOptions,\n  DehydratedState,\n  FetchInfiniteQueryOptions,\n  FetchQueryOptions,\n  InfiniteData,\n  InvalidateOptions,\n  InvalidateQueryFilters,\n  OmitKeyof,\n  QueryClient,\n  QueryClientConfig,\n  WithRequired,\n  dehydrate,\n} from '@tanstack/query-core';\nimport deepEqual from 'fast-deep-equal';\n\nimport {\n  createServicePolicy,\n  CreateServicePolicyOptions,\n  ServicePolicy,\n} from './createServicePolicy';\n\n// Data service queries use the following format: ['ServiceActionName', ...params]\nexport type QueryKey = [string, ...Json[]];\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: (\n    filters?: InvalidateQueryFilters<Json>,\n    options?: InvalidateOptions,\n  ) => Promise<void>;\n};\n\ntype DataServiceActions<ServiceName extends string> =\n  DataServiceInvalidateQueriesAction<ServiceName>;\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\ntype 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 class BaseDataService<\n  ServiceName extends string,\n  ServiceMessenger extends Messenger<\n    ServiceName,\n    ActionConstraint,\n    EventConstraint,\n    // Use `any` to allow any parent to be set. `any` is harmless in a type constraint anyway,\n    // it's the one totally safe place to use it.\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    any\n  >,\n> {\n  public readonly name: ServiceName;\n\n  readonly #messenger: Messenger<\n    ServiceName,\n    DataServiceActions<ServiceName>,\n    DataServiceEvents<ServiceName>\n  >;\n\n  protected messenger: ServiceMessenger;\n\n  readonly #policy: ServicePolicy;\n\n  readonly #queryClient: QueryClient;\n\n  readonly #queryCacheUnsubscribe: () => void;\n\n  constructor({\n    name,\n    messenger,\n    queryClientConfig = {},\n    policyOptions,\n  }: {\n    name: ServiceName;\n    messenger: ServiceMessenger;\n    queryClientConfig?: QueryClientConfig;\n    policyOptions?: CreateServicePolicyOptions;\n  }) {\n    this.name = name;\n\n    // We are storing a separately typed messenger for known actions and events provided by data services\n    // and a generic public one that is typed using the generic parameters and accessible to implementations.\n    this.#messenger = messenger as unknown as Messenger<\n      ServiceName,\n      DataServiceActions<ServiceName>,\n      DataServiceEvents<ServiceName>\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.#policy = createServicePolicy(policyOptions);\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      });\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   * @returns The query results.\n   */\n  protected async fetchQuery<\n    TQueryFnData extends Json,\n    TError = unknown,\n    TData = TQueryFnData,\n    TQueryKey extends QueryKey = QueryKey,\n  >(\n    options: WithRequired<\n      OmitKeyof<\n        FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n        'retry' | 'retryDelay'\n      >,\n      'queryKey' | 'queryFn'\n    >,\n  ): Promise<TData> {\n    return this.#queryClient.fetchQuery({\n      ...options,\n      queryFn: (context) =>\n        this.#policy.execute(() => options.queryFn(context)),\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 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 = unknown,\n    TData extends TQueryFnData = TQueryFnData,\n    TQueryKey extends QueryKey = QueryKey,\n    TPageParam extends Json = Json,\n  >(\n    options: WithRequired<\n      OmitKeyof<\n        FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n        'retry' | 'retryDelay'\n      >,\n      'queryKey' | 'queryFn'\n    >,\n    pageParam?: TPageParam,\n  ): Promise<TData> {\n    const cache = this.#queryClient.getQueryCache();\n\n    const query = cache.find<TQueryFnData, TError, InfiniteData<TData>>({\n      queryKey: options.queryKey,\n    });\n\n    if (!query?.state.data || pageParam === undefined) {\n      const result = await this.#queryClient.fetchInfiniteQuery({\n        ...options,\n        queryFn: (context) =>\n          this.#policy.execute(() =>\n            options.queryFn({\n              ...context,\n              pageParam: context.pageParam ?? pageParam,\n            }),\n          ),\n      });\n\n      return result.pages[0];\n    }\n\n    const { pages } = query.state.data;\n    const previous = options.getPreviousPageParam?.(pages[0], pages);\n\n    const direction = deepEqual(pageParam, previous) ? 'backward' : 'forward';\n\n    const result = await query.fetch(undefined, {\n      meta: {\n        fetchMore: {\n          direction,\n          pageParam,\n        },\n      },\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<TPageData extends Json>(\n    filters?: InvalidateQueryFilters<TPageData>,\n    options?: InvalidateOptions,\n  ): Promise<void> {\n    return this.#queryClient.invalidateQueries(filters, options);\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.#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"]}
+{"version":3,"file":"BaseDataService.mjs","sourceRoot":"","sources":["../src/BaseDataService.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,OAAO,EACL,SAAS,EAGV,4BAA4B;AAM7B,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,wBAAwB;AAE3D,OAAO,EASL,WAAW,EAGX,SAAS,EACT,OAAO,EACR,6BAA6B;AAC9B,OAAO,UAAS,wBAAwB;;;;AAGxC,OAAO,EACL,mBAAmB,EAGpB,kCAA8B;AAiD/B,+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;IAqC1B,YAAY,EACV,IAAI,EACJ,SAAS,EACT,iBAAiB,GAAG,EAAE,EACtB,aAAa,EACb,iBAAiB,GAOlB;;QAnCQ,6CAIP;QAEO,qDAGP;QAIO,0CAAuB;QAEvB,+CAA0B;QAE1B,yDAAmC;QAEnC,oDAA8C;QAE9C,qDAA8C;QAerD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QAEjB,2EAA2E;QAC3E,kFAAkF;QAClF,yDAAyD;QACzD,6FAA6F;QAC7F,uBAAA,IAAI,8BAAc,SAIjB,MAAA,CAAC;QACF,uBAAA,IAAI,sCAAsB,SAGzB,MAAA,CAAC;QACF,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAE3B,uBAAA,IAAI,gCAAgB,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,MAAA,CAAC;QAEH,uBAAA,IAAI,sCAAsB,iBAAiB,MAAA,CAAC;QAE5C,uBAAA,IAAI,2BAAW,mBAAmB,CAAC,aAAa,CAAC,MAAA,CAAC;QAElD,uBAAA,IAAI,qCACF,uBAAA,IAAI,0CAAmB;YACvB,QAAQ,CACN,GAAG,EAAE;gBACH,uBAAA,IAAI,iEAAc,MAAlB,IAAI,CAAgB,CAAC,KAAK;gBACxB,0BAA0B;gBAC1B,CAAC,KAAK,EAAE,EAAE,CAAC,uBAAA,IAAI,kCAAW,CAAC,gBAAgB,EAAE,CAAC,KAAK,CAAC,CACrD,CAAC;YACJ,CAAC,EACD,uBAAA,IAAI,0CAAmB,CAAC,UAAU;gBAChC,cAAc,CAAC,EAAE,EAAE,QAAQ,CAAC,MAAM,CAAC,EACrC;gBACE,OAAO,EACL,uBAAA,IAAI,0CAAmB,CAAC,aAAa;oBACrC,cAAc,CAAC,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC;aACrC,CACF,MAAA,CAAC;QAEJ,uBAAA,IAAI,0CAA0B,uBAAA,IAAI,oCAAa;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,uBAAA,IAAI,uEAAoB,MAAxB,IAAI,EACF,KAAK,CAAC,KAAK,CAAC,SAAS,EACrB,KAAK,CAAC,IAAwB,CAC/B,CAAC;gBAEF,uBAAA,IAAI,yCAAkB,EAAE,KAAxB,IAAI,CAAsB,CAAC;YAC7B,CAAC;QACH,CAAC,CAAC,MAAA,CAAC;QAEL,uBAAA,IAAI,kCAAW,CAAC,qBAAqB,CACnC,GAAG,IAAI,CAAC,IAAI,oBAAoB,EAChC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAClC,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACO,KAAK,CAAC,UAAU,CAMxB,OAMC;QAED,OAAO,uBAAA,IAAI,oCAAa,CAAC,UAAU,CAAC;YAClC,GAAG,OAAO;YACV,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,CACnB,uBAAA,IAAI,+BAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;SACvD,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACO,KAAK,CAAC,kBAAkB,CAOhC,OAMC,EACD,SAAsB;QAEtB,MAAM,KAAK,GAAG,uBAAA,IAAI,oCAAa,CAAC,aAAa,EAAE,CAAC;QAEhD,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAA4C;YAClE,QAAQ,EAAE,OAAO,CAAC,QAAQ;SAC3B,CAAC,CAAC;QAEH,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAClD,MAAM,MAAM,GAAG,MAAM,uBAAA,IAAI,oCAAa,CAAC,kBAAkB,CAAC;gBACxD,GAAG,OAAO;gBACV,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,CACnB,uBAAA,IAAI,+BAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,CACxB,OAAO,CAAC,OAAO,CAAC;oBACd,GAAG,OAAO;oBACV,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,SAAS;iBAC1C,CAAC,CACH;aACJ,CAAC,CAAC;YAEH,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACzB,CAAC;QAED,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC;QACnC,MAAM,QAAQ,GAAG,OAAO,CAAC,oBAAoB,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;QAEjE,MAAM,SAAS,GAAG,SAAS,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;QAE1E,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,KAAK,CAAC,SAAS,EAAE;YAC1C,IAAI,EAAE;gBACJ,SAAS,EAAE;oBACT,SAAS;oBACT,SAAS;iBACV;aACF;SACF,CAAC,CAAC;QAEH,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,OAA2C,EAC3C,OAA2B;QAE3B,OAAO,uBAAA,IAAI,oCAAa,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED;;OAEG;IACH,IAAI;QACF,uBAAA,IAAI,8DAAW,MAAf,IAAI,CAAa,CAAC,KAAK;QACrB,0BAA0B;QAC1B,CAAC,KAAK,EAAE,EAAE,CAAC,uBAAA,IAAI,kCAAW,CAAC,gBAAgB,EAAE,CAAC,KAAK,CAAC,CACrD,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,OAAO;QACL,uBAAA,IAAI,yCAAkB,EAAE,MAAM,EAAE,CAAC;QACjC,uBAAA,IAAI,8CAAuB,MAA3B,IAAI,CAAyB,CAAC;QAC9B,uBAAA,IAAI,oCAAa,CAAC,KAAK,EAAE,CAAC;QAC1B,IAAI,CAAC,SAAS,CAAC,kBAAkB,EAAE,CAAC;QACpC,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,CAAC;IAChC,CAAC;CAqGF;qdA7FqB,IAAY,EAAE,IAAsB;IACtD,MAAM,KAAK,GACT,IAAI,KAAK,OAAO,IAAI,IAAI,KAAK,SAAS;QACpC,CAAC,CAAC,SAAS,CAAC,uBAAA,IAAI,oCAAa,EAAE;YAC3B,oBAAoB,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,SAAS,KAAK,IAAI;SAC1D,CAAC;QACJ,CAAC,CAAC,IAAI,CAAC;IAEX,uBAAA,IAAI,kCAAW,CAAC,OAAO,CACrB,GAAG,IAAI,CAAC,IAAI,eAAwB,EACpC;QACE,IAAI;QACJ,IAAI;QACJ,KAAK;KAC4B,CACpC,CAAC;IAEF,uBAAA,IAAI,kCAAW,CAAC,OAAO,CACrB,GAAG,IAAI,CAAC,IAAI,iBAAiB,IAAI,EAAW,EAC5C;QACE,IAAI;QACJ,KAAK;KACoC,CAC5C,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,KAAK;IACH,MAAM,KAAK,GAAG,SAAS,CAAC,uBAAA,IAAI,oCAAa,EAAE;QACzC,yDAAyD;QACzD,oBAAoB,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,KAAK,SAAS;KAClE,CAAC,CAAC;IAEH,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,IAAI,KAAK,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC/D,MAAM,uBAAA,IAAI,0CAAmB,CAAC,IAAI,CAChC,2BAA2B,EAC3B,IAAI,CAAC,IAAI,EACT,mBAAmB,CACpB,CAAC;QACF,OAAO;IACT,CAAC;IAED,MAAM,KAAK,GAAmB;QAC5B,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;QACrB,KAAK;KACN,CAAC;IAEF,MAAM,uBAAA,IAAI,0CAAmB,CAAC,IAAI,CAChC,wBAAwB,EACxB,IAAI,CAAC,IAAI,EACT,mBAAmB,EACnB,KAAwB,CACzB,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,KAAK;IACH,IAAI,CAAC,uBAAA,IAAI,0CAAmB,EAAE,CAAC;QAC7B,OAAO;IACT,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,GAAG,MAAM,uBAAA,IAAI,0CAAmB,CAAC,IAAI,CACjE,wBAAwB,EACxB,IAAI,CAAC,IAAI,EACT,mBAAmB,CACpB,CAAC;IAEF,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,OAAO;IACT,CAAC;IAED,MAAM,KAAK,GAAG,YAAyC,CAAC;IAExD,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC,SAAS,IAAI,uBAAA,IAAI,0CAAmB,CAAC,MAAM,EAAE,CAAC;QACnE,MAAM,uBAAA,IAAI,0CAAmB,CAAC,IAAI,CAChC,2BAA2B,EAC3B,IAAI,CAAC,IAAI,EACT,mBAAmB,CACpB,CAAC;QACF,OAAO;IACT,CAAC;IAED,OAAO,CAAC,uBAAA,IAAI,oCAAa,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;AAC1C,CAAC","sourcesContent":["import {\n  Messenger,\n  ActionConstraint,\n  EventConstraint,\n} from '@metamask/messenger';\nimport type {\n  StorageServiceGetItemAction,\n  StorageServiceRemoveItemAction,\n  StorageServiceSetItemAction,\n} from '@metamask/storage-service';\nimport { Duration, inMilliseconds } from '@metamask/utils';\nimport type { Json } from '@metamask/utils';\nimport {\n  DefaultOptions,\n  DehydratedState,\n  FetchInfiniteQueryOptions,\n  FetchQueryOptions,\n  InfiniteData,\n  InvalidateOptions,\n  InvalidateQueryFilters,\n  OmitKeyof,\n  QueryClient,\n  QueryClientConfig,\n  WithRequired,\n  dehydrate,\n  hydrate,\n} from '@tanstack/query-core';\nimport deepEqual from 'fast-deep-equal';\nimport { debounce, DebouncedFunc } from 'lodash';\n\nimport {\n  createServicePolicy,\n  CreateServicePolicyOptions,\n  ServicePolicy,\n} from './createServicePolicy';\n\n// Data service queries use the following format: ['ServiceActionName', ...params]\nexport type QueryKey = [string, ...Json[]];\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: (\n    filters?: InvalidateQueryFilters<Json>,\n    options?: InvalidateOptions,\n  ) => Promise<void>;\n};\n\ntype 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\ntype 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 Messenger<\n    ServiceName,\n    ActionConstraint,\n    EventConstraint,\n    // Use `any` to allow any parent to be set. `any` is harmless in a type constraint anyway,\n    // it's the one totally safe place to use it.\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    any\n  >,\n> {\n  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: ServiceMessenger;\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   * @returns The query results.\n   */\n  protected async fetchQuery<\n    TQueryFnData extends Json,\n    TError = unknown,\n    TData = TQueryFnData,\n    TQueryKey extends QueryKey = QueryKey,\n  >(\n    options: WithRequired<\n      OmitKeyof<\n        FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n        'retry' | 'retryDelay'\n      >,\n      'queryKey' | 'queryFn'\n    >,\n  ): Promise<TData> {\n    return this.#queryClient.fetchQuery({\n      ...options,\n      queryFn: (context) =>\n        this.#policy.execute(() => options.queryFn(context)),\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 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 = unknown,\n    TData extends TQueryFnData = TQueryFnData,\n    TQueryKey extends QueryKey = QueryKey,\n    TPageParam extends Json = Json,\n  >(\n    options: WithRequired<\n      OmitKeyof<\n        FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n        'retry' | 'retryDelay'\n      >,\n      'queryKey' | 'queryFn'\n    >,\n    pageParam?: TPageParam,\n  ): Promise<TData> {\n    const cache = this.#queryClient.getQueryCache();\n\n    const query = cache.find<TQueryFnData, TError, InfiniteData<TData>>({\n      queryKey: options.queryKey,\n    });\n\n    if (!query?.state.data || pageParam === undefined) {\n      const result = await this.#queryClient.fetchInfiniteQuery({\n        ...options,\n        queryFn: (context) =>\n          this.#policy.execute(() =>\n            options.queryFn({\n              ...context,\n              pageParam: context.pageParam ?? pageParam,\n            }),\n          ),\n      });\n\n      return result.pages[0];\n    }\n\n    const { pages } = query.state.data;\n    const previous = options.getPreviousPageParam?.(pages[0], pages);\n\n    const direction = deepEqual(pageParam, previous) ? 'backward' : 'forward';\n\n    const result = await query.fetch(undefined, {\n      meta: {\n        fetchMore: {\n          direction,\n          pageParam,\n        },\n      },\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<TPageData extends Json>(\n    filters?: InvalidateQueryFilters<TPageData>,\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"]}

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAKA,uCAQmB;AAPjB,+GAAA,kBAAkB,OAAA;AAClB,kHAAA,YAAY,OAAyB;AACrC,yGAAA,YAAY,OAAA;AACZ,4GAAA,eAAe,OAAA;AACf,+GAAA,kBAAkB,OAAA;AAClB,sGAAA,SAAS,OAAA;AACT,uGAAA,UAAU,OAAA;AAWZ,yDAAoD;AAA3C,kHAAA,eAAe,OAAA;AAExB,iEAM+B;AAL7B,qIAAA,8BAA8B,OAAA;AAC9B,iIAAA,0BAA0B,OAAA;AAC1B,uIAAA,gCAAgC,OAAA;AAChC,0HAAA,mBAAmB,OAAA;AACnB,0HAAA,mBAAmB,OAAA","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  DataServiceCacheUpdatedPayload,\n  DataServiceGranularCacheUpdatedPayload,\n  DataServiceInvalidateQueriesAction,\n  DataServiceCacheUpdatedEvent,\n  DataServiceGranularCacheUpdatedEvent,\n  QueryKey,\n} from './BaseDataService';\nexport { BaseDataService } from './BaseDataService';\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';\nexport type {\n  CreateServicePolicyOptions,\n  ServicePolicy,\n} from './createServicePolicy';\n"]}
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAKA,uCAQmB;AAPjB,+GAAA,kBAAkB,OAAA;AAClB,kHAAA,YAAY,OAAyB;AACrC,yGAAA,YAAY,OAAA;AACZ,4GAAA,eAAe,OAAA;AACf,+GAAA,kBAAkB,OAAA;AAClB,sGAAA,SAAS,OAAA;AACT,uGAAA,UAAU,OAAA;AAYZ,yDAAoD;AAA3C,kHAAA,eAAe,OAAA;AAExB,iEAM+B;AAL7B,qIAAA,8BAA8B,OAAA;AAC9B,iIAAA,0BAA0B,OAAA;AAC1B,uIAAA,gCAAgC,OAAA;AAChC,0HAAA,mBAAmB,OAAA;AACnB,0HAAA,mBAAmB,OAAA","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  DataServiceCacheUpdatedPayload,\n  DataServiceGranularCacheUpdatedPayload,\n  DataServiceInvalidateQueriesAction,\n  DataServiceCacheUpdatedEvent,\n  DataServiceGranularCacheUpdatedEvent,\n  QueryKey,\n  PersistenceConfiguration,\n} from './BaseDataService';\nexport { BaseDataService } from './BaseDataService';\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';\nexport type {\n  CreateServicePolicyOptions,\n  ServicePolicy,\n} from './createServicePolicy';\n"]}

package/dist/index.d.cts

@@ -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 { DataServiceCacheUpdatedPayload, DataServiceGranularCacheUpdatedPayload, DataServiceInvalidateQueriesAction, DataServiceCacheUpdatedEvent, DataServiceGranularCacheUpdatedEvent, QueryKey, } from "./BaseDataService.cjs";
+export type { DataServiceCacheUpdatedPayload, DataServiceGranularCacheUpdatedPayload, DataServiceInvalidateQueriesAction, DataServiceCacheUpdatedEvent, DataServiceGranularCacheUpdatedEvent, QueryKey, PersistenceConfiguration, } from "./BaseDataService.cjs";
 export { BaseDataService } from "./BaseDataService.cjs";
 export { DEFAULT_CIRCUIT_BREAK_DURATION, DEFAULT_DEGRADED_THRESHOLD, DEFAULT_MAX_CONSECUTIVE_FAILURES, DEFAULT_MAX_RETRIES, createServicePolicy, } from "./createServicePolicy.cjs";
 export type { CreateServicePolicyOptions, ServicePolicy, } from "./createServicePolicy.cjs";

package/dist/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,KAAK,IAAI,cAAc,EACvB,aAAa,IAAI,sBAAsB,GACxC,kBAAkB;AAEnB,OAAO,EACL,kBAAkB,EAClB,YAAY,IAAI,qBAAqB,EACrC,YAAY,EACZ,eAAe,EACf,kBAAkB,EAClB,SAAS,EACT,UAAU,GACX,kBAAkB;AAEnB,YAAY,EACV,8BAA8B,EAC9B,sCAAsC,EACtC,kCAAkC,EAClC,4BAA4B,EAC5B,oCAAoC,EACpC,QAAQ,GACT,8BAA0B;AAC3B,OAAO,EAAE,eAAe,EAAE,8BAA0B;AAEpD,OAAO,EACL,8BAA8B,EAC9B,0BAA0B,EAC1B,gCAAgC,EAChC,mBAAmB,EACnB,mBAAmB,GACpB,kCAA8B;AAC/B,YAAY,EACV,0BAA0B,EAC1B,aAAa,GACd,kCAA8B"}
+{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,KAAK,IAAI,cAAc,EACvB,aAAa,IAAI,sBAAsB,GACxC,kBAAkB;AAEnB,OAAO,EACL,kBAAkB,EAClB,YAAY,IAAI,qBAAqB,EACrC,YAAY,EACZ,eAAe,EACf,kBAAkB,EAClB,SAAS,EACT,UAAU,GACX,kBAAkB;AAEnB,YAAY,EACV,8BAA8B,EAC9B,sCAAsC,EACtC,kCAAkC,EAClC,4BAA4B,EAC5B,oCAAoC,EACpC,QAAQ,EACR,wBAAwB,GACzB,8BAA0B;AAC3B,OAAO,EAAE,eAAe,EAAE,8BAA0B;AAEpD,OAAO,EACL,8BAA8B,EAC9B,0BAA0B,EAC1B,gCAAgC,EAChC,mBAAmB,EACnB,mBAAmB,GACpB,kCAA8B;AAC/B,YAAY,EACV,0BAA0B,EAC1B,aAAa,GACd,kCAA8B"}

package/dist/index.d.mts

@@ -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 { DataServiceCacheUpdatedPayload, DataServiceGranularCacheUpdatedPayload, DataServiceInvalidateQueriesAction, DataServiceCacheUpdatedEvent, DataServiceGranularCacheUpdatedEvent, QueryKey, } from "./BaseDataService.mjs";
+export type { DataServiceCacheUpdatedPayload, DataServiceGranularCacheUpdatedPayload, DataServiceInvalidateQueriesAction, DataServiceCacheUpdatedEvent, DataServiceGranularCacheUpdatedEvent, QueryKey, PersistenceConfiguration, } from "./BaseDataService.mjs";
 export { BaseDataService } from "./BaseDataService.mjs";
 export { DEFAULT_CIRCUIT_BREAK_DURATION, DEFAULT_DEGRADED_THRESHOLD, DEFAULT_MAX_CONSECUTIVE_FAILURES, DEFAULT_MAX_RETRIES, createServicePolicy, } from "./createServicePolicy.mjs";
 export type { CreateServicePolicyOptions, ServicePolicy, } from "./createServicePolicy.mjs";

package/dist/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,KAAK,IAAI,cAAc,EACvB,aAAa,IAAI,sBAAsB,GACxC,kBAAkB;AAEnB,OAAO,EACL,kBAAkB,EAClB,YAAY,IAAI,qBAAqB,EACrC,YAAY,EACZ,eAAe,EACf,kBAAkB,EAClB,SAAS,EACT,UAAU,GACX,kBAAkB;AAEnB,YAAY,EACV,8BAA8B,EAC9B,sCAAsC,EACtC,kCAAkC,EAClC,4BAA4B,EAC5B,oCAAoC,EACpC,QAAQ,GACT,8BAA0B;AAC3B,OAAO,EAAE,eAAe,EAAE,8BAA0B;AAEpD,OAAO,EACL,8BAA8B,EAC9B,0BAA0B,EAC1B,gCAAgC,EAChC,mBAAmB,EACnB,mBAAmB,GACpB,kCAA8B;AAC/B,YAAY,EACV,0BAA0B,EAC1B,aAAa,GACd,kCAA8B"}
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,KAAK,IAAI,cAAc,EACvB,aAAa,IAAI,sBAAsB,GACxC,kBAAkB;AAEnB,OAAO,EACL,kBAAkB,EAClB,YAAY,IAAI,qBAAqB,EACrC,YAAY,EACZ,eAAe,EACf,kBAAkB,EAClB,SAAS,EACT,UAAU,GACX,kBAAkB;AAEnB,YAAY,EACV,8BAA8B,EAC9B,sCAAsC,EACtC,kCAAkC,EAClC,4BAA4B,EAC5B,oCAAoC,EACpC,QAAQ,EACR,wBAAwB,GACzB,8BAA0B;AAC3B,OAAO,EAAE,eAAe,EAAE,8BAA0B;AAEpD,OAAO,EACL,8BAA8B,EAC9B,0BAA0B,EAC1B,gCAAgC,EAChC,mBAAmB,EACnB,mBAAmB,GACpB,kCAA8B;AAC/B,YAAY,EACV,0BAA0B,EAC1B,aAAa,GACd,kCAA8B"}

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","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,EACX,kBAAkB;AAUnB,OAAO,EAAE,eAAe,EAAE,8BAA0B;AAEpD,OAAO,EACL,8BAA8B,EAC9B,0BAA0B,EAC1B,gCAAgC,EAChC,mBAAmB,EACnB,mBAAmB,EACpB,kCAA8B","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  DataServiceCacheUpdatedPayload,\n  DataServiceGranularCacheUpdatedPayload,\n  DataServiceInvalidateQueriesAction,\n  DataServiceCacheUpdatedEvent,\n  DataServiceGranularCacheUpdatedEvent,\n  QueryKey,\n} from './BaseDataService';\nexport { BaseDataService } from './BaseDataService';\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';\nexport type {\n  CreateServicePolicyOptions,\n  ServicePolicy,\n} from './createServicePolicy';\n"]}
+{"version":3,"file":"index.mjs","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,EACX,kBAAkB;AAWnB,OAAO,EAAE,eAAe,EAAE,8BAA0B;AAEpD,OAAO,EACL,8BAA8B,EAC9B,0BAA0B,EAC1B,gCAAgC,EAChC,mBAAmB,EACnB,mBAAmB,EACpB,kCAA8B","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  DataServiceCacheUpdatedPayload,\n  DataServiceGranularCacheUpdatedPayload,\n  DataServiceInvalidateQueriesAction,\n  DataServiceCacheUpdatedEvent,\n  DataServiceGranularCacheUpdatedEvent,\n  QueryKey,\n  PersistenceConfiguration,\n} from './BaseDataService';\nexport { BaseDataService } from './BaseDataService';\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';\nexport type {\n  CreateServicePolicyOptions,\n  ServicePolicy,\n} from './createServicePolicy';\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/base-data-service",
-  "version": "0.1.3-preview-72f0609be",
+  "version": "0.1.3-preview-6756b9ebc",
   "description": "Provides utilities for building data services",
   "keywords": [
     "Ethereum",
@@ -44,6 +44,8 @@
     "build:docs": "typedoc",
     "changelog:update": "../../scripts/update-changelog.sh @metamask/base-data-service",
     "changelog:validate": "../../scripts/validate-changelog.sh @metamask/base-data-service",
+    "lint:tsconfigs": "tsx ../../scripts/lint-tsconfigs/lint-tsconfigs.mts",
+    "lint:tsconfigs:fix": "tsx ../../scripts/lint-tsconfigs/lint-tsconfigs.mts --fix",
     "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --formatter oxfmt --check",
     "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --formatter oxfmt --generate",
     "publish:preview": "yarn npm publish --tag preview",
@@ -55,15 +57,18 @@
   },
   "dependencies": {
     "@metamask/messenger": "^2.0.0",
+    "@metamask/storage-service": "^1.0.2",
     "@metamask/utils": "^11.11.0",
     "@tanstack/query-core": "^4.43.0",
     "cockatiel": "^3.1.2",
-    "fast-deep-equal": "^3.1.3"
+    "fast-deep-equal": "^3.1.3",
+    "lodash": "^4.17.21"
   },
   "devDependencies": {
     "@metamask/auto-changelog": "^6.1.0",
     "@ts-bridge/cli": "^0.6.4",
     "@types/jest": "^29.5.14",
+    "@types/lodash": "^4.14.191",
     "deepmerge": "^4.2.2",
     "jest": "^29.7.0",
     "nock": "^13.3.1",