@tanstack/solid-query 6.0.0-rc.2 → 6.0.0-rc.3

package/build/_tsup-dts-rollup.d.cts

@@ -318,6 +318,15 @@ export { FetchStatus }
  * The slice's payload is a `DehydratedState`; the provider consumes it
  * with `hydrate()`, so every mounted query on those keys updates before
  * the mutation's promise resolves — no follow-up refetches.
+ *
+ * A mutation can additionally declare its invalidation SCOPE with
+ * `X-Revalidate` keys (the `revalidate` option of Solid's `reload`/
+ * `redirect` response helpers). The payload covers the slice of that scope
+ * the server could recompute; whatever a declared key matches beyond it is
+ * swept client-side (see the consumer below). For the sweep to be
+ * delivered, the collector must contribute a slice — return the dehydrated
+ * state even when it holds no queries if `outcome.revalidateKeys` is
+ * present, rather than skipping the source.
  */
 declare const FLIGHT_DATA_SOURCE = "sq";
 export { FLIGHT_DATA_SOURCE }

package/build/_tsup-dts-rollup.d.ts

@@ -318,6 +318,15 @@ export { FetchStatus }
  * The slice's payload is a `DehydratedState`; the provider consumes it
  * with `hydrate()`, so every mounted query on those keys updates before
  * the mutation's promise resolves — no follow-up refetches.
+ *
+ * A mutation can additionally declare its invalidation SCOPE with
+ * `X-Revalidate` keys (the `revalidate` option of Solid's `reload`/
+ * `redirect` response helpers). The payload covers the slice of that scope
+ * the server could recompute; whatever a declared key matches beyond it is
+ * swept client-side (see the consumer below). For the sweep to be
+ * delivered, the collector must contribute a slice — return the dehydrated
+ * state even when it holds no queries if `outcome.revalidateKeys` is
+ * present, rather than skipping the source.
  */
 declare const FLIGHT_DATA_SOURCE = "sq";
 export { FLIGHT_DATA_SOURCE }

package/build/dev.cjs

