Merge branch 'main' into prefetch-queries-hook

Author: DogPawHat

.github/workflows/pr.yml

@@ -71,3 +71,4 @@ jobs:
             |--------|--------|
             | Main | [![](https://deno.bundlejs.com/badge?q=https://esm.sh/@tanstack/react-query/es2022/react-query.mjs&config={%22esbuild%22:{%22external%22:[%22react@^19.0.0/jsx-runtime?target=es2022%22,%22react@^19.0.0?target=es2022%22]}}&badge=detailed)](https://bundlejs.com/?q=https://esm.sh/@tanstack/react-query/es2022/react-query.mjs&config=%7B%22esbuild%22:%7B%22external%22:%5B%22react@%5E19.0.0/jsx-runtime?target=es2022%22,%22react@%5E19.0.0?target=es2022%22%5D%7D%7D) |
             | This PR | [![](https://deno.bundlejs.com/badge?q=https://esm.sh/pr/@tanstack/react-query@${{ env.COMMIT_SHA }}/es2022/react-query.mjs&config={%22esbuild%22:{%22external%22:[%22react@^19.0.0/jsx-runtime?target=es2022%22,%22react@^19.0.0?target=es2022%22]}}&badge=detailed)](https://bundlejs.com/?q=https://esm.sh/pr/@tanstack/react-query@${{ env.COMMIT_SHA }}/es2022/react-query.mjs&config=%7B%22esbuild%22:%7B%22external%22:%5B%22react@%5E19.0.0/jsx-runtime?target=es2022%22,%22react@%5E19.0.0?target=es2022%22%5D%7D%7D) |
+        continue-on-error: true

CONTRIBUTING.md

@@ -100,7 +100,7 @@ pnpm i
 pnpm dev
 ```
 
-4. Now you can visit http://localhost:3000/query/latest/docs/overview in the browser and see the changes you make in `tanstack/query/docs` there.
+4. Now you can visit http://localhost:3000/query/latest/docs/framework/react/overview in the browser and see the changes you make in `tanstack/query/docs` there.
 
 > [!WARNING]
 > You will need to update the `docs/config.json` file (in `TanStack/query`) if you add a new documentation page!

docs/config.json

@@ -326,6 +326,143 @@
             }
           ]
         },
+        {
+          "label": "solid",
+          "children": [
+            {
+              "label": "Important Defaults",
+              "to": "framework/solid/guides/important-defaults"
+            },
+            {
+              "label": "Queries",
+              "to": "framework/solid/guides/queries"
+            },
+            {
+              "label": "Query Keys",
+              "to": "framework/solid/guides/query-keys"
+            },
+            {
+              "label": "Query Functions",
+              "to": "framework/solid/guides/query-functions"
+            },
+            {
+              "label": "Query Options",
+              "to": "framework/solid/guides/query-options"
+            },
+            {
+              "label": "Network Mode",
+              "to": "framework/solid/guides/network-mode"
+            },
+            {
+              "label": "Parallel Queries",
+              "to": "framework/solid/guides/parallel-queries"
+            },
+            {
+              "label": "Dependent Queries",
+              "to": "framework/solid/guides/dependent-queries"
+            },
+            {
+              "label": "Background Fetching Indicators",
+              "to": "framework/solid/guides/background-fetching-indicators"
+            },
+            {
+              "label": "Window Focus Refetching",
+              "to": "framework/solid/guides/window-focus-refetching"
+            },
+            {
+              "label": "Disabling/Pausing Queries",
+              "to": "framework/solid/guides/disabling-queries"
+            },
+            {
+              "label": "Query Retries",
+              "to": "framework/solid/guides/query-retries"
+            },
+            {
+              "label": "Paginated Queries",
+              "to": "framework/solid/guides/paginated-queries"
+            },
+            {
+              "label": "Infinite Queries",
+              "to": "framework/solid/guides/infinite-queries"
+            },
+            {
+              "label": "Initial Query Data",
+              "to": "framework/solid/guides/initial-query-data"
+            },
+            {
+              "label": "Placeholder Query Data",
+              "to": "framework/solid/guides/placeholder-query-data"
+            },
+            {
+              "label": "Mutations",
+              "to": "framework/solid/guides/mutations"
+            },
+            {
+              "label": "Query Invalidation",
+              "to": "framework/solid/guides/query-invalidation"
+            },
+            {
+              "label": "Invalidation from Mutations",
+              "to": "framework/solid/guides/invalidations-from-mutations"
+            },
+            {
+              "label": "Updates from Mutation Responses",
+              "to": "framework/solid/guides/updates-from-mutation-responses"
+            },
+            {
+              "label": "Optimistic Updates",
+              "to": "framework/solid/guides/optimistic-updates"
+            },
+            {
+              "label": "Query Cancellation",
+              "to": "framework/solid/guides/query-cancellation"
+            },
+            {
+              "label": "Scroll Restoration",
+              "to": "framework/solid/guides/scroll-restoration"
+            },
+            {
+              "label": "Filters",
+              "to": "framework/solid/guides/filters"
+            },
+            {
+              "label": "Request Waterfalls",
+              "to": "framework/solid/guides/request-waterfalls"
+            },
+            {
+              "label": "Prefetching",
+              "to": "framework/solid/guides/prefetching"
+            },
+            {
+              "label": "SSR",
+              "to": "framework/solid/guides/ssr"
+            },
+            {
+              "label": "Advanced SSR",
+              "to": "framework/solid/guides/advanced-ssr"
+            },
+            {
+              "label": "Caching",
+              "to": "framework/solid/guides/caching"
+            },
+            {
+              "label": "Default Query Fn",
+              "to": "framework/solid/guides/default-query-function"
+            },
+            {
+              "label": "Suspense",
+              "to": "framework/solid/guides/suspense"
+            },
+            {
+              "label": "Testing",
+              "to": "framework/solid/guides/testing"
+            },
+            {
+              "label": "Does this replace state managers?",
+              "to": "framework/angular/guides/does-this-replace-client-state"
+            }
+          ]
+        },
         {
           "label": "vue",
           "children": [
@@ -605,6 +742,10 @@
           "label": "QueriesObserver",
           "to": "reference/QueriesObserver"
         },
+        {
+          "label": "streamedQuery",
+          "to": "reference/streamedQuery"
+        },
         {
           "label": "focusManager",
           "to": "reference/focusManager"
@@ -757,8 +898,44 @@
           "label": "solid",
           "children": [
             {
-              "label": "createQuery",
-              "to": "framework/solid/reference/createQuery"
+              "label": "useQuery",
+              "to": "framework/solid/reference/useQuery"
+            },
+            {
+              "label": "useQueries",
+              "to": "framework/solid/reference/useQueries"
+            },
+            {
+              "label": "useInfiniteQuery",
+              "to": "framework/solid/reference/useInfiniteQuery"
+            },
+            {
+              "label": "useMutation",
+              "to": "framework/solid/reference/useMutation"
+            },
+            {
+              "label": "useIsFetching",
+              "to": "framework/solid/reference/useIsFetching"
+            },
+            {
+              "label": "useIsMutating",
+              "to": "framework/solid/reference/useIsMutating"
+            },
+            {
+              "label": "useMutationState",
+              "to": "framework/solid/reference/useMutationState"
+            },
+            {
+              "label": "queryOptions",
+              "to": "framework/solid/reference/queryOptions"
+            },
+            {
+              "label": "infiniteQueryOptions",
+              "to": "framework/solid/reference/infiniteQueryOptions"
+            },
+            {
+              "label": "hydration",
+              "to": "framework/solid/reference/hydration"
             }
           ]
         },
@@ -844,6 +1021,19 @@
             }
           ]
         },
+        {
+          "label": "solid",
+          "children": [
+            {
+              "label": "TkDodo's Blog",
+              "to": "framework/solid/community/tkdodos-blog"
+            },
+            {
+              "label": "Community Projects",
+              "to": "framework/solid/community/community-projects"
+            }
+          ]
+        },
         {
           "label": "vue",
           "children": [
@@ -961,6 +1151,10 @@
             {
               "label": "Devtools Embedded Panel",
               "to": "framework/react/examples/devtools-panel"
+            },
+            {
+              "label": "Chat example (streaming)",
+              "to": "framework/react/examples/chat"
             }
           ]
         },
@@ -1127,6 +1321,19 @@
             }
           ]
         },
+        {
+          "label": "solid",
+          "children": [
+            {
+              "label": "broadcastQueryClient (Experimental)",
+              "to": "framework/solid/plugins/broadcastQueryClient"
+            },
+            {
+              "label": "createPersister (Experimental)",
+              "to": "framework/solid/plugins/createPersister"
+            }
+          ]
+        },
         {
           "label": "vue",
           "children": [

docs/eslint/eslint-plugin-query.md

@@ -93,8 +93,8 @@ Alternatively, add `@tanstack/query` to the plugins section, and configure the r
 
 ## Rules
 
-- [@tanstack/query/exhaustive-deps](./exhaustive-deps)
-- [@tanstack/query/no-rest-destructuring](./no-rest-destructuring)
-- [@tanstack/query/stable-query-client](./stable-query-client)
-- [@tanstack/query/no-unstable-deps](./no-unstable-deps)
-- [@tanstack/query/infinite-query-property-order](./infinite-query-property-order)
+- [@tanstack/query/exhaustive-deps](./exhaustive-deps.md)
+- [@tanstack/query/no-rest-destructuring](./no-rest-destructuring.md)
+- [@tanstack/query/stable-query-client](./stable-query-client.md)
+- [@tanstack/query/no-unstable-deps](./no-unstable-deps.md)
+- [@tanstack/query/infinite-query-property-order](./infinite-query-property-order.md)

docs/framework/react/community/community-projects.md

@@ -25,6 +25,12 @@ The Missing Fullstack Toolkit for Next.js
 
 Link: https://blitzjs.com/
 
+## Connect
+
+A family of libraries for building building browser and gRPC-compatible HTTP APIs.
+
+Link: https://connectrpc.com/docs
+
 ## GraphQL Code Generator
 
 Generate React Query hooks from your GraphQL schema
@@ -33,7 +39,7 @@ Link: https://the-guild.dev/graphql/codegen
 
 ## Http-wizard
 
-End-to-end type-safe Fastify API with typecript magic ✨
+End-to-end type-safe Fastify API with typeScript magic ✨
 
 Link: https://http-wizard.com
 

docs/framework/react/community/tkdodos-blog.md

@@ -3,7 +3,7 @@ id: tkdodos-blog
 title: TkDodo's Blog
 ---
 
-TanStack Query maintainer [TkDodo](https://twitter.com/tkdodo) has a series of blog posts about using and working with the library. Some articles show general best practices, but most have an _opinionated_ point of view.
+TanStack Query maintainer [TkDodo](https://bsky.app/profile/tkdodo.eu) has a series of blog posts about using and working with the library. Some articles show general best practices, but most have an _opinionated_ point of view.
 
 ## [#1: Practical React Query](https://tkdodo.eu/blog/practical-react-query)
 

docs/framework/react/guides/advanced-ssr.md

@@ -5,17 +5,15 @@ title: Advanced Server Rendering
 
 Welcome to the Advanced Server Rendering guide, where you will learn all about using React Query with streaming, Server Components and the Next.js app router.
 
-You might want to read the [Server Rendering & Hydration guide](./ssr) before this one as it teaches the basics for using React Query with SSR, and [Performance & Request Waterfalls](./request-waterfalls) as well as [Prefetching & Router Integration](./prefetching) also contains valuable background.
-
-https://tanstack.com/query/latest/docs/framework/react/guides/ssr
+You might want to read the [Server Rendering & Hydration guide](./ssr.md) before this one as it teaches the basics for using React Query with SSR, and [Performance & Request Waterfalls](./request-waterfalls.md) as well as [Prefetching & Router Integration](./prefetching.md) also contains valuable background.
 
 Before we start, let's note that while the `initialData` approach outlined in the SSR guide also works with Server Components, we'll focus this guide on the hydration APIs.
 
 ## Server Components & Next.js app router
 
 We won't cover Server Components in depth here, but the short version is that they are components that are guaranteed to _only_ run on the server, both for the initial page view and **also on page transitions**. This is similar to how Next.js `getServerSideProps`/`getStaticProps` and Remix `loader` works, as these also always run on the server but while those can only return data, Server Components can do a lot more. The data part is central to React Query however, so let's focus on that.
 
-How do we take what we learned in the Server Rendering guide about [passing data prefetched in framework loaders to the app](./ssr#using-the-hydration-apis) and apply that to Server Components and the Next.js app router? The best way to start thinking about this is to consider Server Components as "just" another framework loader.
+How do we take what we learned in the Server Rendering guide about [passing data prefetched in framework loaders to the app](./ssr.md#using-the-hydration-apis) and apply that to Server Components and the Next.js app router? The best way to start thinking about this is to consider Server Components as "just" another framework loader.
 
 ### A quick note on terminology
 
@@ -532,7 +530,7 @@ export default function Posts() {
 
 Now, your `getPosts` function can return e.g. `Temporal` datetime objects and the data will be serialized and deserialized on the client, assuming your transformer can serialize and deserialize those data types.
 
-For more information, check out the [Next.js App with Prefetching Example](../../examples/nextjs-app-prefetching).
+For more information, check out the [Next.js App with Prefetching Example](../examples/react/nextjs-app-prefetching).
 
 ## Experimental streaming without prefetching in Next.js
 
@@ -599,11 +597,11 @@ export function Providers(props: { children: React.ReactNode }) {
 }
 ```
 
-For more information, check out the [NextJs Suspense Streaming Example](../../examples/nextjs-suspense-streaming).
+For more information, check out the [NextJs Suspense Streaming Example](../examples/react/nextjs-suspense-streaming).
 
 The big upside is that you no longer need to prefetch queries manually to have SSR work, and it even still streams in the result! This gives you phenomenal DX and lower code complexity.
 
-The downside is easiest to explain if we look back at [the complex request waterfall example](./request-waterfalls#code-splitting) in the Performance & Request Waterfalls guide. Server Components with prefetching effectively eliminates the request waterfalls both for the initial page load **and** any subsequent navigation. This prefetch-less approach however will only flatten the waterfalls on the initial page load but ends up the same deep waterfall as the original example on page navigations:
+The downside is easiest to explain if we look back at [the complex request waterfall example](./request-waterfalls.md#code-splitting) in the Performance & Request Waterfalls guide. Server Components with prefetching effectively eliminates the request waterfalls both for the initial page load **and** any subsequent navigation. This prefetch-less approach however will only flatten the waterfalls on the initial page load but ends up the same deep waterfall as the original example on page navigations:
 
 ```
 1. |> JS for <Feed>

docs/framework/react/guides/caching.md

@@ -3,7 +3,7 @@ id: caching
 title: Caching Examples
 ---
 
-> Please thoroughly read the [Important Defaults](./important-defaults) before reading this guide
+> Please thoroughly read the [Important Defaults](./important-defaults.md) before reading this guide
 
 ## Basic Example
 
@@ -23,7 +23,7 @@ Let's assume we are using the default `gcTime` of **5 minutes** and the default
 - A second instance of `useQuery({ queryKey: ['todos'], queryFn: fetchTodos })` mounts elsewhere.
   - Since the cache already has data for the `['todos']` key from the first query, that data is immediately returned from the cache.
   - The new instance triggers a new network request using its query function.
-    - Note that regardless of whether both `fetchTodos` query functions are identical or not, both queries' [`status`](../reference/useQuery) are updated (including `isFetching`, `isPending`, and other related values) because they have the same query key.
+    - Note that regardless of whether both `fetchTodos` query functions are identical or not, both queries' [`status`](../reference/useQuery.md) are updated (including `isFetching`, `isPending`, and other related values) because they have the same query key.
   - When the request completes successfully, the cache's data under the `['todos']` key is updated with the new data, and both instances are updated with the new data.
 - Both instances of the `useQuery({ queryKey: ['todos'], queryFn: fetchTodos })` query are unmounted and no longer in use.
   - Since there are no more active instances of this query, a garbage collection timeout is set using `gcTime` to delete and garbage collect the query (defaults to **5 minutes**).

docs/framework/react/guides/dependent-queries.md

@@ -90,6 +90,6 @@ const usersMessages = useQueries({
 
 ## A note about performance
 
-Dependent queries by definition constitutes a form of [request waterfall](../../../react/guides/request-waterfalls), which hurts performance. If we pretend both queries take the same amount of time, doing them serially instead of in parallel always takes twice as much time, which is especially hurtful when it happens on a client that has high latency. If you can, it's always better to restructure the backend APIs so that both queries can be fetched in parallel, though that might not always be practically feasible.
+Dependent queries by definition constitutes a form of [request waterfall](./request-waterfalls.md), which hurts performance. If we pretend both queries take the same amount of time, doing them serially instead of in parallel always takes twice as much time, which is especially hurtful when it happens on a client that has high latency. If you can, it's always better to restructure the backend APIs so that both queries can be fetched in parallel, though that might not always be practically feasible.
 
 In the example above, instead of first fetching `getUserByEmail` to be able to `getProjectsByUser`, introducing a new `getProjectsByUserEmail` query would flatten the waterfall.

docs/framework/react/guides/important-defaults.md

@@ -36,7 +36,7 @@ Out of the box, TanStack Query is configured with **aggressive but sane** defaul
 
 Have a look at the following articles from our Community Resources for further explanations of the defaults:
 
-- [Practical React Query](../community/tkdodos-blog#1-practical-react-query)
-- [React Query as a State Manager](../community/tkdodos-blog#10-react-query-as-a-state-manager)
+- [Practical React Query](../community/tkdodos-blog.md#1-practical-react-query)
+- [React Query as a State Manager](../community/tkdodos-blog.md#10-react-query-as-a-state-manager)
 
 [//]: # 'Materials'