feat: allow returning HydrateOptions & DehydrateOptions in virtual:pluginHook.ts

packages/vue-query-nuxt/src/module.ts

@@ -56,7 +56,7 @@ export default defineNuxtModule<ModuleOptions>({
         else {
           logger.info("No vue-query.config.ts file found.")
         }
-        return "export function pluginHook() { return { pluginReturn: null, vueQueryPluginOptions: null}}"
+        return "export function pluginHook() { return {} }"
       }
     })
 

packages/vue-query-nuxt/src/runtime/plugin.ts

@@ -10,17 +10,18 @@ export default defineNuxtPlugin((nuxt) => {
   const queryClient = new QueryClient(queryClientOptions)
 
   // The plugin hook is replaced by the user provided vue-query.config.ts and allow advanced modifications
-  const { pluginReturn, vueQueryPluginOptions: hookOptions } = pluginHook({ queryClient, nuxt })
+  const { pluginReturn, vueQueryPluginOptions: hookOptions, hydrateOptions, dehydrateOptions } = pluginHook({ queryClient, nuxt })
 
   nuxt.vueApp.use(VueQueryPlugin, { queryClient, ...vueQueryPluginOptions, ...hookOptions })
 
   if (import.meta.server) {
     nuxt.hooks.hook("app:rendered", () => {
-      vueQueryState.value = dehydrate(queryClient)
+      vueQueryState.value = dehydrate(queryClient, dehydrateOptions)
     })
   }
 
-  if (import.meta.client) hydrate(queryClient, vueQueryState.value)
+  if (import.meta.client) hydrate(queryClient, vueQueryState.value, hydrateOptions)
 
-  return pluginReturn
+  if (pluginReturn !== undefined) return pluginReturn
+  return;
 })

packages/vue-query-nuxt/src/runtime/types.ts

@@ -1,16 +1,17 @@
-import type { NuxtApp } from "nuxt/app"
-import type { QueryClient, VueQueryPluginOptions } from "@tanstack/vue-query"
+import type { NuxtApp, Plugin } from "nuxt/app"
+import type { DehydrateOptions, HydrateOptions, QueryClient, VueQueryPluginOptions } from "@tanstack/vue-query"
 
-export type NuxtPluginReturn =
-| void
-| Promise<void>
-| Promise<{ provide?: Record<string, unknown> | undefined }>
-| { provide?: Record<string, unknown> | undefined }
+export type NuxtPluginReturn = ReturnType<Plugin>
 
 // NuxtApp & _NuxtApp are different so we use any
 export interface PluginHookParameters {
   nuxt: NuxtApp & any
   queryClient: QueryClient
 }
 
-export interface PluginHookReturn { pluginReturn: NuxtPluginReturn; vueQueryPluginOptions?: VueQueryPluginOptions }
+export interface PluginHookReturn {
+  pluginReturn?: NuxtPluginReturn,
+  vueQueryPluginOptions?: VueQueryPluginOptions,
+  hydrateOptions?: HydrateOptions,
+  dehydrateOptions?: DehydrateOptions
+}

packages/vue-query-nuxt/src/runtime/virtual:pluginHook.ts

@@ -6,5 +6,5 @@ import type { PluginHookParameters, PluginHookReturn } from "./types"
 
 // eslint-disable-next-line unused-imports/no-unused-vars
 export function pluginHook(pluginHookParameters: PluginHookParameters): PluginHookReturn {
-  return { pluginReturn: {}, vueQueryPluginOptions: {} }
+  return {}
 }