@metamask-previews/base-data-service 0.1.3-preview-d21e2aaf9 → 0.1.3-preview-6426280bb

package/CHANGELOG.md

@@ -40,6 +40,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - This is technically a breaking change, but this was not used in any of our codebases
 - **BREAKING:** Bump `@tanstack/query-core` from `^4.43.0` to `^5.62.16` ([#9712](https://github.com/MetaMask/core/pull/9712))
   - The option types accepted by `fetchQuery`, `fetchInfiniteQuery`, and `invalidateQueries` now follow the query-core v5 API. Subclasses need to rename `cacheTime` to `gcTime`.
+  - `fetchInfiniteQuery` now requires `initialPageParam` and `getNextPageParam`, matching query-core's options for infinite queries. This also lets `TPageParam` be inferred instead of spelled out in the type parameters.
 - Bump `@metamask/utils` from `^11.9.0` to `^11.11.0` ([#9074](https://github.com/MetaMask/core/pull/9074))
 - Bump `@metamask/controller-utils` from `^12.1.0` to `^12.3.0` ([#9058](https://github.com/MetaMask/core/pull/9058), [#9083](https://github.com/MetaMask/core/pull/9083), [#9218](https://github.com/MetaMask/core/pull/9218))
 - Bump `@metamask/messenger` from `^1.2.0` to `^2.0.0` ([#9392](https://github.com/MetaMask/core/pull/9392))

package/dist/BaseDataService.cjs

@@ -83,8 +83,13 @@ class BaseDataService {
     /**
      * Fetch a query.
      *
-     * @param options - The options defining the query. Keep in mind that `queryKey` and `queryFn` are required when using data services.
-     * Additionally `retry` and `retryDelay` are not available, retries can be customized using the `servicePolicyOptions`.
+     * @param options - The options defining the query. Note that although this
+     * method wraps `fetchQuery` from `@tanstack/query-core`, there are a few
+     * restrictions:
+     * - `queryKey` and `queryFn` are required
+     * - `queryFn` must be a function, not a skip token
+     * - `retry` and `retryDelay` are not available (retries can be customized
+     *   using the constructor's `servicePolicyOptions`).
      * @returns The query results.
      */
     async fetchQuery(options) {
@@ -96,33 +101,64 @@ class BaseDataService {
     /**
      * Fetch a paginated query.
      *
-     * @param options - The options defining the query. Keep in mind that `queryKey` and `queryFn` are required when using data services.
-     * Additionally `retry` and `retryDelay` are not available, retries can be customized using the `servicePolicyOptions`.
+     * @param options - The options defining the query. Note that although this
+     * method wraps `fetchInfiniteQuery` from `@tanstack/query-core`, there are a
+     * few differences:
+     * - `queryKey` and `queryFn` are required
+     * - `queryFn` must be a function, not a skip token
+     * - `retry` and `retryDelay` are not available (retries can be customized
+     *   using the constructor's `servicePolicyOptions`).
      * @param pageParam - An optional page parameter.
-     * @returns The query result, exclusively the requested page is returned.
+     * @returns A page's worth of data (i.e. what `queryFn` returns). Note that
+     * this is different from `@tanstack/query-core`'s `fetchInfiniteQuery`
+     * method, which returns all pages.
      */
     async fetchInfiniteQuery(options, pageParam) {
-        const cache = __classPrivateFieldGet(this, _BaseDataService_queryClient, "f").getQueryCache();
-        const query = cache.find({
+        // A missing per-call `pageParam` means "the first page", which uses the
+        // consumer's `initialPageParam`. A `null` initial param is preserved: `??`
+        // only falls back when the per-call param itself is missing.
+        const requestedPageParam = pageParam ?? options.initialPageParam;
+        const query = __classPrivateFieldGet(this, _BaseDataService_queryClient, "f")
+            .getQueryCache()
+            .find({
             queryKey: options.queryKey,
         });
-        if (!query?.state.data || pageParam === undefined) {
+        // The first page (or a cold cache) goes through query-core's
+        // `fetchInfiniteQuery`, which reuses the cached page while the query is
+        // fresh. A cold jump starts the query at the requested page by using it as
+        // the initial page param.
+        if (!query?.state.data ||
+            (0, fast_deep_equal_1.default)(requestedPageParam, options.initialPageParam)) {
             const result = await __classPrivateFieldGet(this, _BaseDataService_queryClient, "f").fetchInfiniteQuery({
                 ...options,
-                initialPageParam: pageParam ?? options.initialPageParam,
-                queryFn: (context) => __classPrivateFieldGet(this, _BaseDataService_policy, "f").execute(() => options.queryFn({
-                    ...context,
-                    pageParam: context.meta?.pageParam ?? context.pageParam,
-                })),
+                initialPageParam: requestedPageParam,
+                queryFn: (context) => __classPrivateFieldGet(this, _BaseDataService_policy, "f").execute(() => options.queryFn(context)),
             });
             return result.pages[0];
         }
+        // A later page on an existing query. v5 no longer forwards an explicit page
+        // param, so fetch it directly and merge it into the infinite cache,
+        // appending the next page or prepending an earlier one.
         const { pages, pageParams } = query.state.data;
-        const next = options.getNextPageParam(pages[pages.length - 1], pages, pageParams[pageParams.length - 1], pageParams);
-        const direction = (0, fast_deep_equal_1.default)(pageParam, next) ? 'forward' : 'backward';
-        const result = await query.fetch({ ...query.options, meta: { pageParam } }, { meta: { fetchMore: { direction } } });
-        const pageIndex = result.pageParams.findIndex((param) => (0, fast_deep_equal_1.default)(param, pageParam));
-        return result.pages[pageIndex];
+        const page = (await __classPrivateFieldGet(this, _BaseDataService_policy, "f").execute(() => options.queryFn({
+            client: __classPrivateFieldGet(this, _BaseDataService_queryClient, "f"),
+            queryKey: options.queryKey,
+            signal: new AbortController().signal,
+            pageParam: requestedPageParam,
+            direction: 'forward',
+            meta: options.meta,
+        })));
+        const nextPageParam = options.getNextPageParam(pages[pages.length - 1], pages, pageParams[pageParams.length - 1], pageParams);
+        __classPrivateFieldGet(this, _BaseDataService_queryClient, "f").setQueryData(options.queryKey, (0, fast_deep_equal_1.default)(requestedPageParam, nextPageParam)
+            ? {
+                pages: [...pages, page],
+                pageParams: [...pageParams, requestedPageParam],
+            }
+            : {
+                pages: [page, ...pages],
+                pageParams: [requestedPageParam, ...pageParams],
+            });
+        return page;
     }
     /**
      * Invalidate queries serviced by this data service.

package/dist/BaseDataService.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"BaseDataService.cjs","sourceRoot":"","sources":["../src/BaseDataService.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,mDAI6B;AAM7B,2CAA2D;AAE3D,qDAgB8B;AAC9B,sEAAwC;AACxC,mCAAiD;AAEjD,sEAIkC;AAiDlC,+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,4CAAmB,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,OAMuD;QAEvD,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,OAeG,EACH,SAAsB;QAEtB,MAAM,KAAK,GAAG,uBAAA,IAAI,oCAAa,CAAC,aAAa,EAAE,CAAC;QAEhD,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAItB;YACA,QAAQ,EAAE,OAAO,CAAC,QAAQ;SAC3B,CAAC,CAAC;QAEH,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAClD,MAAM,MAAM,GAAG,MAAM,uBAAA,IAAI,oCAAa,CAAC,kBAAkB,CAAC;gBACxD,GAAG,OAAO;gBACV,gBAAgB,EAAE,SAAS,IAAI,OAAO,CAAC,gBAAgB;gBACvD,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,IAAI,EAAE,SAAS,IAAI,OAAO,CAAC,SAAS;iBACxD,CAAC,CACH;aACJ,CAAC,CAAC;YAEH,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACzB,CAAC;QAED,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC;QAC/C,MAAM,IAAI,GAAG,OAAO,CAAC,gBAAgB,CACnC,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,EACvB,KAAK,EACL,UAAU,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,EACjC,UAAU,CACX,CAAC;QAEF,MAAM,SAAS,GAAG,IAAA,yBAAS,EAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC;QAEtE,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,KAAK,CAC9B,EAAE,GAAG,KAAK,CAAC,OAAO,EAAE,IAAI,EAAE,EAAE,SAAS,EAAE,EAAE,EACzC,EAAE,IAAI,EAAE,EAAE,SAAS,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,CACvC,CAAC;QAEF,MAAM,SAAS,GAAG,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CACtD,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,OAA0C,EAC1C,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;AA3WD,0CA2WC;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  DefaultError,\n  DefaultOptions,\n  DehydratedState,\n  FetchQueryOptions,\n  InfiniteData,\n  InfiniteQueryPageParamsOptions,\n  InvalidateOptions,\n  InvalidateQueryFilters,\n  OmitKeyof,\n  QueryClient,\n  QueryClientConfig,\n  QueryFunction,\n  WithRequired,\n  dehydrate,\n  hydrate,\n} from '@tanstack/query-core';\nimport deepEqual from 'fast-deep-equal';\nimport { debounce, DebouncedFunc } from 'lodash';\n\nimport {\n  createServicePolicy,\n  CreateServicePolicyOptions,\n  ServicePolicy,\n} from './createServicePolicy.js';\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<QueryKey>,\n    options?: InvalidateOptions,\n  ) => Promise<void>;\n};\n\nexport type DataServiceActions<ServiceName extends string> =\n  DataServiceInvalidateQueriesAction<ServiceName>;\n\ntype DataServiceAllowedActions =\n  | StorageServiceGetItemAction\n  | StorageServiceSetItemAction\n  | StorageServiceRemoveItemAction;\n\nexport type DataServiceCacheUpdatedEvent<ServiceName extends string> = {\n  type: `${ServiceName}:cacheUpdated`;\n  payload: [DataServiceCacheUpdatedPayload];\n};\n\nexport type DataServiceGranularCacheUpdatedEvent<ServiceName extends string> = {\n  type: `${ServiceName}:cacheUpdated:${string}`;\n  payload: [DataServiceGranularCacheUpdatedPayload];\n};\n\nexport type DataServiceEvents<ServiceName extends string> =\n  | DataServiceCacheUpdatedEvent<ServiceName>\n  | DataServiceGranularCacheUpdatedEvent<ServiceName>;\n\n// Defaults to apply to all data service queries if no default option specified\nconst QUERY_CLIENT_DEFAULTS: DefaultOptions = {\n  queries: {\n    retry: false,\n    staleTime: inMilliseconds(1, Duration.Minute),\n  },\n};\n\nexport const STORAGE_SERVICE_KEY = 'cache';\n\n/**\n * Options for persistence configuration.\n */\nexport type PersistenceConfiguration = {\n  /**\n   * The maximum age before the cache is treated as expired in milliseconds.\n   * This is relevant for rehydrating the state during initialization,\n   * if the cached state is too old it will be discarded.\n   */\n  maxAge: number;\n  /**\n   * The number of milliseconds to wait before triggering persistence following a cache update.\n   */\n  writeDelay?: number;\n  /**\n   * The maximum number of milliseconds to wait between persistence writes.\n   */\n  maxWriteDelay?: number;\n};\n\ntype PersistedCache = {\n  state: DehydratedState;\n  timestamp: number;\n};\n\nexport class BaseDataService<\n  ServiceName extends string,\n  ServiceMessenger extends 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 = DefaultError,\n    TData = TQueryFnData,\n    TQueryKey extends QueryKey = QueryKey,\n  >(\n    options: WithRequired<\n      OmitKeyof<\n        FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n        'retry' | 'retryDelay' | 'queryFn'\n      >,\n      'queryKey'\n    > & { queryFn: QueryFunction<TQueryFnData, TQueryKey> },\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 = DefaultError,\n    TData extends TQueryFnData = TQueryFnData,\n    TQueryKey extends QueryKey = QueryKey,\n    TPageParam extends Json = Json,\n  >(\n    options: WithRequired<\n      OmitKeyof<\n        FetchQueryOptions<\n          TQueryFnData,\n          TError,\n          InfiniteData<TData, TPageParam>,\n          TQueryKey,\n          TPageParam\n        >,\n        'retry' | 'retryDelay' | 'queryFn' | 'initialPageParam'\n      >,\n      'queryKey'\n    > &\n      InfiniteQueryPageParamsOptions<TQueryFnData, TPageParam> & {\n        queryFn: QueryFunction<TQueryFnData, TQueryKey, TPageParam>;\n      },\n    pageParam?: TPageParam,\n  ): Promise<TData> {\n    const cache = this.#queryClient.getQueryCache();\n\n    const query = cache.find<\n      TQueryFnData,\n      TError,\n      InfiniteData<TData, TPageParam>\n    >({\n      queryKey: options.queryKey,\n    });\n\n    if (!query?.state.data || pageParam === undefined) {\n      const result = await this.#queryClient.fetchInfiniteQuery({\n        ...options,\n        initialPageParam: pageParam ?? options.initialPageParam,\n        queryFn: (context) =>\n          this.#policy.execute(() =>\n            options.queryFn({\n              ...context,\n              pageParam: context.meta?.pageParam ?? context.pageParam,\n            }),\n          ),\n      });\n\n      return result.pages[0];\n    }\n\n    const { pages, pageParams } = query.state.data;\n    const next = options.getNextPageParam(\n      pages[pages.length - 1],\n      pages,\n      pageParams[pageParams.length - 1],\n      pageParams,\n    );\n\n    const direction = deepEqual(pageParam, next) ? 'forward' : 'backward';\n\n    const result = await query.fetch(\n      { ...query.options, meta: { pageParam } },\n      { meta: { fetchMore: { direction } } },\n    );\n\n    const pageIndex = result.pageParams.findIndex((param) =>\n      deepEqual(param, pageParam),\n    );\n\n    return result.pages[pageIndex];\n  }\n\n  /**\n   * Invalidate queries serviced by this data service.\n   *\n   * @param filters - Optional filter for selecting specific queries.\n   * @param options - Additional optional options for query invalidations.\n   * @returns Nothing.\n   */\n  async invalidateQueries(\n    filters?: InvalidateQueryFilters<QueryKey>,\n    options?: InvalidateOptions,\n  ): Promise<void> {\n    return this.#queryClient.invalidateQueries(filters, options);\n  }\n\n  /**\n   * Initialize the service, rehydrating the cache with persisted data if possible.\n   */\n  init(): void {\n    this.#loadCache().catch(\n      /* istanbul ignore next */\n      (error) => this.#messenger.captureException?.(error),\n    );\n  }\n\n  /**\n   * Prepares the service for garbage collection. This should be extended\n   * by any subclasses to clean up any additional connections or events.\n   */\n  destroy(): void {\n    this.#debouncedPersist?.cancel();\n    this.#queryCacheUnsubscribe();\n    this.#queryClient.clear();\n    this.messenger.clearSubscriptions();\n    this.messenger.clearActions();\n  }\n\n  /**\n   * Publish `cacheUpdated` events when a given query changes.\n   *\n   * @param hash The hash of the query.\n   * @param type The type of cache update.\n   */\n  #publishCacheUpdate(hash: string, type: CacheUpdatedType): void {\n    const state =\n      type === 'added' || type === 'updated'\n        ? dehydrate(this.#queryClient, {\n            shouldDehydrateQuery: (query) => query.queryHash === hash,\n          })\n        : null;\n\n    this.#messenger.publish(\n      `${this.name}:cacheUpdated` as const,\n      {\n        type,\n        hash,\n        state,\n      } as DataServiceCacheUpdatedPayload,\n    );\n\n    this.#messenger.publish(\n      `${this.name}:cacheUpdated:${hash}` as const,\n      {\n        type,\n        state,\n      } as DataServiceGranularCacheUpdatedPayload,\n    );\n  }\n\n  /**\n   * Persist the query client cache using the StorageService, if the cache is not empty.\n   *\n   * @returns Nothing.\n   */\n  async #persistCache(): Promise<void> {\n    const state = dehydrate(this.#queryClient, {\n      // This is the default, but we specify it to be explicit.\n      shouldDehydrateQuery: (query) => query.state.status === 'success',\n    });\n\n    if (state.queries.length === 0 && state.mutations.length === 0) {\n      await this.#externalMessenger.call(\n        'StorageService:removeItem',\n        this.name,\n        STORAGE_SERVICE_KEY,\n      );\n      return;\n    }\n\n    const cache: PersistedCache = {\n      timestamp: Date.now(),\n      state,\n    };\n\n    await this.#externalMessenger.call(\n      'StorageService:setItem',\n      this.name,\n      STORAGE_SERVICE_KEY,\n      cache as unknown as Json,\n    );\n  }\n\n  /**\n   * Load the query client cache from the StorageService, if persistence is configured\n   * and the persisted cache is not expired.\n   *\n   * @returns Nothing.\n   */\n  async #loadCache(): Promise<void> {\n    if (!this.#persistenceConfig) {\n      return;\n    }\n\n    const { result: untypedCache } = await this.#externalMessenger.call(\n      'StorageService:getItem',\n      this.name,\n      STORAGE_SERVICE_KEY,\n    );\n\n    if (!untypedCache) {\n      return;\n    }\n\n    const cache = untypedCache as unknown as PersistedCache;\n\n    if (Date.now() - cache.timestamp >= this.#persistenceConfig.maxAge) {\n      await this.#externalMessenger.call(\n        'StorageService:removeItem',\n        this.name,\n        STORAGE_SERVICE_KEY,\n      );\n      return;\n    }\n\n    hydrate(this.#queryClient, cache.state);\n  }\n}\n"]}
+{"version":3,"file":"BaseDataService.cjs","sourceRoot":"","sources":["../src/BaseDataService.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,mDAI6B;AAM7B,2CAA2D;AAE3D,qDAgB8B;AAC9B,sEAAwC;AACxC,mCAAiD;AAEjD,sEAIkC;AAiElC,+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;IA6B1B,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,4CAAmB,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;;;;;;;;;;;OAWG;IACO,KAAK,CAAC,UAAU,CAMxB,OAUC;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;;;;;;;;;;;;;;OAcG;IACO,KAAK,CAAC,kBAAkB,CAOhC,OAeG,EACH,SAAsB;QAEtB,wEAAwE;QACxE,2EAA2E;QAC3E,6DAA6D;QAC7D,MAAM,kBAAkB,GAAG,SAAS,IAAI,OAAO,CAAC,gBAAgB,CAAC;QAEjE,MAAM,KAAK,GAAG,uBAAA,IAAI,oCAAa;aAC5B,aAAa,EAAE;aACf,IAAI,CAAwD;YAC3D,QAAQ,EAAE,OAAO,CAAC,QAAQ;SAC3B,CAAC,CAAC;QAEL,6DAA6D;QAC7D,wEAAwE;QACxE,2EAA2E;QAC3E,0BAA0B;QAC1B,IACE,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI;YAClB,IAAA,yBAAS,EAAC,kBAAkB,EAAE,OAAO,CAAC,gBAAgB,CAAC,EACvD,CAAC;YACD,MAAM,MAAM,GAAG,MAAM,uBAAA,IAAI,oCAAa,CAAC,kBAAkB,CAAC;gBACxD,GAAG,OAAO;gBACV,gBAAgB,EAAE,kBAAkB;gBACpC,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,CACnB,uBAAA,IAAI,+BAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;aACvD,CAAC,CAAC;YAEH,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACzB,CAAC;QAED,4EAA4E;QAC5E,oEAAoE;QACpE,wDAAwD;QACxD,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC;QAC/C,MAAM,IAAI,GAAG,CAAC,MAAM,uBAAA,IAAI,+BAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,CAC5C,OAAO,CAAC,OAAO,CAAC;YACd,MAAM,EAAE,uBAAA,IAAI,oCAAa;YACzB,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,MAAM,EAAE,IAAI,eAAe,EAAE,CAAC,MAAM;YACpC,SAAS,EAAE,kBAAkB;YAC7B,SAAS,EAAE,SAAS;YACpB,IAAI,EAAE,OAAO,CAAC,IAAI;SACnB,CAAC,CACH,CAAU,CAAC;QACZ,MAAM,aAAa,GAAG,OAAO,CAAC,gBAAgB,CAC5C,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,EACvB,KAAK,EACL,UAAU,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,EACjC,UAAU,CACX,CAAC;QACF,uBAAA,IAAI,oCAAa,CAAC,YAAY,CAC5B,OAAO,CAAC,QAAQ,EAChB,IAAA,yBAAS,EAAC,kBAAkB,EAAE,aAAa,CAAC;YAC1C,CAAC,CAAC;gBACE,KAAK,EAAE,CAAC,GAAG,KAAK,EAAE,IAAI,CAAC;gBACvB,UAAU,EAAE,CAAC,GAAG,UAAU,EAAE,kBAAkB,CAAC;aAChD;YACH,CAAC,CAAC;gBACE,KAAK,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,CAAC;gBACvB,UAAU,EAAE,CAAC,kBAAkB,EAAE,GAAG,UAAU,CAAC;aAChD,CACN,CAAC;QAEF,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAA0C,EAC1C,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;AApYD,0CAoYC;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  DefaultError,\n  DefaultOptions,\n  DehydratedState,\n  FetchQueryOptions,\n  InfiniteData,\n  InfiniteQueryPageParamsOptions,\n  InvalidateOptions,\n  InvalidateQueryFilters,\n  OmitKeyof,\n  QueryClient,\n  QueryClientConfig,\n  QueryFunction,\n  WithRequired,\n  dehydrate,\n  hydrate,\n} from '@tanstack/query-core';\nimport deepEqual from 'fast-deep-equal';\nimport { debounce, DebouncedFunc } from 'lodash';\n\nimport {\n  createServicePolicy,\n  CreateServicePolicyOptions,\n  ServicePolicy,\n} from './createServicePolicy.js';\n\n// Data service queries use the following format: ['ServiceActionName', ...params]\nexport type QueryKey = [string, ...Json[]];\n\n/**\n * The supertype of all messengers, scoped to a namespace.\n *\n * @template Namespace - The namespace for the messenger's own actions and\n * events.\n */\nexport type BaseMessenger<Namespace extends string> = Messenger<\n  Namespace,\n  ActionConstraint,\n  EventConstraint,\n  // Use `any` to allow any parent to be set. `any` is harmless in a type constraint anyway,\n  // it's the one totally safe place to use it.\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  any\n>;\n\nexport type DataServiceGranularCacheUpdatedPayload =\n  | { type: 'added' | 'updated'; state: DehydratedState }\n  | {\n      type: 'removed';\n      state: null;\n    };\n\nexport type DataServiceCacheUpdatedPayload =\n  DataServiceGranularCacheUpdatedPayload & {\n    hash: string;\n  };\n\ntype CacheUpdatedType = DataServiceCacheUpdatedPayload['type'];\n\nexport type DataServiceInvalidateQueriesAction<ServiceName extends string> = {\n  type: `${ServiceName}:invalidateQueries`;\n  handler: BaseDataService<\n    ServiceName,\n    BaseMessenger<ServiceName>\n  >['invalidateQueries'];\n};\n\nexport type DataServiceActions<ServiceName extends string> =\n  DataServiceInvalidateQueriesAction<ServiceName>;\n\ntype DataServiceAllowedActions =\n  | StorageServiceGetItemAction\n  | StorageServiceSetItemAction\n  | StorageServiceRemoveItemAction;\n\nexport type DataServiceCacheUpdatedEvent<ServiceName extends string> = {\n  type: `${ServiceName}:cacheUpdated`;\n  payload: [DataServiceCacheUpdatedPayload];\n};\n\nexport type DataServiceGranularCacheUpdatedEvent<ServiceName extends string> = {\n  type: `${ServiceName}:cacheUpdated:${string}`;\n  payload: [DataServiceGranularCacheUpdatedPayload];\n};\n\nexport type DataServiceEvents<ServiceName extends string> =\n  | DataServiceCacheUpdatedEvent<ServiceName>\n  | DataServiceGranularCacheUpdatedEvent<ServiceName>;\n\n// Defaults to apply to all data service queries if no default option specified\nconst QUERY_CLIENT_DEFAULTS: DefaultOptions = {\n  queries: {\n    retry: false,\n    staleTime: inMilliseconds(1, Duration.Minute),\n  },\n};\n\nexport const STORAGE_SERVICE_KEY = 'cache';\n\n/**\n * Options for persistence configuration.\n */\nexport type PersistenceConfiguration = {\n  /**\n   * The maximum age before the cache is treated as expired in milliseconds.\n   * This is relevant for rehydrating the state during initialization,\n   * if the cached state is too old it will be discarded.\n   */\n  maxAge: number;\n  /**\n   * The number of milliseconds to wait before triggering persistence following a cache update.\n   */\n  writeDelay?: number;\n  /**\n   * The maximum number of milliseconds to wait between persistence writes.\n   */\n  maxWriteDelay?: number;\n};\n\ntype PersistedCache = {\n  state: DehydratedState;\n  timestamp: number;\n};\n\nexport class BaseDataService<\n  ServiceName extends string,\n  ServiceMessenger extends BaseMessenger<ServiceName>,\n> {\n  public readonly name: ServiceName;\n\n  readonly #messenger: Messenger<\n    ServiceName,\n    DataServiceActions<ServiceName>,\n    DataServiceEvents<ServiceName>\n  >;\n\n  readonly #externalMessenger: Messenger<\n    ServiceName,\n    DataServiceAllowedActions\n  >;\n\n  protected messenger: ServiceMessenger;\n\n  readonly #policy: ServicePolicy;\n\n  readonly #queryClient: QueryClient;\n\n  readonly #queryCacheUnsubscribe: () => void;\n\n  readonly #debouncedPersist?: DebouncedFunc<() => void>;\n\n  readonly #persistenceConfig?: PersistenceConfiguration;\n\n  constructor({\n    name,\n    messenger,\n    queryClientConfig = {},\n    policyOptions,\n    persistenceConfig,\n  }: {\n    name: ServiceName;\n    messenger: 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. Note that although this\n   * method wraps `fetchQuery` from `@tanstack/query-core`, there are a few\n   * restrictions:\n   * - `queryKey` and `queryFn` are required\n   * - `queryFn` must be a function, not a skip token\n   * - `retry` and `retryDelay` are not available (retries can be customized\n   *   using the constructor's `servicePolicyOptions`).\n   * @returns The query results.\n   */\n  protected async fetchQuery<\n    TQueryFnData extends Json,\n    TError = DefaultError,\n    TData = TQueryFnData,\n    TQueryKey extends QueryKey = QueryKey,\n  >(\n    options: WithRequired<\n      OmitKeyof<\n        FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n        'retry' | 'retryDelay' | 'queryFn'\n      >,\n      'queryKey'\n    > & {\n      // @tanstack/query-core's fetchQuery function accepts a \"skip\" token, but\n      // data services always provide a concrete query function.\n      queryFn: QueryFunction<TQueryFnData, TQueryKey>;\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. Note that although this\n   * method wraps `fetchInfiniteQuery` from `@tanstack/query-core`, there are a\n   * few differences:\n   * - `queryKey` and `queryFn` are required\n   * - `queryFn` must be a function, not a skip token\n   * - `retry` and `retryDelay` are not available (retries can be customized\n   *   using the constructor's `servicePolicyOptions`).\n   * @param pageParam - An optional page parameter.\n   * @returns A page's worth of data (i.e. what `queryFn` returns). Note that\n   * this is different from `@tanstack/query-core`'s `fetchInfiniteQuery`\n   * method, which returns all pages.\n   */\n  protected async fetchInfiniteQuery<\n    TQueryFnData extends Json,\n    TError = DefaultError,\n    TData extends TQueryFnData = TQueryFnData,\n    TQueryKey extends QueryKey = QueryKey,\n    TPageParam extends Json = Json,\n  >(\n    options: WithRequired<\n      OmitKeyof<\n        FetchQueryOptions<\n          TQueryFnData,\n          TError,\n          InfiniteData<TData, TPageParam>,\n          TQueryKey,\n          TPageParam\n        >,\n        'retry' | 'retryDelay' | 'queryFn' | 'initialPageParam'\n      >,\n      'queryKey'\n    > &\n      InfiniteQueryPageParamsOptions<TQueryFnData, TPageParam> & {\n        queryFn: QueryFunction<TQueryFnData, TQueryKey, TPageParam>;\n      },\n    pageParam?: TPageParam,\n  ): Promise<TData> {\n    // A missing per-call `pageParam` means \"the first page\", which uses the\n    // consumer's `initialPageParam`. A `null` initial param is preserved: `??`\n    // only falls back when the per-call param itself is missing.\n    const requestedPageParam = pageParam ?? options.initialPageParam;\n\n    const query = this.#queryClient\n      .getQueryCache()\n      .find<TQueryFnData, TError, InfiniteData<TData, TPageParam>>({\n        queryKey: options.queryKey,\n      });\n\n    // The first page (or a cold cache) goes through query-core's\n    // `fetchInfiniteQuery`, which reuses the cached page while the query is\n    // fresh. A cold jump starts the query at the requested page by using it as\n    // the initial page param.\n    if (\n      !query?.state.data ||\n      deepEqual(requestedPageParam, options.initialPageParam)\n    ) {\n      const result = await this.#queryClient.fetchInfiniteQuery({\n        ...options,\n        initialPageParam: requestedPageParam,\n        queryFn: (context) =>\n          this.#policy.execute(() => options.queryFn(context)),\n      });\n\n      return result.pages[0];\n    }\n\n    // A later page on an existing query. v5 no longer forwards an explicit page\n    // param, so fetch it directly and merge it into the infinite cache,\n    // appending the next page or prepending an earlier one.\n    const { pages, pageParams } = query.state.data;\n    const page = (await this.#policy.execute(() =>\n      options.queryFn({\n        client: this.#queryClient,\n        queryKey: options.queryKey,\n        signal: new AbortController().signal,\n        pageParam: requestedPageParam,\n        direction: 'forward',\n        meta: options.meta,\n      }),\n    )) as TData;\n    const nextPageParam = options.getNextPageParam(\n      pages[pages.length - 1],\n      pages,\n      pageParams[pageParams.length - 1],\n      pageParams,\n    );\n    this.#queryClient.setQueryData<InfiniteData<TData, TPageParam>>(\n      options.queryKey,\n      deepEqual(requestedPageParam, nextPageParam)\n        ? {\n            pages: [...pages, page],\n            pageParams: [...pageParams, requestedPageParam],\n          }\n        : {\n            pages: [page, ...pages],\n            pageParams: [requestedPageParam, ...pageParams],\n          },\n    );\n\n    return page;\n  }\n\n  /**\n   * Invalidate queries serviced by this data service.\n   *\n   * @param filters - Optional filter for selecting specific queries.\n   * @param options - Additional optional options for query invalidations.\n   * @returns Nothing.\n   */\n  async invalidateQueries(\n    filters?: InvalidateQueryFilters<QueryKey>,\n    options?: InvalidateOptions,\n  ): Promise<void> {\n    return this.#queryClient.invalidateQueries(filters, options);\n  }\n\n  /**\n   * Initialize the service, rehydrating the cache with persisted data if possible.\n   */\n  init(): void {\n    this.#loadCache().catch(\n      /* istanbul ignore next */\n      (error) => this.#messenger.captureException?.(error),\n    );\n  }\n\n  /**\n   * Prepares the service for garbage collection. This should be extended\n   * by any subclasses to clean up any additional connections or events.\n   */\n  destroy(): void {\n    this.#debouncedPersist?.cancel();\n    this.#queryCacheUnsubscribe();\n    this.#queryClient.clear();\n    this.messenger.clearSubscriptions();\n    this.messenger.clearActions();\n  }\n\n  /**\n   * Publish `cacheUpdated` events when a given query changes.\n   *\n   * @param hash The hash of the query.\n   * @param type The type of cache update.\n   */\n  #publishCacheUpdate(hash: string, type: CacheUpdatedType): void {\n    const state =\n      type === 'added' || type === 'updated'\n        ? dehydrate(this.#queryClient, {\n            shouldDehydrateQuery: (query) => query.queryHash === hash,\n          })\n        : null;\n\n    this.#messenger.publish(\n      `${this.name}:cacheUpdated` as const,\n      {\n        type,\n        hash,\n        state,\n      } as DataServiceCacheUpdatedPayload,\n    );\n\n    this.#messenger.publish(\n      `${this.name}:cacheUpdated:${hash}` as const,\n      {\n        type,\n        state,\n      } as DataServiceGranularCacheUpdatedPayload,\n    );\n  }\n\n  /**\n   * Persist the query client cache using the StorageService, if the cache is not empty.\n   *\n   * @returns Nothing.\n   */\n  async #persistCache(): Promise<void> {\n    const state = dehydrate(this.#queryClient, {\n      // This is the default, but we specify it to be explicit.\n      shouldDehydrateQuery: (query) => query.state.status === 'success',\n    });\n\n    if (state.queries.length === 0 && state.mutations.length === 0) {\n      await this.#externalMessenger.call(\n        'StorageService:removeItem',\n        this.name,\n        STORAGE_SERVICE_KEY,\n      );\n      return;\n    }\n\n    const cache: PersistedCache = {\n      timestamp: Date.now(),\n      state,\n    };\n\n    await this.#externalMessenger.call(\n      'StorageService:setItem',\n      this.name,\n      STORAGE_SERVICE_KEY,\n      cache as unknown as Json,\n    );\n  }\n\n  /**\n   * Load the query client cache from the StorageService, if persistence is configured\n   * and the persisted cache is not expired.\n   *\n   * @returns Nothing.\n   */\n  async #loadCache(): Promise<void> {\n    if (!this.#persistenceConfig) {\n      return;\n    }\n\n    const { result: untypedCache } = await this.#externalMessenger.call(\n      'StorageService:getItem',\n      this.name,\n      STORAGE_SERVICE_KEY,\n    );\n\n    if (!untypedCache) {\n      return;\n    }\n\n    const cache = untypedCache as unknown as PersistedCache;\n\n    if (Date.now() - cache.timestamp >= this.#persistenceConfig.maxAge) {\n      await this.#externalMessenger.call(\n        'StorageService:removeItem',\n        this.name,\n        STORAGE_SERVICE_KEY,\n      );\n      return;\n    }\n\n    hydrate(this.#queryClient, cache.state);\n  }\n}\n"]}

package/dist/BaseDataService.d.cts

@@ -3,6 +3,13 @@ import type { Json } from "@metamask/utils";
 import { DefaultError, DehydratedState, FetchQueryOptions, InfiniteData, InfiniteQueryPageParamsOptions, InvalidateOptions, InvalidateQueryFilters, OmitKeyof, QueryClientConfig, QueryFunction, WithRequired } from "@tanstack/query-core";
 import { CreateServicePolicyOptions } from "./createServicePolicy.cjs";
 export type QueryKey = [string, ...Json[]];
+/**
+ * The supertype of all messengers, scoped to a namespace.
+ *
+ * @template Namespace - The namespace for the messenger's own actions and
+ * events.
+ */
+export type BaseMessenger<Namespace extends string> = Messenger<Namespace, ActionConstraint, EventConstraint, any>;
 export type DataServiceGranularCacheUpdatedPayload = {
     type: 'added' | 'updated';
     state: DehydratedState;
@@ -15,7 +22,7 @@ export type DataServiceCacheUpdatedPayload = DataServiceGranularCacheUpdatedPayl
 };
 export type DataServiceInvalidateQueriesAction<ServiceName extends string> = {
     type: `${ServiceName}:invalidateQueries`;
-    handler: (filters?: InvalidateQueryFilters<QueryKey>, options?: InvalidateOptions) => Promise<void>;
+    handler: BaseDataService<ServiceName, BaseMessenger<ServiceName>>['invalidateQueries'];
 };
 export type DataServiceActions<ServiceName extends string> = DataServiceInvalidateQueriesAction<ServiceName>;
 export type DataServiceCacheUpdatedEvent<ServiceName extends string> = {
@@ -47,7 +54,7 @@ export type PersistenceConfiguration = {
      */
     maxWriteDelay?: number;
 };
-export declare class BaseDataService<ServiceName extends string, ServiceMessenger extends Messenger<ServiceName, ActionConstraint, EventConstraint, any>> {
+export declare class BaseDataService<ServiceName extends string, ServiceMessenger extends BaseMessenger<ServiceName>> {
     #private;
     readonly name: ServiceName;
     protected messenger: ServiceMessenger;
@@ -61,8 +68,13 @@ export declare class BaseDataService<ServiceName extends string, ServiceMessenge
     /**
      * Fetch a query.
      *
-     * @param options - The options defining the query. Keep in mind that `queryKey` and `queryFn` are required when using data services.
-     * Additionally `retry` and `retryDelay` are not available, retries can be customized using the `servicePolicyOptions`.
+     * @param options - The options defining the query. Note that although this
+     * method wraps `fetchQuery` from `@tanstack/query-core`, there are a few
+     * restrictions:
+     * - `queryKey` and `queryFn` are required
+     * - `queryFn` must be a function, not a skip token
+     * - `retry` and `retryDelay` are not available (retries can be customized
+     *   using the constructor's `servicePolicyOptions`).
      * @returns The query results.
      */
     protected fetchQuery<TQueryFnData extends Json, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: WithRequired<OmitKeyof<FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'retry' | 'retryDelay' | 'queryFn'>, 'queryKey'> & {
@@ -71,10 +83,17 @@ export declare class BaseDataService<ServiceName extends string, ServiceMessenge
     /**
      * Fetch a paginated query.
      *
-     * @param options - The options defining the query. Keep in mind that `queryKey` and `queryFn` are required when using data services.
-     * Additionally `retry` and `retryDelay` are not available, retries can be customized using the `servicePolicyOptions`.
+     * @param options - The options defining the query. Note that although this
+     * method wraps `fetchInfiniteQuery` from `@tanstack/query-core`, there are a
+     * few differences:
+     * - `queryKey` and `queryFn` are required
+     * - `queryFn` must be a function, not a skip token
+     * - `retry` and `retryDelay` are not available (retries can be customized
+     *   using the constructor's `servicePolicyOptions`).
      * @param pageParam - An optional page parameter.
-     * @returns The query result, exclusively the requested page is returned.
+     * @returns A page's worth of data (i.e. what `queryFn` returns). Note that
+     * this is different from `@tanstack/query-core`'s `fetchInfiniteQuery`
+     * method, which returns all pages.
      */
     protected fetchInfiniteQuery<TQueryFnData extends Json, TError = DefaultError, TData extends TQueryFnData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam extends Json = Json>(options: WithRequired<OmitKeyof<FetchQueryOptions<TQueryFnData, TError, InfiniteData<TData, TPageParam>, TQueryKey, TPageParam>, 'retry' | 'retryDelay' | 'queryFn' | 'initialPageParam'>, 'queryKey'> & InfiniteQueryPageParamsOptions<TQueryFnData, TPageParam> & {
         queryFn: QueryFunction<TQueryFnData, TQueryKey, TPageParam>;

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;AAO7B,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAC5C,OAAO,EACL,YAAY,EAEZ,eAAe,EACf,iBAAiB,EACjB,YAAY,EACZ,8BAA8B,EAC9B,iBAAiB,EACjB,sBAAsB,EACtB,SAAS,EAET,iBAAiB,EACjB,aAAa,EACb,YAAY,EAGb,6BAA6B;AAI9B,OAAO,EAEL,0BAA0B,EAE3B,kCAAiC;AAGlC,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,QAAQ,CAAC,EAC1C,OAAO,CAAC,EAAE,iBAAiB,KACxB,OAAO,CAAC,IAAI,CAAC,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,kBAAkB,CAAC,WAAW,SAAS,MAAM,IACvD,kCAAkC,CAAC,WAAW,CAAC,CAAC;AAOlD,MAAM,MAAM,4BAA4B,CAAC,WAAW,SAAS,MAAM,IAAI;IACrE,IAAI,EAAE,GAAG,WAAW,eAAe,CAAC;IACpC,OAAO,EAAE,CAAC,8BAA8B,CAAC,CAAC;CAC3C,CAAC;AAEF,MAAM,MAAM,oCAAoC,CAAC,WAAW,SAAS,MAAM,IAAI;IAC7E,IAAI,EAAE,GAAG,WAAW,iBAAiB,MAAM,EAAE,CAAC;IAC9C,OAAO,EAAE,CAAC,sCAAsC,CAAC,CAAC;CACnD,CAAC;AAEF,MAAM,MAAM,iBAAiB,CAAC,WAAW,SAAS,MAAM,IACpD,4BAA4B,CAAC,WAAW,CAAC,GACzC,oCAAoC,CAAC,WAAW,CAAC,CAAC;AAUtD,eAAO,MAAM,mBAAmB,UAAU,CAAC;AAE3C;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAOF,qBAAa,eAAe,CAC1B,WAAW,SAAS,MAAM,EAC1B,gBAAgB,SAAS,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,YAAY,EACrB,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,GAAG,SAAS,CACnC,EACD,UAAU,CACX,GAAG;QAAE,OAAO,EAAE,aAAa,CAAC,YAAY,EAAE,SAAS,CAAC,CAAA;KAAE,GACtD,OAAO,CAAC,KAAK,CAAC;IAQjB;;;;;;;OAOG;cACa,kBAAkB,CAChC,YAAY,SAAS,IAAI,EACzB,MAAM,GAAG,YAAY,EACrB,KAAK,SAAS,YAAY,GAAG,YAAY,EACzC,SAAS,SAAS,QAAQ,GAAG,QAAQ,EACrC,UAAU,SAAS,IAAI,GAAG,IAAI,EAE9B,OAAO,EAAE,YAAY,CACnB,SAAS,CACP,iBAAiB,CACf,YAAY,EACZ,MAAM,EACN,YAAY,CAAC,KAAK,EAAE,UAAU,CAAC,EAC/B,SAAS,EACT,UAAU,CACX,EACD,OAAO,GAAG,YAAY,GAAG,SAAS,GAAG,kBAAkB,CACxD,EACD,UAAU,CACX,GACC,8BAA8B,CAAC,YAAY,EAAE,UAAU,CAAC,GAAG;QACzD,OAAO,EAAE,aAAa,CAAC,YAAY,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC;KAC7D,EACH,SAAS,CAAC,EAAE,UAAU,GACrB,OAAO,CAAC,KAAK,CAAC;IAiDjB;;;;;;OAMG;IACG,iBAAiB,CACrB,OAAO,CAAC,EAAE,sBAAsB,CAAC,QAAQ,CAAC,EAC1C,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,IAAI,CAAC;IAIhB;;OAEG;IACH,IAAI,IAAI,IAAI;IAOZ;;;OAGG;IACH,OAAO,IAAI,IAAI;CA2GhB"}
+{"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,EACL,YAAY,EAEZ,eAAe,EACf,iBAAiB,EACjB,YAAY,EACZ,8BAA8B,EAC9B,iBAAiB,EACjB,sBAAsB,EACtB,SAAS,EAET,iBAAiB,EACjB,aAAa,EACb,YAAY,EAGb,6BAA6B;AAI9B,OAAO,EAEL,0BAA0B,EAE3B,kCAAiC;AAGlC,MAAM,MAAM,QAAQ,GAAG,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;AAE3C;;;;;GAKG;AACH,MAAM,MAAM,aAAa,CAAC,SAAS,SAAS,MAAM,IAAI,SAAS,CAC7D,SAAS,EACT,gBAAgB,EAChB,eAAe,EAIf,GAAG,CACJ,CAAC;AAEF,MAAM,MAAM,sCAAsC,GAC9C;IAAE,IAAI,EAAE,OAAO,GAAG,SAAS,CAAC;IAAC,KAAK,EAAE,eAAe,CAAA;CAAE,GACrD;IACE,IAAI,EAAE,SAAS,CAAC;IAChB,KAAK,EAAE,IAAI,CAAC;CACb,CAAC;AAEN,MAAM,MAAM,8BAA8B,GACxC,sCAAsC,GAAG;IACvC,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAIJ,MAAM,MAAM,kCAAkC,CAAC,WAAW,SAAS,MAAM,IAAI;IAC3E,IAAI,EAAE,GAAG,WAAW,oBAAoB,CAAC;IACzC,OAAO,EAAE,eAAe,CACtB,WAAW,EACX,aAAa,CAAC,WAAW,CAAC,CAC3B,CAAC,mBAAmB,CAAC,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,kBAAkB,CAAC,WAAW,SAAS,MAAM,IACvD,kCAAkC,CAAC,WAAW,CAAC,CAAC;AAOlD,MAAM,MAAM,4BAA4B,CAAC,WAAW,SAAS,MAAM,IAAI;IACrE,IAAI,EAAE,GAAG,WAAW,eAAe,CAAC;IACpC,OAAO,EAAE,CAAC,8BAA8B,CAAC,CAAC;CAC3C,CAAC;AAEF,MAAM,MAAM,oCAAoC,CAAC,WAAW,SAAS,MAAM,IAAI;IAC7E,IAAI,EAAE,GAAG,WAAW,iBAAiB,MAAM,EAAE,CAAC;IAC9C,OAAO,EAAE,CAAC,sCAAsC,CAAC,CAAC;CACnD,CAAC;AAEF,MAAM,MAAM,iBAAiB,CAAC,WAAW,SAAS,MAAM,IACpD,4BAA4B,CAAC,WAAW,CAAC,GACzC,oCAAoC,CAAC,WAAW,CAAC,CAAC;AAUtD,eAAO,MAAM,mBAAmB,UAAU,CAAC;AAE3C;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAOF,qBAAa,eAAe,CAC1B,WAAW,SAAS,MAAM,EAC1B,gBAAgB,SAAS,aAAa,CAAC,WAAW,CAAC;;IAEnD,SAAgB,IAAI,EAAE,WAAW,CAAC;IAalC,SAAS,CAAC,SAAS,EAAE,gBAAgB,CAAC;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;;;;;;;;;;;OAWG;cACa,UAAU,CACxB,YAAY,SAAS,IAAI,EACzB,MAAM,GAAG,YAAY,EACrB,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,GAAG,SAAS,CACnC,EACD,UAAU,CACX,GAAG;QAGF,OAAO,EAAE,aAAa,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;KACjD,GACA,OAAO,CAAC,KAAK,CAAC;IAQjB;;;;;;;;;;;;;;OAcG;cACa,kBAAkB,CAChC,YAAY,SAAS,IAAI,EACzB,MAAM,GAAG,YAAY,EACrB,KAAK,SAAS,YAAY,GAAG,YAAY,EACzC,SAAS,SAAS,QAAQ,GAAG,QAAQ,EACrC,UAAU,SAAS,IAAI,GAAG,IAAI,EAE9B,OAAO,EAAE,YAAY,CACnB,SAAS,CACP,iBAAiB,CACf,YAAY,EACZ,MAAM,EACN,YAAY,CAAC,KAAK,EAAE,UAAU,CAAC,EAC/B,SAAS,EACT,UAAU,CACX,EACD,OAAO,GAAG,YAAY,GAAG,SAAS,GAAG,kBAAkB,CACxD,EACD,UAAU,CACX,GACC,8BAA8B,CAAC,YAAY,EAAE,UAAU,CAAC,GAAG;QACzD,OAAO,EAAE,aAAa,CAAC,YAAY,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC;KAC7D,EACH,SAAS,CAAC,EAAE,UAAU,GACrB,OAAO,CAAC,KAAK,CAAC;IAkEjB;;;;;;OAMG;IACG,iBAAiB,CACrB,OAAO,CAAC,EAAE,sBAAsB,CAAC,QAAQ,CAAC,EAC1C,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

@@ -3,6 +3,13 @@ import type { Json } from "@metamask/utils";
 import { DefaultError, DehydratedState, FetchQueryOptions, InfiniteData, InfiniteQueryPageParamsOptions, InvalidateOptions, InvalidateQueryFilters, OmitKeyof, QueryClientConfig, QueryFunction, WithRequired } from "@tanstack/query-core";
 import { CreateServicePolicyOptions } from "./createServicePolicy.mjs";
 export type QueryKey = [string, ...Json[]];
+/**
+ * The supertype of all messengers, scoped to a namespace.
+ *
+ * @template Namespace - The namespace for the messenger's own actions and
+ * events.
+ */
+export type BaseMessenger<Namespace extends string> = Messenger<Namespace, ActionConstraint, EventConstraint, any>;
 export type DataServiceGranularCacheUpdatedPayload = {
     type: 'added' | 'updated';
     state: DehydratedState;
@@ -15,7 +22,7 @@ export type DataServiceCacheUpdatedPayload = DataServiceGranularCacheUpdatedPayl
 };
 export type DataServiceInvalidateQueriesAction<ServiceName extends string> = {
     type: `${ServiceName}:invalidateQueries`;
-    handler: (filters?: InvalidateQueryFilters<QueryKey>, options?: InvalidateOptions) => Promise<void>;
+    handler: BaseDataService<ServiceName, BaseMessenger<ServiceName>>['invalidateQueries'];
 };
 export type DataServiceActions<ServiceName extends string> = DataServiceInvalidateQueriesAction<ServiceName>;
 export type DataServiceCacheUpdatedEvent<ServiceName extends string> = {
@@ -47,7 +54,7 @@ export type PersistenceConfiguration = {
      */
     maxWriteDelay?: number;
 };
-export declare class BaseDataService<ServiceName extends string, ServiceMessenger extends Messenger<ServiceName, ActionConstraint, EventConstraint, any>> {
+export declare class BaseDataService<ServiceName extends string, ServiceMessenger extends BaseMessenger<ServiceName>> {
     #private;
     readonly name: ServiceName;
     protected messenger: ServiceMessenger;
@@ -61,8 +68,13 @@ export declare class BaseDataService<ServiceName extends string, ServiceMessenge
     /**
      * Fetch a query.
      *
-     * @param options - The options defining the query. Keep in mind that `queryKey` and `queryFn` are required when using data services.
-     * Additionally `retry` and `retryDelay` are not available, retries can be customized using the `servicePolicyOptions`.
+     * @param options - The options defining the query. Note that although this
+     * method wraps `fetchQuery` from `@tanstack/query-core`, there are a few
+     * restrictions:
+     * - `queryKey` and `queryFn` are required
+     * - `queryFn` must be a function, not a skip token
+     * - `retry` and `retryDelay` are not available (retries can be customized
+     *   using the constructor's `servicePolicyOptions`).
      * @returns The query results.
      */
     protected fetchQuery<TQueryFnData extends Json, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: WithRequired<OmitKeyof<FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'retry' | 'retryDelay' | 'queryFn'>, 'queryKey'> & {
@@ -71,10 +83,17 @@ export declare class BaseDataService<ServiceName extends string, ServiceMessenge
     /**
      * Fetch a paginated query.
      *
-     * @param options - The options defining the query. Keep in mind that `queryKey` and `queryFn` are required when using data services.
-     * Additionally `retry` and `retryDelay` are not available, retries can be customized using the `servicePolicyOptions`.
+     * @param options - The options defining the query. Note that although this
+     * method wraps `fetchInfiniteQuery` from `@tanstack/query-core`, there are a
+     * few differences:
+     * - `queryKey` and `queryFn` are required
+     * - `queryFn` must be a function, not a skip token
+     * - `retry` and `retryDelay` are not available (retries can be customized
+     *   using the constructor's `servicePolicyOptions`).
      * @param pageParam - An optional page parameter.
-     * @returns The query result, exclusively the requested page is returned.
+     * @returns A page's worth of data (i.e. what `queryFn` returns). Note that
+     * this is different from `@tanstack/query-core`'s `fetchInfiniteQuery`
+     * method, which returns all pages.
      */
     protected fetchInfiniteQuery<TQueryFnData extends Json, TError = DefaultError, TData extends TQueryFnData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam extends Json = Json>(options: WithRequired<OmitKeyof<FetchQueryOptions<TQueryFnData, TError, InfiniteData<TData, TPageParam>, TQueryKey, TPageParam>, 'retry' | 'retryDelay' | 'queryFn' | 'initialPageParam'>, 'queryKey'> & InfiniteQueryPageParamsOptions<TQueryFnData, TPageParam> & {
         queryFn: QueryFunction<TQueryFnData, TQueryKey, TPageParam>;

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;AAO7B,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAC5C,OAAO,EACL,YAAY,EAEZ,eAAe,EACf,iBAAiB,EACjB,YAAY,EACZ,8BAA8B,EAC9B,iBAAiB,EACjB,sBAAsB,EACtB,SAAS,EAET,iBAAiB,EACjB,aAAa,EACb,YAAY,EAGb,6BAA6B;AAI9B,OAAO,EAEL,0BAA0B,EAE3B,kCAAiC;AAGlC,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,QAAQ,CAAC,EAC1C,OAAO,CAAC,EAAE,iBAAiB,KACxB,OAAO,CAAC,IAAI,CAAC,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,kBAAkB,CAAC,WAAW,SAAS,MAAM,IACvD,kCAAkC,CAAC,WAAW,CAAC,CAAC;AAOlD,MAAM,MAAM,4BAA4B,CAAC,WAAW,SAAS,MAAM,IAAI;IACrE,IAAI,EAAE,GAAG,WAAW,eAAe,CAAC;IACpC,OAAO,EAAE,CAAC,8BAA8B,CAAC,CAAC;CAC3C,CAAC;AAEF,MAAM,MAAM,oCAAoC,CAAC,WAAW,SAAS,MAAM,IAAI;IAC7E,IAAI,EAAE,GAAG,WAAW,iBAAiB,MAAM,EAAE,CAAC;IAC9C,OAAO,EAAE,CAAC,sCAAsC,CAAC,CAAC;CACnD,CAAC;AAEF,MAAM,MAAM,iBAAiB,CAAC,WAAW,SAAS,MAAM,IACpD,4BAA4B,CAAC,WAAW,CAAC,GACzC,oCAAoC,CAAC,WAAW,CAAC,CAAC;AAUtD,eAAO,MAAM,mBAAmB,UAAU,CAAC;AAE3C;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAOF,qBAAa,eAAe,CAC1B,WAAW,SAAS,MAAM,EAC1B,gBAAgB,SAAS,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,YAAY,EACrB,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,GAAG,SAAS,CACnC,EACD,UAAU,CACX,GAAG;QAAE,OAAO,EAAE,aAAa,CAAC,YAAY,EAAE,SAAS,CAAC,CAAA;KAAE,GACtD,OAAO,CAAC,KAAK,CAAC;IAQjB;;;;;;;OAOG;cACa,kBAAkB,CAChC,YAAY,SAAS,IAAI,EACzB,MAAM,GAAG,YAAY,EACrB,KAAK,SAAS,YAAY,GAAG,YAAY,EACzC,SAAS,SAAS,QAAQ,GAAG,QAAQ,EACrC,UAAU,SAAS,IAAI,GAAG,IAAI,EAE9B,OAAO,EAAE,YAAY,CACnB,SAAS,CACP,iBAAiB,CACf,YAAY,EACZ,MAAM,EACN,YAAY,CAAC,KAAK,EAAE,UAAU,CAAC,EAC/B,SAAS,EACT,UAAU,CACX,EACD,OAAO,GAAG,YAAY,GAAG,SAAS,GAAG,kBAAkB,CACxD,EACD,UAAU,CACX,GACC,8BAA8B,CAAC,YAAY,EAAE,UAAU,CAAC,GAAG;QACzD,OAAO,EAAE,aAAa,CAAC,YAAY,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC;KAC7D,EACH,SAAS,CAAC,EAAE,UAAU,GACrB,OAAO,CAAC,KAAK,CAAC;IAiDjB;;;;;;OAMG;IACG,iBAAiB,CACrB,OAAO,CAAC,EAAE,sBAAsB,CAAC,QAAQ,CAAC,EAC1C,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,IAAI,CAAC;IAIhB;;OAEG;IACH,IAAI,IAAI,IAAI;IAOZ;;;OAGG;IACH,OAAO,IAAI,IAAI;CA2GhB"}
+{"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,EACL,YAAY,EAEZ,eAAe,EACf,iBAAiB,EACjB,YAAY,EACZ,8BAA8B,EAC9B,iBAAiB,EACjB,sBAAsB,EACtB,SAAS,EAET,iBAAiB,EACjB,aAAa,EACb,YAAY,EAGb,6BAA6B;AAI9B,OAAO,EAEL,0BAA0B,EAE3B,kCAAiC;AAGlC,MAAM,MAAM,QAAQ,GAAG,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;AAE3C;;;;;GAKG;AACH,MAAM,MAAM,aAAa,CAAC,SAAS,SAAS,MAAM,IAAI,SAAS,CAC7D,SAAS,EACT,gBAAgB,EAChB,eAAe,EAIf,GAAG,CACJ,CAAC;AAEF,MAAM,MAAM,sCAAsC,GAC9C;IAAE,IAAI,EAAE,OAAO,GAAG,SAAS,CAAC;IAAC,KAAK,EAAE,eAAe,CAAA;CAAE,GACrD;IACE,IAAI,EAAE,SAAS,CAAC;IAChB,KAAK,EAAE,IAAI,CAAC;CACb,CAAC;AAEN,MAAM,MAAM,8BAA8B,GACxC,sCAAsC,GAAG;IACvC,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAIJ,MAAM,MAAM,kCAAkC,CAAC,WAAW,SAAS,MAAM,IAAI;IAC3E,IAAI,EAAE,GAAG,WAAW,oBAAoB,CAAC;IACzC,OAAO,EAAE,eAAe,CACtB,WAAW,EACX,aAAa,CAAC,WAAW,CAAC,CAC3B,CAAC,mBAAmB,CAAC,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,kBAAkB,CAAC,WAAW,SAAS,MAAM,IACvD,kCAAkC,CAAC,WAAW,CAAC,CAAC;AAOlD,MAAM,MAAM,4BAA4B,CAAC,WAAW,SAAS,MAAM,IAAI;IACrE,IAAI,EAAE,GAAG,WAAW,eAAe,CAAC;IACpC,OAAO,EAAE,CAAC,8BAA8B,CAAC,CAAC;CAC3C,CAAC;AAEF,MAAM,MAAM,oCAAoC,CAAC,WAAW,SAAS,MAAM,IAAI;IAC7E,IAAI,EAAE,GAAG,WAAW,iBAAiB,MAAM,EAAE,CAAC;IAC9C,OAAO,EAAE,CAAC,sCAAsC,CAAC,CAAC;CACnD,CAAC;AAEF,MAAM,MAAM,iBAAiB,CAAC,WAAW,SAAS,MAAM,IACpD,4BAA4B,CAAC,WAAW,CAAC,GACzC,oCAAoC,CAAC,WAAW,CAAC,CAAC;AAUtD,eAAO,MAAM,mBAAmB,UAAU,CAAC;AAE3C;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAOF,qBAAa,eAAe,CAC1B,WAAW,SAAS,MAAM,EAC1B,gBAAgB,SAAS,aAAa,CAAC,WAAW,CAAC;;IAEnD,SAAgB,IAAI,EAAE,WAAW,CAAC;IAalC,SAAS,CAAC,SAAS,EAAE,gBAAgB,CAAC;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;;;;;;;;;;;OAWG;cACa,UAAU,CACxB,YAAY,SAAS,IAAI,EACzB,MAAM,GAAG,YAAY,EACrB,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,GAAG,SAAS,CACnC,EACD,UAAU,CACX,GAAG;QAGF,OAAO,EAAE,aAAa,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;KACjD,GACA,OAAO,CAAC,KAAK,CAAC;IAQjB;;;;;;;;;;;;;;OAcG;cACa,kBAAkB,CAChC,YAAY,SAAS,IAAI,EACzB,MAAM,GAAG,YAAY,EACrB,KAAK,SAAS,YAAY,GAAG,YAAY,EACzC,SAAS,SAAS,QAAQ,GAAG,QAAQ,EACrC,UAAU,SAAS,IAAI,GAAG,IAAI,EAE9B,OAAO,EAAE,YAAY,CACnB,SAAS,CACP,iBAAiB,CACf,YAAY,EACZ,MAAM,EACN,YAAY,CAAC,KAAK,EAAE,UAAU,CAAC,EAC/B,SAAS,EACT,UAAU,CACX,EACD,OAAO,GAAG,YAAY,GAAG,SAAS,GAAG,kBAAkB,CACxD,EACD,UAAU,CACX,GACC,8BAA8B,CAAC,YAAY,EAAE,UAAU,CAAC,GAAG;QACzD,OAAO,EAAE,aAAa,CAAC,YAAY,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC;KAC7D,EACH,SAAS,CAAC,EAAE,UAAU,GACrB,OAAO,CAAC,KAAK,CAAC;IAkEjB;;;;;;OAMG;IACG,iBAAiB,CACrB,OAAO,CAAC,EAAE,sBAAsB,CAAC,QAAQ,CAAC,EAC1C,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

@@ -85,8 +85,13 @@ export class BaseDataService {
     /**
      * Fetch a query.
      *
-     * @param options - The options defining the query. Keep in mind that `queryKey` and `queryFn` are required when using data services.
-     * Additionally `retry` and `retryDelay` are not available, retries can be customized using the `servicePolicyOptions`.
+     * @param options - The options defining the query. Note that although this
+     * method wraps `fetchQuery` from `@tanstack/query-core`, there are a few
+     * restrictions:
+     * - `queryKey` and `queryFn` are required
+     * - `queryFn` must be a function, not a skip token
+     * - `retry` and `retryDelay` are not available (retries can be customized
+     *   using the constructor's `servicePolicyOptions`).
      * @returns The query results.
      */
     async fetchQuery(options) {
@@ -98,33 +103,64 @@ export class BaseDataService {
     /**
      * Fetch a paginated query.
      *
-     * @param options - The options defining the query. Keep in mind that `queryKey` and `queryFn` are required when using data services.
-     * Additionally `retry` and `retryDelay` are not available, retries can be customized using the `servicePolicyOptions`.
+     * @param options - The options defining the query. Note that although this
+     * method wraps `fetchInfiniteQuery` from `@tanstack/query-core`, there are a
+     * few differences:
+     * - `queryKey` and `queryFn` are required
+     * - `queryFn` must be a function, not a skip token
+     * - `retry` and `retryDelay` are not available (retries can be customized
+     *   using the constructor's `servicePolicyOptions`).
      * @param pageParam - An optional page parameter.
-     * @returns The query result, exclusively the requested page is returned.
+     * @returns A page's worth of data (i.e. what `queryFn` returns). Note that
+     * this is different from `@tanstack/query-core`'s `fetchInfiniteQuery`
+     * method, which returns all pages.
      */
     async fetchInfiniteQuery(options, pageParam) {
-        const cache = __classPrivateFieldGet(this, _BaseDataService_queryClient, "f").getQueryCache();
-        const query = cache.find({
+        // A missing per-call `pageParam` means "the first page", which uses the
+        // consumer's `initialPageParam`. A `null` initial param is preserved: `??`
+        // only falls back when the per-call param itself is missing.
+        const requestedPageParam = pageParam ?? options.initialPageParam;
+        const query = __classPrivateFieldGet(this, _BaseDataService_queryClient, "f")
+            .getQueryCache()
+            .find({
             queryKey: options.queryKey,
         });
-        if (!query?.state.data || pageParam === undefined) {
+        // The first page (or a cold cache) goes through query-core's
+        // `fetchInfiniteQuery`, which reuses the cached page while the query is
+        // fresh. A cold jump starts the query at the requested page by using it as
+        // the initial page param.
+        if (!query?.state.data ||
+            deepEqual(requestedPageParam, options.initialPageParam)) {
             const result = await __classPrivateFieldGet(this, _BaseDataService_queryClient, "f").fetchInfiniteQuery({
                 ...options,
-                initialPageParam: pageParam ?? options.initialPageParam,
-                queryFn: (context) => __classPrivateFieldGet(this, _BaseDataService_policy, "f").execute(() => options.queryFn({
-                    ...context,
-                    pageParam: context.meta?.pageParam ?? context.pageParam,
-                })),
+                initialPageParam: requestedPageParam,
+                queryFn: (context) => __classPrivateFieldGet(this, _BaseDataService_policy, "f").execute(() => options.queryFn(context)),
             });
             return result.pages[0];
         }
+        // A later page on an existing query. v5 no longer forwards an explicit page
+        // param, so fetch it directly and merge it into the infinite cache,
+        // appending the next page or prepending an earlier one.
         const { pages, pageParams } = query.state.data;
-        const next = options.getNextPageParam(pages[pages.length - 1], pages, pageParams[pageParams.length - 1], pageParams);
-        const direction = deepEqual(pageParam, next) ? 'forward' : 'backward';
-        const result = await query.fetch({ ...query.options, meta: { pageParam } }, { meta: { fetchMore: { direction } } });
-        const pageIndex = result.pageParams.findIndex((param) => deepEqual(param, pageParam));
-        return result.pages[pageIndex];
+        const page = (await __classPrivateFieldGet(this, _BaseDataService_policy, "f").execute(() => options.queryFn({
+            client: __classPrivateFieldGet(this, _BaseDataService_queryClient, "f"),
+            queryKey: options.queryKey,
+            signal: new AbortController().signal,
+            pageParam: requestedPageParam,
+            direction: 'forward',
+            meta: options.meta,
+        })));
+        const nextPageParam = options.getNextPageParam(pages[pages.length - 1], pages, pageParams[pageParams.length - 1], pageParams);
+        __classPrivateFieldGet(this, _BaseDataService_queryClient, "f").setQueryData(options.queryKey, deepEqual(requestedPageParam, nextPageParam)
+            ? {
+                pages: [...pages, page],
+                pageParams: [...pageParams, requestedPageParam],
+            }
+            : {
+                pages: [page, ...pages],
+                pageParams: [requestedPageParam, ...pageParams],
+            });
+        return page;
     }
     /**
      * Invalidate queries serviced by this data service.

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;AAM7B,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,wBAAwB;AAE3D,OAAO,EAUL,WAAW,EAIX,SAAS,EACT,OAAO,EACR,6BAA6B;AAC9B,OAAO,UAAS,wBAAwB;;;;AAGxC,OAAO,EACL,mBAAmB,EAGpB,kCAAiC;AAiDlC,+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,OAMuD;QAEvD,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,OAeG,EACH,SAAsB;QAEtB,MAAM,KAAK,GAAG,uBAAA,IAAI,oCAAa,CAAC,aAAa,EAAE,CAAC;QAEhD,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAItB;YACA,QAAQ,EAAE,OAAO,CAAC,QAAQ;SAC3B,CAAC,CAAC;QAEH,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAClD,MAAM,MAAM,GAAG,MAAM,uBAAA,IAAI,oCAAa,CAAC,kBAAkB,CAAC;gBACxD,GAAG,OAAO;gBACV,gBAAgB,EAAE,SAAS,IAAI,OAAO,CAAC,gBAAgB;gBACvD,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,IAAI,EAAE,SAAS,IAAI,OAAO,CAAC,SAAS;iBACxD,CAAC,CACH;aACJ,CAAC,CAAC;YAEH,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACzB,CAAC;QAED,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC;QAC/C,MAAM,IAAI,GAAG,OAAO,CAAC,gBAAgB,CACnC,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,EACvB,KAAK,EACL,UAAU,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,EACjC,UAAU,CACX,CAAC;QAEF,MAAM,SAAS,GAAG,SAAS,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC;QAEtE,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,KAAK,CAC9B,EAAE,GAAG,KAAK,CAAC,OAAO,EAAE,IAAI,EAAE,EAAE,SAAS,EAAE,EAAE,EACzC,EAAE,IAAI,EAAE,EAAE,SAAS,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,CACvC,CAAC;QAEF,MAAM,SAAS,GAAG,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CACtD,SAAS,CAAC,KAAK,EAAE,SAAS,CAAC,CAC5B,CAAC;QAEF,OAAO,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAA0C,EAC1C,OAA2B;QAE3B,OAAO,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  DefaultError,\n  DefaultOptions,\n  DehydratedState,\n  FetchQueryOptions,\n  InfiniteData,\n  InfiniteQueryPageParamsOptions,\n  InvalidateOptions,\n  InvalidateQueryFilters,\n  OmitKeyof,\n  QueryClient,\n  QueryClientConfig,\n  QueryFunction,\n  WithRequired,\n  dehydrate,\n  hydrate,\n} from '@tanstack/query-core';\nimport deepEqual from 'fast-deep-equal';\nimport { debounce, DebouncedFunc } from 'lodash';\n\nimport {\n  createServicePolicy,\n  CreateServicePolicyOptions,\n  ServicePolicy,\n} from './createServicePolicy.js';\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<QueryKey>,\n    options?: InvalidateOptions,\n  ) => Promise<void>;\n};\n\nexport type DataServiceActions<ServiceName extends string> =\n  DataServiceInvalidateQueriesAction<ServiceName>;\n\ntype DataServiceAllowedActions =\n  | StorageServiceGetItemAction\n  | StorageServiceSetItemAction\n  | StorageServiceRemoveItemAction;\n\nexport type DataServiceCacheUpdatedEvent<ServiceName extends string> = {\n  type: `${ServiceName}:cacheUpdated`;\n  payload: [DataServiceCacheUpdatedPayload];\n};\n\nexport type DataServiceGranularCacheUpdatedEvent<ServiceName extends string> = {\n  type: `${ServiceName}:cacheUpdated:${string}`;\n  payload: [DataServiceGranularCacheUpdatedPayload];\n};\n\nexport type DataServiceEvents<ServiceName extends string> =\n  | DataServiceCacheUpdatedEvent<ServiceName>\n  | DataServiceGranularCacheUpdatedEvent<ServiceName>;\n\n// Defaults to apply to all data service queries if no default option specified\nconst QUERY_CLIENT_DEFAULTS: DefaultOptions = {\n  queries: {\n    retry: false,\n    staleTime: inMilliseconds(1, Duration.Minute),\n  },\n};\n\nexport const STORAGE_SERVICE_KEY = 'cache';\n\n/**\n * Options for persistence configuration.\n */\nexport type PersistenceConfiguration = {\n  /**\n   * The maximum age before the cache is treated as expired in milliseconds.\n   * This is relevant for rehydrating the state during initialization,\n   * if the cached state is too old it will be discarded.\n   */\n  maxAge: number;\n  /**\n   * The number of milliseconds to wait before triggering persistence following a cache update.\n   */\n  writeDelay?: number;\n  /**\n   * The maximum number of milliseconds to wait between persistence writes.\n   */\n  maxWriteDelay?: number;\n};\n\ntype PersistedCache = {\n  state: DehydratedState;\n  timestamp: number;\n};\n\nexport class BaseDataService<\n  ServiceName extends string,\n  ServiceMessenger extends 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 = DefaultError,\n    TData = TQueryFnData,\n    TQueryKey extends QueryKey = QueryKey,\n  >(\n    options: WithRequired<\n      OmitKeyof<\n        FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n        'retry' | 'retryDelay' | 'queryFn'\n      >,\n      'queryKey'\n    > & { queryFn: QueryFunction<TQueryFnData, TQueryKey> },\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 = DefaultError,\n    TData extends TQueryFnData = TQueryFnData,\n    TQueryKey extends QueryKey = QueryKey,\n    TPageParam extends Json = Json,\n  >(\n    options: WithRequired<\n      OmitKeyof<\n        FetchQueryOptions<\n          TQueryFnData,\n          TError,\n          InfiniteData<TData, TPageParam>,\n          TQueryKey,\n          TPageParam\n        >,\n        'retry' | 'retryDelay' | 'queryFn' | 'initialPageParam'\n      >,\n      'queryKey'\n    > &\n      InfiniteQueryPageParamsOptions<TQueryFnData, TPageParam> & {\n        queryFn: QueryFunction<TQueryFnData, TQueryKey, TPageParam>;\n      },\n    pageParam?: TPageParam,\n  ): Promise<TData> {\n    const cache = this.#queryClient.getQueryCache();\n\n    const query = cache.find<\n      TQueryFnData,\n      TError,\n      InfiniteData<TData, TPageParam>\n    >({\n      queryKey: options.queryKey,\n    });\n\n    if (!query?.state.data || pageParam === undefined) {\n      const result = await this.#queryClient.fetchInfiniteQuery({\n        ...options,\n        initialPageParam: pageParam ?? options.initialPageParam,\n        queryFn: (context) =>\n          this.#policy.execute(() =>\n            options.queryFn({\n              ...context,\n              pageParam: context.meta?.pageParam ?? context.pageParam,\n            }),\n          ),\n      });\n\n      return result.pages[0];\n    }\n\n    const { pages, pageParams } = query.state.data;\n    const next = options.getNextPageParam(\n      pages[pages.length - 1],\n      pages,\n      pageParams[pageParams.length - 1],\n      pageParams,\n    );\n\n    const direction = deepEqual(pageParam, next) ? 'forward' : 'backward';\n\n    const result = await query.fetch(\n      { ...query.options, meta: { pageParam } },\n      { meta: { fetchMore: { direction } } },\n    );\n\n    const pageIndex = result.pageParams.findIndex((param) =>\n      deepEqual(param, pageParam),\n    );\n\n    return result.pages[pageIndex];\n  }\n\n  /**\n   * Invalidate queries serviced by this data service.\n   *\n   * @param filters - Optional filter for selecting specific queries.\n   * @param options - Additional optional options for query invalidations.\n   * @returns Nothing.\n   */\n  async invalidateQueries(\n    filters?: InvalidateQueryFilters<QueryKey>,\n    options?: InvalidateOptions,\n  ): Promise<void> {\n    return this.#queryClient.invalidateQueries(filters, options);\n  }\n\n  /**\n   * Initialize the service, rehydrating the cache with persisted data if possible.\n   */\n  init(): void {\n    this.#loadCache().catch(\n      /* istanbul ignore next */\n      (error) => this.#messenger.captureException?.(error),\n    );\n  }\n\n  /**\n   * Prepares the service for garbage collection. This should be extended\n   * by any subclasses to clean up any additional connections or events.\n   */\n  destroy(): void {\n    this.#debouncedPersist?.cancel();\n    this.#queryCacheUnsubscribe();\n    this.#queryClient.clear();\n    this.messenger.clearSubscriptions();\n    this.messenger.clearActions();\n  }\n\n  /**\n   * Publish `cacheUpdated` events when a given query changes.\n   *\n   * @param hash The hash of the query.\n   * @param type The type of cache update.\n   */\n  #publishCacheUpdate(hash: string, type: CacheUpdatedType): void {\n    const state =\n      type === 'added' || type === 'updated'\n        ? dehydrate(this.#queryClient, {\n            shouldDehydrateQuery: (query) => query.queryHash === hash,\n          })\n        : null;\n\n    this.#messenger.publish(\n      `${this.name}:cacheUpdated` as const,\n      {\n        type,\n        hash,\n        state,\n      } as DataServiceCacheUpdatedPayload,\n    );\n\n    this.#messenger.publish(\n      `${this.name}:cacheUpdated:${hash}` as const,\n      {\n        type,\n        state,\n      } as DataServiceGranularCacheUpdatedPayload,\n    );\n  }\n\n  /**\n   * Persist the query client cache using the StorageService, if the cache is not empty.\n   *\n   * @returns Nothing.\n   */\n  async #persistCache(): Promise<void> {\n    const state = dehydrate(this.#queryClient, {\n      // This is the default, but we specify it to be explicit.\n      shouldDehydrateQuery: (query) => query.state.status === 'success',\n    });\n\n    if (state.queries.length === 0 && state.mutations.length === 0) {\n      await this.#externalMessenger.call(\n        'StorageService:removeItem',\n        this.name,\n        STORAGE_SERVICE_KEY,\n      );\n      return;\n    }\n\n    const cache: PersistedCache = {\n      timestamp: Date.now(),\n      state,\n    };\n\n    await this.#externalMessenger.call(\n      'StorageService:setItem',\n      this.name,\n      STORAGE_SERVICE_KEY,\n      cache as unknown as Json,\n    );\n  }\n\n  /**\n   * Load the query client cache from the StorageService, if persistence is configured\n   * and the persisted cache is not expired.\n   *\n   * @returns Nothing.\n   */\n  async #loadCache(): Promise<void> {\n    if (!this.#persistenceConfig) {\n      return;\n    }\n\n    const { result: untypedCache } = await this.#externalMessenger.call(\n      'StorageService:getItem',\n      this.name,\n      STORAGE_SERVICE_KEY,\n    );\n\n    if (!untypedCache) {\n      return;\n    }\n\n    const cache = untypedCache as unknown as PersistedCache;\n\n    if (Date.now() - cache.timestamp >= this.#persistenceConfig.maxAge) {\n      await this.#externalMessenger.call(\n        'StorageService:removeItem',\n        this.name,\n        STORAGE_SERVICE_KEY,\n      );\n      return;\n    }\n\n    hydrate(this.#queryClient, cache.state);\n  }\n}\n"]}
+{"version":3,"file":"BaseDataService.mjs","sourceRoot":"","sources":["../src/BaseDataService.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,OAAO,EACL,SAAS,EAGV,4BAA4B;AAM7B,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,wBAAwB;AAE3D,OAAO,EAUL,WAAW,EAIX,SAAS,EACT,OAAO,EACR,6BAA6B;AAC9B,OAAO,UAAS,wBAAwB;;;;AAGxC,OAAO,EACL,mBAAmB,EAGpB,kCAAiC;AAiElC,+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;IA6B1B,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;;;;;;;;;;;OAWG;IACO,KAAK,CAAC,UAAU,CAMxB,OAUC;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;;;;;;;;;;;;;;OAcG;IACO,KAAK,CAAC,kBAAkB,CAOhC,OAeG,EACH,SAAsB;QAEtB,wEAAwE;QACxE,2EAA2E;QAC3E,6DAA6D;QAC7D,MAAM,kBAAkB,GAAG,SAAS,IAAI,OAAO,CAAC,gBAAgB,CAAC;QAEjE,MAAM,KAAK,GAAG,uBAAA,IAAI,oCAAa;aAC5B,aAAa,EAAE;aACf,IAAI,CAAwD;YAC3D,QAAQ,EAAE,OAAO,CAAC,QAAQ;SAC3B,CAAC,CAAC;QAEL,6DAA6D;QAC7D,wEAAwE;QACxE,2EAA2E;QAC3E,0BAA0B;QAC1B,IACE,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI;YAClB,SAAS,CAAC,kBAAkB,EAAE,OAAO,CAAC,gBAAgB,CAAC,EACvD,CAAC;YACD,MAAM,MAAM,GAAG,MAAM,uBAAA,IAAI,oCAAa,CAAC,kBAAkB,CAAC;gBACxD,GAAG,OAAO;gBACV,gBAAgB,EAAE,kBAAkB;gBACpC,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,CACnB,uBAAA,IAAI,+BAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;aACvD,CAAC,CAAC;YAEH,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACzB,CAAC;QAED,4EAA4E;QAC5E,oEAAoE;QACpE,wDAAwD;QACxD,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC;QAC/C,MAAM,IAAI,GAAG,CAAC,MAAM,uBAAA,IAAI,+BAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,CAC5C,OAAO,CAAC,OAAO,CAAC;YACd,MAAM,EAAE,uBAAA,IAAI,oCAAa;YACzB,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,MAAM,EAAE,IAAI,eAAe,EAAE,CAAC,MAAM;YACpC,SAAS,EAAE,kBAAkB;YAC7B,SAAS,EAAE,SAAS;YACpB,IAAI,EAAE,OAAO,CAAC,IAAI;SACnB,CAAC,CACH,CAAU,CAAC;QACZ,MAAM,aAAa,GAAG,OAAO,CAAC,gBAAgB,CAC5C,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,EACvB,KAAK,EACL,UAAU,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,EACjC,UAAU,CACX,CAAC;QACF,uBAAA,IAAI,oCAAa,CAAC,YAAY,CAC5B,OAAO,CAAC,QAAQ,EAChB,SAAS,CAAC,kBAAkB,EAAE,aAAa,CAAC;YAC1C,CAAC,CAAC;gBACE,KAAK,EAAE,CAAC,GAAG,KAAK,EAAE,IAAI,CAAC;gBACvB,UAAU,EAAE,CAAC,GAAG,UAAU,EAAE,kBAAkB,CAAC;aAChD;YACH,CAAC,CAAC;gBACE,KAAK,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,CAAC;gBACvB,UAAU,EAAE,CAAC,kBAAkB,EAAE,GAAG,UAAU,CAAC;aAChD,CACN,CAAC;QAEF,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAA0C,EAC1C,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  DefaultError,\n  DefaultOptions,\n  DehydratedState,\n  FetchQueryOptions,\n  InfiniteData,\n  InfiniteQueryPageParamsOptions,\n  InvalidateOptions,\n  InvalidateQueryFilters,\n  OmitKeyof,\n  QueryClient,\n  QueryClientConfig,\n  QueryFunction,\n  WithRequired,\n  dehydrate,\n  hydrate,\n} from '@tanstack/query-core';\nimport deepEqual from 'fast-deep-equal';\nimport { debounce, DebouncedFunc } from 'lodash';\n\nimport {\n  createServicePolicy,\n  CreateServicePolicyOptions,\n  ServicePolicy,\n} from './createServicePolicy.js';\n\n// Data service queries use the following format: ['ServiceActionName', ...params]\nexport type QueryKey = [string, ...Json[]];\n\n/**\n * The supertype of all messengers, scoped to a namespace.\n *\n * @template Namespace - The namespace for the messenger's own actions and\n * events.\n */\nexport type BaseMessenger<Namespace extends string> = Messenger<\n  Namespace,\n  ActionConstraint,\n  EventConstraint,\n  // Use `any` to allow any parent to be set. `any` is harmless in a type constraint anyway,\n  // it's the one totally safe place to use it.\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  any\n>;\n\nexport type DataServiceGranularCacheUpdatedPayload =\n  | { type: 'added' | 'updated'; state: DehydratedState }\n  | {\n      type: 'removed';\n      state: null;\n    };\n\nexport type DataServiceCacheUpdatedPayload =\n  DataServiceGranularCacheUpdatedPayload & {\n    hash: string;\n  };\n\ntype CacheUpdatedType = DataServiceCacheUpdatedPayload['type'];\n\nexport type DataServiceInvalidateQueriesAction<ServiceName extends string> = {\n  type: `${ServiceName}:invalidateQueries`;\n  handler: BaseDataService<\n    ServiceName,\n    BaseMessenger<ServiceName>\n  >['invalidateQueries'];\n};\n\nexport type DataServiceActions<ServiceName extends string> =\n  DataServiceInvalidateQueriesAction<ServiceName>;\n\ntype DataServiceAllowedActions =\n  | StorageServiceGetItemAction\n  | StorageServiceSetItemAction\n  | StorageServiceRemoveItemAction;\n\nexport type DataServiceCacheUpdatedEvent<ServiceName extends string> = {\n  type: `${ServiceName}:cacheUpdated`;\n  payload: [DataServiceCacheUpdatedPayload];\n};\n\nexport type DataServiceGranularCacheUpdatedEvent<ServiceName extends string> = {\n  type: `${ServiceName}:cacheUpdated:${string}`;\n  payload: [DataServiceGranularCacheUpdatedPayload];\n};\n\nexport type DataServiceEvents<ServiceName extends string> =\n  | DataServiceCacheUpdatedEvent<ServiceName>\n  | DataServiceGranularCacheUpdatedEvent<ServiceName>;\n\n// Defaults to apply to all data service queries if no default option specified\nconst QUERY_CLIENT_DEFAULTS: DefaultOptions = {\n  queries: {\n    retry: false,\n    staleTime: inMilliseconds(1, Duration.Minute),\n  },\n};\n\nexport const STORAGE_SERVICE_KEY = 'cache';\n\n/**\n * Options for persistence configuration.\n */\nexport type PersistenceConfiguration = {\n  /**\n   * The maximum age before the cache is treated as expired in milliseconds.\n   * This is relevant for rehydrating the state during initialization,\n   * if the cached state is too old it will be discarded.\n   */\n  maxAge: number;\n  /**\n   * The number of milliseconds to wait before triggering persistence following a cache update.\n   */\n  writeDelay?: number;\n  /**\n   * The maximum number of milliseconds to wait between persistence writes.\n   */\n  maxWriteDelay?: number;\n};\n\ntype PersistedCache = {\n  state: DehydratedState;\n  timestamp: number;\n};\n\nexport class BaseDataService<\n  ServiceName extends string,\n  ServiceMessenger extends BaseMessenger<ServiceName>,\n> {\n  public readonly name: ServiceName;\n\n  readonly #messenger: Messenger<\n    ServiceName,\n    DataServiceActions<ServiceName>,\n    DataServiceEvents<ServiceName>\n  >;\n\n  readonly #externalMessenger: Messenger<\n    ServiceName,\n    DataServiceAllowedActions\n  >;\n\n  protected messenger: ServiceMessenger;\n\n  readonly #policy: ServicePolicy;\n\n  readonly #queryClient: QueryClient;\n\n  readonly #queryCacheUnsubscribe: () => void;\n\n  readonly #debouncedPersist?: DebouncedFunc<() => void>;\n\n  readonly #persistenceConfig?: PersistenceConfiguration;\n\n  constructor({\n    name,\n    messenger,\n    queryClientConfig = {},\n    policyOptions,\n    persistenceConfig,\n  }: {\n    name: ServiceName;\n    messenger: 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. Note that although this\n   * method wraps `fetchQuery` from `@tanstack/query-core`, there are a few\n   * restrictions:\n   * - `queryKey` and `queryFn` are required\n   * - `queryFn` must be a function, not a skip token\n   * - `retry` and `retryDelay` are not available (retries can be customized\n   *   using the constructor's `servicePolicyOptions`).\n   * @returns The query results.\n   */\n  protected async fetchQuery<\n    TQueryFnData extends Json,\n    TError = DefaultError,\n    TData = TQueryFnData,\n    TQueryKey extends QueryKey = QueryKey,\n  >(\n    options: WithRequired<\n      OmitKeyof<\n        FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n        'retry' | 'retryDelay' | 'queryFn'\n      >,\n      'queryKey'\n    > & {\n      // @tanstack/query-core's fetchQuery function accepts a \"skip\" token, but\n      // data services always provide a concrete query function.\n      queryFn: QueryFunction<TQueryFnData, TQueryKey>;\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. Note that although this\n   * method wraps `fetchInfiniteQuery` from `@tanstack/query-core`, there are a\n   * few differences:\n   * - `queryKey` and `queryFn` are required\n   * - `queryFn` must be a function, not a skip token\n   * - `retry` and `retryDelay` are not available (retries can be customized\n   *   using the constructor's `servicePolicyOptions`).\n   * @param pageParam - An optional page parameter.\n   * @returns A page's worth of data (i.e. what `queryFn` returns). Note that\n   * this is different from `@tanstack/query-core`'s `fetchInfiniteQuery`\n   * method, which returns all pages.\n   */\n  protected async fetchInfiniteQuery<\n    TQueryFnData extends Json,\n    TError = DefaultError,\n    TData extends TQueryFnData = TQueryFnData,\n    TQueryKey extends QueryKey = QueryKey,\n    TPageParam extends Json = Json,\n  >(\n    options: WithRequired<\n      OmitKeyof<\n        FetchQueryOptions<\n          TQueryFnData,\n          TError,\n          InfiniteData<TData, TPageParam>,\n          TQueryKey,\n          TPageParam\n        >,\n        'retry' | 'retryDelay' | 'queryFn' | 'initialPageParam'\n      >,\n      'queryKey'\n    > &\n      InfiniteQueryPageParamsOptions<TQueryFnData, TPageParam> & {\n        queryFn: QueryFunction<TQueryFnData, TQueryKey, TPageParam>;\n      },\n    pageParam?: TPageParam,\n  ): Promise<TData> {\n    // A missing per-call `pageParam` means \"the first page\", which uses the\n    // consumer's `initialPageParam`. A `null` initial param is preserved: `??`\n    // only falls back when the per-call param itself is missing.\n    const requestedPageParam = pageParam ?? options.initialPageParam;\n\n    const query = this.#queryClient\n      .getQueryCache()\n      .find<TQueryFnData, TError, InfiniteData<TData, TPageParam>>({\n        queryKey: options.queryKey,\n      });\n\n    // The first page (or a cold cache) goes through query-core's\n    // `fetchInfiniteQuery`, which reuses the cached page while the query is\n    // fresh. A cold jump starts the query at the requested page by using it as\n    // the initial page param.\n    if (\n      !query?.state.data ||\n      deepEqual(requestedPageParam, options.initialPageParam)\n    ) {\n      const result = await this.#queryClient.fetchInfiniteQuery({\n        ...options,\n        initialPageParam: requestedPageParam,\n        queryFn: (context) =>\n          this.#policy.execute(() => options.queryFn(context)),\n      });\n\n      return result.pages[0];\n    }\n\n    // A later page on an existing query. v5 no longer forwards an explicit page\n    // param, so fetch it directly and merge it into the infinite cache,\n    // appending the next page or prepending an earlier one.\n    const { pages, pageParams } = query.state.data;\n    const page = (await this.#policy.execute(() =>\n      options.queryFn({\n        client: this.#queryClient,\n        queryKey: options.queryKey,\n        signal: new AbortController().signal,\n        pageParam: requestedPageParam,\n        direction: 'forward',\n        meta: options.meta,\n      }),\n    )) as TData;\n    const nextPageParam = options.getNextPageParam(\n      pages[pages.length - 1],\n      pages,\n      pageParams[pageParams.length - 1],\n      pageParams,\n    );\n    this.#queryClient.setQueryData<InfiniteData<TData, TPageParam>>(\n      options.queryKey,\n      deepEqual(requestedPageParam, nextPageParam)\n        ? {\n            pages: [...pages, page],\n            pageParams: [...pageParams, requestedPageParam],\n          }\n        : {\n            pages: [page, ...pages],\n            pageParams: [requestedPageParam, ...pageParams],\n          },\n    );\n\n    return page;\n  }\n\n  /**\n   * Invalidate queries serviced by this data service.\n   *\n   * @param filters - Optional filter for selecting specific queries.\n   * @param options - Additional optional options for query invalidations.\n   * @returns Nothing.\n   */\n  async invalidateQueries(\n    filters?: InvalidateQueryFilters<QueryKey>,\n    options?: InvalidateOptions,\n  ): Promise<void> {\n    return this.#queryClient.invalidateQueries(filters, options);\n  }\n\n  /**\n   * Initialize the service, rehydrating the cache with persisted data if possible.\n   */\n  init(): void {\n    this.#loadCache().catch(\n      /* istanbul ignore next */\n      (error) => this.#messenger.captureException?.(error),\n    );\n  }\n\n  /**\n   * Prepares the service for garbage collection. This should be extended\n   * by any subclasses to clean up any additional connections or events.\n   */\n  destroy(): void {\n    this.#debouncedPersist?.cancel();\n    this.#queryCacheUnsubscribe();\n    this.#queryClient.clear();\n    this.messenger.clearSubscriptions();\n    this.messenger.clearActions();\n  }\n\n  /**\n   * Publish `cacheUpdated` events when a given query changes.\n   *\n   * @param hash The hash of the query.\n   * @param type The type of cache update.\n   */\n  #publishCacheUpdate(hash: string, type: CacheUpdatedType): void {\n    const state =\n      type === 'added' || type === 'updated'\n        ? dehydrate(this.#queryClient, {\n            shouldDehydrateQuery: (query) => query.queryHash === hash,\n          })\n        : null;\n\n    this.#messenger.publish(\n      `${this.name}:cacheUpdated` as const,\n      {\n        type,\n        hash,\n        state,\n      } as DataServiceCacheUpdatedPayload,\n    );\n\n    this.#messenger.publish(\n      `${this.name}:cacheUpdated:${hash}` as const,\n      {\n        type,\n        state,\n      } as DataServiceGranularCacheUpdatedPayload,\n    );\n  }\n\n  /**\n   * Persist the query client cache using the StorageService, if the cache is not empty.\n   *\n   * @returns Nothing.\n   */\n  async #persistCache(): Promise<void> {\n    const state = dehydrate(this.#queryClient, {\n      // This is the default, but we specify it to be explicit.\n      shouldDehydrateQuery: (query) => query.state.status === 'success',\n    });\n\n    if (state.queries.length === 0 && state.mutations.length === 0) {\n      await this.#externalMessenger.call(\n        'StorageService:removeItem',\n        this.name,\n        STORAGE_SERVICE_KEY,\n      );\n      return;\n    }\n\n    const cache: PersistedCache = {\n      timestamp: Date.now(),\n      state,\n    };\n\n    await this.#externalMessenger.call(\n      'StorageService:setItem',\n      this.name,\n      STORAGE_SERVICE_KEY,\n      cache as unknown as Json,\n    );\n  }\n\n  /**\n   * Load the query client cache from the StorageService, if persistence is configured\n   * and the persisted cache is not expired.\n   *\n   * @returns Nothing.\n   */\n  async #loadCache(): Promise<void> {\n    if (!this.#persistenceConfig) {\n      return;\n    }\n\n    const { result: untypedCache } = await this.#externalMessenger.call(\n      'StorageService:getItem',\n      this.name,\n      STORAGE_SERVICE_KEY,\n    );\n\n    if (!untypedCache) {\n      return;\n    }\n\n    const cache = untypedCache as unknown as PersistedCache;\n\n    if (Date.now() - cache.timestamp >= this.#persistenceConfig.maxAge) {\n      await this.#externalMessenger.call(\n        'StorageService:removeItem',\n        this.name,\n        STORAGE_SERVICE_KEY,\n      );\n      return;\n    }\n\n    hydrate(this.#queryClient, cache.state);\n  }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/base-data-service",
-  "version": "0.1.3-preview-d21e2aaf9",
+  "version": "0.1.3-preview-6426280bb",
   "description": "Provides utilities for building data services",
   "keywords": [
     "Ethereum",