Merge branch 'main' into react-query/chore/update-deps

TanStack · Dec 23, 2024 · 23c8736 · 23c8736
2 parents e09a832 + e41ea5a
commit 23c8736
Show file tree

Hide file tree

Showing 98 changed files with 1,235 additions and 1,253 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -50,7 +50,7 @@ jobs:
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
           TAG: ${{ inputs.tag }}
       - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v4.5.0
+        uses: codecov/codecov-action@v4.6.0
         with:
           directory: packages
         env:

diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml
@@ -38,7 +38,7 @@ jobs:
         if: ${{ always() }}
         run: npx nx-cloud stop-all-agents
       - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v4.5.0
+        uses: codecov/codecov-action@v4.6.0
         with:
           directory: packages
         env:

diff --git a/.nvmrc b/.nvmrc
@@ -1 +1 @@
-22.4.0
+22.12.0
diff --git a/docs/framework/react/plugins/broadcastQueryClient.md b/docs/framework/react/plugins/broadcastQueryClient.md
@@ -41,7 +41,7 @@ broadcastQueryClient({ queryClient, broadcastChannel })
 An object of options:
 
 ```tsx
-interface broadcastQueryClient {
+interface BroadcastQueryClientOptions {
   /** The QueryClient to sync */
   queryClient: QueryClient
   /** This is the unique channel name that will be used
@@ -56,6 +56,6 @@ The default options are:
 
 ```tsx
 {
-  broadcastChannel = 'react-query',
+  broadcastChannel = 'tanstack-query',
 }
 ```
diff --git a/docs/framework/react/reference/infiniteQueryOptions.md b/docs/framework/react/reference/infiniteQueryOptions.md
@@ -12,7 +12,7 @@ infiniteQueryOptions({
 
 **Options**
 
-You can generally pass everything to `queryOptions` that you can also pass to [`useInfiniteQuery`](../useInfiniteQuery). Some options will have no effect when then forwarded to a function like `queryClient.prefetchInfiniteQuery`, but TypeScript will still be fine with those excess properties.
+You can generally pass everything to `infiniteQueryOptions` that you can also pass to [`useInfiniteQuery`](../useInfiniteQuery). Some options will have no effect when then forwarded to a function like `queryClient.prefetchInfiniteQuery`, but TypeScript will still be fine with those excess properties.
 
 - `queryKey: QueryKey`
   - **Required**

diff --git a/docs/framework/react/reference/useQuery.md b/docs/framework/react/reference/useQuery.md
@@ -92,7 +92,7 @@ const {
 - `staleTime: number | ((query: Query) => number)`
   - Optional
   - Defaults to `0`
-  - The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
+  - The time in milliseconds after which data is considered stale. This value only applies to the hook it is defined on.
   - If set to `Infinity`, the data will never be considered stale
   - If set to a function, the function will be executed with the query to compute a `staleTime`.
 - `gcTime: number | Infinity`

diff --git a/examples/angular/auto-refetching/package.json b/examples/angular/auto-refetching/package.json
@@ -14,7 +14,7 @@
     "@angular/core": "^19.1.0-next.0",
     "@angular/platform-browser": "^19.1.0-next.0",
     "@angular/platform-browser-dynamic": "^19.1.0-next.0",
-    "@tanstack/angular-query-experimental": "^5.62.7",
+    "@tanstack/angular-query-experimental": "^5.62.9",
     "rxjs": "^7.8.1",
     "tslib": "^2.6.3",
     "zone.js": "^0.15.0"

diff --git a/examples/angular/basic/package.json b/examples/angular/basic/package.json
@@ -14,7 +14,7 @@
     "@angular/core": "^19.1.0-next.0",
     "@angular/platform-browser": "^19.1.0-next.0",
     "@angular/platform-browser-dynamic": "^19.1.0-next.0",
-    "@tanstack/angular-query-experimental": "^5.62.7",
+    "@tanstack/angular-query-experimental": "^5.62.9",
     "rxjs": "^7.8.1",
     "tslib": "^2.6.3",
     "zone.js": "^0.15.0"

diff --git a/examples/angular/devtools-panel/package.json b/examples/angular/devtools-panel/package.json
@@ -15,8 +15,8 @@
     "@angular/platform-browser": "^19.1.0-next.0",
     "@angular/platform-browser-dynamic": "^19.1.0-next.0",
     "@angular/router": "^19.1.0-next.0",
-    "@tanstack/angular-query-devtools-experimental": "^5.62.7",
-    "@tanstack/angular-query-experimental": "^5.62.7",
+    "@tanstack/angular-query-devtools-experimental": "^5.62.9",
+    "@tanstack/angular-query-experimental": "^5.62.9",
     "rxjs": "^7.8.1",
     "tslib": "^2.6.3",
     "zone.js": "^0.15.0"

diff --git a/examples/angular/infinite-query-with-max-pages/package.json b/examples/angular/infinite-query-with-max-pages/package.json
@@ -14,7 +14,7 @@
     "@angular/core": "^19.1.0-next.0",
     "@angular/platform-browser": "^19.1.0-next.0",
     "@angular/platform-browser-dynamic": "^19.1.0-next.0",
-    "@tanstack/angular-query-experimental": "^5.62.7",
+    "@tanstack/angular-query-experimental": "^5.62.9",
     "rxjs": "^7.8.1",
     "tslib": "^2.6.3",
     "zone.js": "^0.15.0"

diff --git a/examples/angular/pagination/package.json b/examples/angular/pagination/package.json
@@ -14,7 +14,7 @@
     "@angular/core": "^19.1.0-next.0",
     "@angular/platform-browser": "^19.1.0-next.0",
     "@angular/platform-browser-dynamic": "^19.1.0-next.0",
-    "@tanstack/angular-query-experimental": "^5.62.7",
+    "@tanstack/angular-query-experimental": "^5.62.9",
     "rxjs": "^7.8.1",
     "tslib": "^2.6.3",
     "zone.js": "^0.15.0"

diff --git a/examples/angular/query-options-from-a-service/package.json b/examples/angular/query-options-from-a-service/package.json
@@ -15,7 +15,7 @@
     "@angular/platform-browser": "^19.1.0-next.0",
     "@angular/platform-browser-dynamic": "^19.1.0-next.0",
     "@angular/router": "^19.1.0-next.0",
-    "@tanstack/angular-query-experimental": "^5.62.7",
+    "@tanstack/angular-query-experimental": "^5.62.9",
     "rxjs": "^7.8.1",
     "tslib": "^2.6.3",
     "zone.js": "^0.15.0"

diff --git a/examples/angular/router/package.json b/examples/angular/router/package.json
@@ -15,7 +15,7 @@
     "@angular/platform-browser": "^19.1.0-next.0",
     "@angular/platform-browser-dynamic": "^19.1.0-next.0",
     "@angular/router": "^19.1.0-next.0",
-    "@tanstack/angular-query-experimental": "^5.62.7",
+    "@tanstack/angular-query-experimental": "^5.62.9",
     "rxjs": "^7.8.1",
     "tslib": "^2.6.3",
     "zone.js": "^0.15.0"

diff --git a/examples/angular/rxjs/package.json b/examples/angular/rxjs/package.json
@@ -15,7 +15,7 @@
     "@angular/forms": "19.1.0-next.0",
     "@angular/platform-browser": "^19.1.0-next.0",
     "@angular/platform-browser-dynamic": "^19.1.0-next.0",
-    "@tanstack/angular-query-experimental": "^5.62.7",
+    "@tanstack/angular-query-experimental": "^5.62.9",
     "rxjs": "^7.8.1",
     "tslib": "^2.6.3",
     "zone.js": "^0.15.0"

diff --git a/examples/angular/simple/package.json b/examples/angular/simple/package.json
@@ -14,7 +14,7 @@
     "@angular/core": "^19.1.0-next.0",
     "@angular/platform-browser": "^19.1.0-next.0",
     "@angular/platform-browser-dynamic": "^19.1.0-next.0",
-    "@tanstack/angular-query-experimental": "^5.62.7",
+    "@tanstack/angular-query-experimental": "^5.62.9",
     "rxjs": "^7.8.1",
     "tslib": "^2.6.3",
     "zone.js": "^0.15.0"

diff --git a/examples/react/algolia/package.json b/examples/react/algolia/package.json
@@ -10,13 +10,13 @@
   },
   "dependencies": {
     "@algolia/client-search": "5.2.1",
-    "@tanstack/react-query": "^5.62.7",
-    "@tanstack/react-query-devtools": "^5.62.7",
+    "@tanstack/react-query": "^5.62.9",
+    "@tanstack/react-query-devtools": "^5.62.9",
     "react": "^19.0.0",
     "react-dom": "^19.0.0"
   },
   "devDependencies": {
-    "@tanstack/eslint-plugin-query": "^5.62.1",
+    "@tanstack/eslint-plugin-query": "^5.62.9",
     "@types/react": "^18.2.79",
     "@types/react-dom": "^18.2.25",
     "@vitejs/plugin-react": "^4.3.3",

diff --git a/examples/react/auto-refetching/package.json b/examples/react/auto-refetching/package.json
@@ -8,9 +8,9 @@
     "start": "next start"
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.62.7",
-    "@tanstack/react-query-devtools": "^5.62.7",
-    "next": "^14.2.18",
+    "@tanstack/react-query": "^5.62.9",
+    "@tanstack/react-query-devtools": "^5.62.9",
+    "next": "^14.2.20",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"
   },

diff --git a/examples/react/basic-graphql-request/package.json b/examples/react/basic-graphql-request/package.json
@@ -8,8 +8,8 @@
     "preview": "vite preview"
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.62.7",
-    "@tanstack/react-query-devtools": "^5.62.7",
+    "@tanstack/react-query": "^5.62.9",
+    "@tanstack/react-query-devtools": "^5.62.9",
     "graphql": "^16.9.0",
     "graphql-request": "^7.1.2",
     "react": "^19.0.0",

diff --git a/examples/react/basic/package.json b/examples/react/basic/package.json
@@ -9,15 +9,15 @@
     "test:types": "tsc"
   },
   "dependencies": {
-    "@tanstack/query-sync-storage-persister": "^5.62.7",
-    "@tanstack/react-query": "^5.62.7",
-    "@tanstack/react-query-devtools": "^5.62.7",
-    "@tanstack/react-query-persist-client": "^5.62.7",
+    "@tanstack/query-sync-storage-persister": "^5.62.9",
+    "@tanstack/react-query": "^5.62.9",
+    "@tanstack/react-query-devtools": "^5.62.9",
+    "@tanstack/react-query-persist-client": "^5.62.9",
     "react": "^19.0.0",
     "react-dom": "^19.0.0"
   },
   "devDependencies": {
-    "@tanstack/eslint-plugin-query": "^5.62.1",
+    "@tanstack/eslint-plugin-query": "^5.62.9",
     "@types/react": "^18.2.79",
     "@types/react-dom": "^18.2.25",
     "@vitejs/plugin-react": "^4.3.3",

diff --git a/examples/react/default-query-function/package.json b/examples/react/default-query-function/package.json
@@ -8,8 +8,8 @@
     "preview": "vite preview"
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.62.7",
-    "@tanstack/react-query-devtools": "^5.62.7",
+    "@tanstack/react-query": "^5.62.9",
+    "@tanstack/react-query-devtools": "^5.62.9",
     "react": "^19.0.0",
     "react-dom": "^19.0.0"
   },

diff --git a/examples/react/devtools-panel/package.json b/examples/react/devtools-panel/package.json
@@ -8,8 +8,8 @@
     "preview": "vite preview"
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.62.7",
-    "@tanstack/react-query-devtools": "^5.62.7",
+    "@tanstack/react-query": "^5.62.9",
+    "@tanstack/react-query-devtools": "^5.62.9",
     "react": "^19.0.0",
     "react-dom": "^19.0.0"
   },

diff --git a/examples/react/infinite-query-with-max-pages/package.json b/examples/react/infinite-query-with-max-pages/package.json
@@ -8,9 +8,9 @@
     "start": "next start"
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.62.7",
-    "@tanstack/react-query-devtools": "^5.62.7",
-    "next": "^14.2.18",
+    "@tanstack/react-query": "^5.62.9",
+    "@tanstack/react-query-devtools": "^5.62.9",
+    "next": "^14.2.20",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"
   },

diff --git a/examples/react/load-more-infinite-scroll/package.json b/examples/react/load-more-infinite-scroll/package.json
@@ -8,12 +8,12 @@
     "start": "next start"
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.62.7",
-    "@tanstack/react-query-devtools": "^5.62.7",
-    "next": "^14.2.18",
+    "@tanstack/react-query": "^5.62.9",
+    "@tanstack/react-query-devtools": "^5.62.9",
+    "next": "^14.2.20",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
-    "react-intersection-observer": "^9.13.1"
+    "react-intersection-observer": "^9.14.0"
   },
   "devDependencies": {
     "@types/react": "^18.2.79",

diff --git a/examples/react/nextjs-app-prefetching/package.json b/examples/react/nextjs-app-prefetching/package.json
@@ -9,9 +9,9 @@
     "test:types": "tsc"
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.62.7",
-    "@tanstack/react-query-devtools": "^5.62.7",
-    "next": "^15.0.3",
+    "@tanstack/react-query": "^5.62.9",
+    "@tanstack/react-query-devtools": "^5.62.9",
+    "next": "^15.1.0",
     "react": "^19.0.0",
     "react-dom": "^19.0.0"
   },

diff --git a/examples/react/nextjs-suspense-streaming/package.json b/examples/react/nextjs-suspense-streaming/package.json
@@ -9,10 +9,10 @@
     "test:types": "tsc"
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.62.7",
-    "@tanstack/react-query-devtools": "^5.62.7",
-    "@tanstack/react-query-next-experimental": "^5.62.7",
-    "next": "^14.2.18",
+    "@tanstack/react-query": "^5.62.9",
+    "@tanstack/react-query-devtools": "^5.62.9",
+    "@tanstack/react-query-next-experimental": "^5.62.9",
+    "next": "^14.2.20",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"
   },

diff --git a/examples/react/nextjs/package.json b/examples/react/nextjs/package.json
@@ -8,9 +8,9 @@
     "start": "next start"
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.62.7",
-    "@tanstack/react-query-devtools": "^5.62.7",
-    "next": "^14.2.18",
+    "@tanstack/react-query": "^5.62.9",
+    "@tanstack/react-query-devtools": "^5.62.9",
+    "next": "^14.2.20",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"
   },

diff --git a/examples/react/offline/package.json b/examples/react/offline/package.json
@@ -8,11 +8,11 @@
     "preview": "vite preview"
   },
   "dependencies": {
-    "@tanstack/query-sync-storage-persister": "^5.62.7",
+    "@tanstack/query-sync-storage-persister": "^5.62.9",
     "@tanstack/react-location": "^3.7.4",
-    "@tanstack/react-query": "^5.62.7",
-    "@tanstack/react-query-devtools": "^5.62.7",
-    "@tanstack/react-query-persist-client": "^5.62.7",
+    "@tanstack/react-query": "^5.62.9",
+    "@tanstack/react-query-devtools": "^5.62.9",
+    "@tanstack/react-query-persist-client": "^5.62.9",
     "msw": "^2.6.6",
     "react": "^19.0.0",
     "react-dom": "^19.0.0",

diff --git a/examples/react/optimistic-updates-cache/package.json b/examples/react/optimistic-updates-cache/package.json
@@ -9,9 +9,9 @@
     "test:types": "tsc"
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.62.7",
-    "@tanstack/react-query-devtools": "^5.62.7",
-    "next": "^14.2.18",
+    "@tanstack/react-query": "^5.62.9",
+    "@tanstack/react-query-devtools": "^5.62.9",
+    "next": "^14.2.20",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"
   },

diff --git a/examples/react/optimistic-updates-ui/package.json b/examples/react/optimistic-updates-ui/package.json
@@ -8,9 +8,9 @@
     "start": "next start"
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.62.7",
-    "@tanstack/react-query-devtools": "^5.62.7",
-    "next": "^14.2.18",
+    "@tanstack/react-query": "^5.62.9",
+    "@tanstack/react-query-devtools": "^5.62.9",
+    "next": "^14.2.20",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"
   },

diff --git a/examples/react/pagination/package.json b/examples/react/pagination/package.json
@@ -8,9 +8,9 @@
     "start": "next start"
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.62.7",
-    "@tanstack/react-query-devtools": "^5.62.7",
-    "next": "^14.2.18",
+    "@tanstack/react-query": "^5.62.9",
+    "@tanstack/react-query-devtools": "^5.62.9",
+    "next": "^14.2.20",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"
   },

diff --git a/examples/react/playground/package.json b/examples/react/playground/package.json
@@ -8,8 +8,8 @@
     "preview": "vite preview"
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.62.7",
-    "@tanstack/react-query-devtools": "^5.62.7",
+    "@tanstack/react-query": "^5.62.9",
+    "@tanstack/react-query-devtools": "^5.62.9",
     "react": "^19.0.0",
     "react-dom": "^19.0.0"
   },

diff --git a/examples/react/playground/src/styles.css b/examples/react/playground/src/styles.css
@@ -1,9 +1,9 @@
 body {
   margin: 0;
   padding: 1rem;
-  font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Oxygen',
-    'Ubuntu', 'Cantarell', 'Fira Sans', 'Droid Sans', 'Helvetica Neue',
-    sans-serif;
+  font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto',
+    'Oxygen', 'Ubuntu', 'Cantarell', 'Fira Sans', 'Droid Sans',
+    'Helvetica Neue', sans-serif;
   -webkit-font-smoothing: antialiased;
   -moz-osx-font-smoothing: grayscale;
   color: white;

diff --git a/examples/react/prefetching/package.json b/examples/react/prefetching/package.json
@@ -8,9 +8,9 @@
     "start": "next start"
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.62.7",
-    "@tanstack/react-query-devtools": "^5.62.7",
-    "next": "^14.2.18",
+    "@tanstack/react-query": "^5.62.9",
+    "@tanstack/react-query-devtools": "^5.62.9",
+    "next": "^14.2.20",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"
   },

diff --git a/examples/react/react-native/package.json b/examples/react/react-native/package.json
@@ -14,8 +14,8 @@
     "@react-native-community/netinfo": "^11.4.1",
     "@react-navigation/native": "^6.1.18",
     "@react-navigation/stack": "^6.4.1",
-    "@tanstack/react-query": "^5.62.7",
-    "@tanstack/react-query-devtools": "^5.62.7",
+    "@tanstack/react-query": "^5.62.9",
+    "@tanstack/react-query-devtools": "^5.62.9",
     "expo": "^52.0.11",
     "expo-constants": "^17.0.3",
     "expo-status-bar": "^2.0.0",