@@ -14,6 +14,17 @@ exports.QueryClient = class QueryClient extends queryCore.QueryClient {
 var isServer = typeof window === "undefined";
 var HYDRATION_KEY_PREFIX = "sq:";
 exports.FLIGHT_DATA_SOURCE = "sq";
+function sweepRevalidatedQueries(client, payload, response) {
+  const keys = response.headers.get(web.REVALIDATE_HEADER)?.split(",");
+  if (!keys) return;
+  const covered = new Set(payload.queries.map((query) => query.queryHash));
+  for (const key of keys) {
+    client.invalidateQueries({
+      queryKey: [key],
+      predicate: (query) => !covered.has(query.queryHash)
+    }).catch(() => void 0);
+  }
+}
 exports.QueryClientContext = solidJs.createContext(null);
 exports.useQueryClient = (queryClient) => {
   if (queryClient) {
@@ -64,8 +75,9 @@ exports.QueryClientProvider = (props) => {
       props.client.clear();
     });
   } else {
-    solidJs.onCleanup(serverFunctions.subscribeFlightData(exports.FLIGHT_DATA_SOURCE, (data) => {
+    solidJs.onCleanup(serverFunctions.subscribeFlightData(exports.FLIGHT_DATA_SOURCE, (data, context) => {
       queryCore.hydrate(props.client, data);
+      sweepRevalidatedQueries(props.client, data, context.response);
     }));
   }
   return web.createComponent(exports.QueryClientContext, {

package/build/dev.js

@@ -1,7 +1,7 @@
 import { noop, QueryClient as QueryClient$1, hydrate, dehydrate, shouldThrowError, InfiniteQueryObserver, QueryObserver, replaceEqualDeep } from '@tanstack/query-core';
 export * from '@tanstack/query-core';
 import { createContext, useContext, onCleanup, createMemo, createOptimistic, createSignal, action, createRenderEffect, untrack, repeat, $TRACK, sharedConfig, createEffect, createProjection, runWithOwner, isPending, resolve } from 'solid-js';
-import { createComponent } from '@solidjs/web';
+import { createComponent, REVALIDATE_HEADER } from '@solidjs/web';
 import { subscribeFlightData } from '@solidjs/web/server-functions';
 
 // src/index.ts
@@ -13,6 +13,17 @@ var QueryClient = class extends QueryClient$1 {
 var isServer = typeof window === "undefined";
 var HYDRATION_KEY_PREFIX = "sq:";
 var FLIGHT_DATA_SOURCE = "sq";
+function sweepRevalidatedQueries(client, payload, response) {
+  const keys = response.headers.get(REVALIDATE_HEADER)?.split(",");
+  if (!keys) return;
+  const covered = new Set(payload.queries.map((query) => query.queryHash));
+  for (const key of keys) {
+    client.invalidateQueries({
+      queryKey: [key],
+      predicate: (query) => !covered.has(query.queryHash)
+    }).catch(() => void 0);
+  }
+}
 var QueryClientContext = createContext(null);
 var useQueryClient = (queryClient) => {
   if (queryClient) {
@@ -63,8 +74,9 @@ var QueryClientProvider = (props) => {
       props.client.clear();
     });
   } else {
-    onCleanup(subscribeFlightData(FLIGHT_DATA_SOURCE, (data) => {
+    onCleanup(subscribeFlightData(FLIGHT_DATA_SOURCE, (data, context) => {
       hydrate(props.client, data);
+      sweepRevalidatedQueries(props.client, data, context.response);
     }));
   }
   return createComponent(QueryClientContext, {

package/build/index.cjs

@@ -14,6 +14,17 @@ exports.QueryClient = class QueryClient extends queryCore.QueryClient {
 var isServer = typeof window === "undefined";
 var HYDRATION_KEY_PREFIX = "sq:";
 exports.FLIGHT_DATA_SOURCE = "sq";
+function sweepRevalidatedQueries(client, payload, response) {
+  const keys = response.headers.get(web.REVALIDATE_HEADER)?.split(",");
+  if (!keys) return;
+  const covered = new Set(payload.queries.map((query) => query.queryHash));
+  for (const key of keys) {
+    client.invalidateQueries({
+      queryKey: [key],
+      predicate: (query) => !covered.has(query.queryHash)
+    }).catch(() => void 0);
+  }
+}
 exports.QueryClientContext = solidJs.createContext(null);
 exports.useQueryClient = (queryClient) => {
   if (queryClient) {
@@ -64,8 +75,9 @@ exports.QueryClientProvider = (props) => {
       props.client.clear();
     });
   } else {
-    solidJs.onCleanup(serverFunctions.subscribeFlightData(exports.FLIGHT_DATA_SOURCE, (data) => {
+    solidJs.onCleanup(serverFunctions.subscribeFlightData(exports.FLIGHT_DATA_SOURCE, (data, context) => {
       queryCore.hydrate(props.client, data);
+      sweepRevalidatedQueries(props.client, data, context.response);
     }));
   }
   return web.createComponent(exports.QueryClientContext, {

package/build/index.js

@@ -1,7 +1,7 @@
 import { noop, QueryClient as QueryClient$1, hydrate, dehydrate, shouldThrowError, InfiniteQueryObserver, QueryObserver, replaceEqualDeep } from '@tanstack/query-core';
 export * from '@tanstack/query-core';
 import { createContext, useContext, onCleanup, createMemo, createOptimistic, createSignal, action, createRenderEffect, untrack, repeat, $TRACK, sharedConfig, createEffect, createProjection, runWithOwner, isPending, resolve } from 'solid-js';
-import { createComponent } from '@solidjs/web';
+import { createComponent, REVALIDATE_HEADER } from '@solidjs/web';
 import { subscribeFlightData } from '@solidjs/web/server-functions';
 
 // src/index.ts
@@ -13,6 +13,17 @@ var QueryClient = class extends QueryClient$1 {
 var isServer = typeof window === "undefined";
 var HYDRATION_KEY_PREFIX = "sq:";
 var FLIGHT_DATA_SOURCE = "sq";
+function sweepRevalidatedQueries(client, payload, response) {
+  const keys = response.headers.get(REVALIDATE_HEADER)?.split(",");
+  if (!keys) return;
+  const covered = new Set(payload.queries.map((query) => query.queryHash));
+  for (const key of keys) {
+    client.invalidateQueries({
+      queryKey: [key],
+      predicate: (query) => !covered.has(query.queryHash)
+    }).catch(() => void 0);
+  }
+}
 var QueryClientContext = createContext(null);
 var useQueryClient = (queryClient) => {
   if (queryClient) {
@@ -63,8 +74,9 @@ var QueryClientProvider = (props) => {
       props.client.clear();
     });
   } else {
-    onCleanup(subscribeFlightData(FLIGHT_DATA_SOURCE, (data) => {
+    onCleanup(subscribeFlightData(FLIGHT_DATA_SOURCE, (data, context) => {
       hydrate(props.client, data);
+      sweepRevalidatedQueries(props.client, data, context.response);
     }));
   }
   return createComponent(QueryClientContext, {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/solid-query",
-  "version": "6.0.0-rc.2",
+  "version": "6.0.0-rc.3",
   "description": "Primitives for managing, caching and syncing asynchronous and remote data in Solid",
   "author": "tannerlinsley",
   "license": "MIT",

package/src/QueryClientProvider.tsx

@@ -1,4 +1,5 @@
 import { createContext, onCleanup, sharedConfig, useContext } from 'solid-js'
+import { REVALIDATE_HEADER } from '@solidjs/web'
 import { hydrate } from '@tanstack/query-core'
 import { subscribeFlightData } from '@solidjs/web/server-functions'
 import type { DehydratedState, Query } from '@tanstack/query-core'
@@ -35,9 +36,53 @@ export const HYDRATION_KEY_PREFIX = 'sq:'
  * The slice's payload is a `DehydratedState`; the provider consumes it
  * with `hydrate()`, so every mounted query on those keys updates before
  * the mutation's promise resolves — no follow-up refetches.
+ *
+ * A mutation can additionally declare its invalidation SCOPE with
+ * `X-Revalidate` keys (the `revalidate` option of Solid's `reload`/
+ * `redirect` response helpers). The payload covers the slice of that scope
+ * the server could recompute; whatever a declared key matches beyond it is
+ * swept client-side (see the consumer below). For the sweep to be
+ * delivered, the collector must contribute a slice — return the dehydrated
+ * state even when it holds no queries if `outcome.revalidateKeys` is
+ * present, rather than skipping the source.
  */
 export const FLIGHT_DATA_SOURCE = 'sq'
 
+/**
+ * The client half of key-scoped invalidation. A mutation declares its
+ * invalidation scope with `X-Revalidate` keys; the flight payload covers
+ * the part of that scope the server's collector recomputed (typically the
+ * target page's loader graph). Whatever a declared key matches BEYOND the
+ * payload — parameterized instances only this client holds, queries no
+ * loader owns — is invalidated here: active queries refetch in the
+ * background, inactive ones are marked stale for their next mount. This
+ * mirrors how Solid Router consumes the same header for its own cache.
+ *
+ * A key matches by queryKey prefix — `revalidate: 'users'` sweeps every
+ * query whose key begins with `'users'`. Payload-covered hashes are exempt:
+ * they hydrated with fresh data a moment ago, and refetching them would
+ * spend the round trip single flight just saved.
+ */
+function sweepRevalidatedQueries(
+  client: QueryClient,
+  payload: DehydratedState,
+  response: Response,
+): void {
+  const keys = response.headers.get(REVALIDATE_HEADER)?.split(',')
+  if (!keys) return
+  const covered = new Set(payload.queries.map((query) => query.queryHash))
+  for (const key of keys) {
+    client
+      .invalidateQueries({
+        queryKey: [key],
+        predicate: (query) => !covered.has(query.queryHash),
+      })
+      // Background refetch failures surface through the queries' own error
+      // states; an unhandled rejection here would fail the mutation instead.
+      .catch(() => undefined)
+  }
+}
+
 export const QueryClientContext = createContext<(() => QueryClient) | null>(
   null,
 )
@@ -160,9 +205,16 @@ export const QueryClientProvider = (
     // Client-only: the server's consumer registry is module state shared
     // across requests — registering there would leak between them.
     onCleanup(
-      subscribeFlightData<DehydratedState>(FLIGHT_DATA_SOURCE, (data) => {
-        hydrate(props.client, data)
-      }),
+      subscribeFlightData<DehydratedState>(
+        FLIGHT_DATA_SOURCE,
+        (data, context) => {
+          hydrate(props.client, data)
+          // Fresh data first, then the declared-scope sweep: stale marks
+          // land synchronously, refetches run in the background — the
+          // mutation's promise never waits on them.
+          sweepRevalidatedQueries(props.client, data, context.response)
+        },
+      ),
     )
   }