feat(hydration): remove hydration package (#2936)

TanStack · Nov 13, 2021 · ad73004 · ad73004
1 parent c1ae82b
commit ad73004
Show file tree

Hide file tree

Showing 7 changed files with 25 additions and 32 deletions.
diff --git a/docs/src/manifests/manifest.json b/docs/src/manifests/manifest.json
@@ -204,6 +204,11 @@
           "title": "Migrating to React Query 3",
           "path": "/guides/migrating-to-react-query-3",
           "editUrl": "/guides/migrating-to-react-query-3.md"
+        },
+        {
+          "title": "Migrating to React Query 4",
+          "path": "/guides/migrating-to-react-query-4",
+          "editUrl": "/guides/migrating-to-react-query-4.md"
         }
       ]
     },
@@ -442,4 +447,4 @@
       ]
     }
   ]
-}
+}
diff --git a/docs/src/pages/guides/migrating-to-react-query-4.md b/docs/src/pages/guides/migrating-to-react-query-4.md
@@ -0,0 +1,19 @@
+---
+id: migrating-to-react-query-4
+title: Migrating to React Query 4
+---
+
+## Breaking Changes
+
+### Separate hydration exports have been removed
+
+With version [3.22.0](https://github.com/tannerlinsley/react-query/releases/tag/v3.22.0), hydration utilities moved into the react-query core. With v3, you could still use the old exports from `react-query/hydration`, but these exports have been removed with v4.
+
+```diff
+- import { dehydrate, hydrate, useHydrate, Hydrate } from 'react-query/hydration'
++ import { dehydrate, hydrate, useHydrate, Hydrate } from 'react-query'
+```
+
+
+
+
diff --git a/docs/src/pages/reference/hydration.md b/docs/src/pages/reference/hydration.md
@@ -15,8 +15,6 @@ const dehydratedState = dehydrate(queryClient, {
 })
 ```
 
-> Note: Since version `3.22.0` hydration utilities moved into to core. If you using lower version your should import `dehydrate` from `react-query/hydration`
-
 **Options**
 
 - `client: QueryClient`
@@ -72,8 +70,6 @@ import { hydrate } from 'react-query'
 hydrate(queryClient, dehydratedState, options)
 ```
 
-> Note: Since version `3.22.0` hydration utilities moved into to core. If you using lower version your should import `hydrate` from `react-query/hydration`
-
 **Options**
 
 - `client: QueryClient`
@@ -99,8 +95,6 @@ import { useHydrate } from 'react-query'
 useHydrate(dehydratedState, options)
 ```
 
-> Note: Since version `3.22.0` hydration utilities moved into to core. If you using lower version your should import `useHydrate` from `react-query/hydration`
-
 **Options**
 
 - `dehydratedState: DehydratedState`
@@ -123,8 +117,6 @@ function App() {
 }
 ```
 
-> Note: Since version `3.22.0` hydration utilities moved into to core. If you using lower version your should import `Hydrate` from `react-query/hydration`
-
 **Options**
 
 - `state: DehydratedState`

diff --git a/hydration/package.json b/hydration/package.json
diff --git a/rollup.config.js b/rollup.config.js
@@ -19,7 +19,6 @@ const inputSrcs = [
   ['src/index.ts', 'ReactQuery', 'react-query'],
   ['src/core/index.ts', 'ReactQueryCore', 'react-query-core'],
   ['src/devtools/index.ts', 'ReactQueryDevtools', 'react-query-devtools'],
-  ['src/hydration/index.ts', 'ReactQueryHydration', 'react-query-hydration'],
   [
     'src/persistQueryClient-experimental/index.ts',
     'ReactQueryPersistQueryClientExperimental',

diff --git a/src/hydration/index.ts b/src/hydration/index.ts
diff --git a/tsconfig.types.json b/tsconfig.types.json
@@ -11,7 +11,6 @@
   },
   "files": [
     "./src/index.ts",
-    "./src/hydration/index.ts",
     "./src/devtools/index.ts",
     "./src/persistQueryClient-experimental/index.ts",
     "./src/createWebStoragePersistor-experimental/index.ts",