rename onBeforeMountApp to onBeforeRenderClient

Signed-off-by: Chris-Robin Ennen <chris-robin@ennen.dev>
vikejs · Jun 3, 2024 · f77ddfc · f77ddfc
1 parent aaa51f7
commit f77ddfc
Show file tree

Hide file tree

Showing 8 changed files with 19 additions and 16 deletions.
diff --git a/packages/vike-vue-pinia/renderer/+config.ts b/packages/vike-vue-pinia/renderer/+config.ts
@@ -4,7 +4,7 @@ export default {
   name: 'vike-vue-pinia',
   onCreateApp: 'import:vike-vue-pinia/renderer/installPinia:installPinia',
   onAfterRenderSSRApp: 'import:vike-vue-pinia/renderer/dehydratePinia:dehydratePinia',
-  onBeforeMountApp: 'import:vike-vue-pinia/renderer/hydratePinia:hydratePinia',
+  onBeforeRenderClient: 'import:vike-vue-pinia/renderer/hydratePinia:hydratePinia',
 }
 
 declare global {

diff --git a/packages/vike-vue-pinia/renderer/hydratePinia.ts b/packages/vike-vue-pinia/renderer/hydratePinia.ts
@@ -1,8 +1,8 @@
-import type { OnBeforeMountAppSync } from 'vike-vue/types'
+import type { onBeforeRenderClientSync } from 'vike-vue/types'
 
 export { hydratePinia }
 
-const hydratePinia: OnBeforeMountAppSync = ({ pinia, fromHtmlRenderer }): ReturnType<OnBeforeMountAppSync> => {
+const hydratePinia: onBeforeRenderClientSync = ({ pinia, fromHtmlRenderer }): ReturnType<onBeforeRenderClientSync> => {
   const { piniaInitialState } = fromHtmlRenderer
 
   if (!pinia || !piniaInitialState) {

diff --git a/packages/vike-vue-query/renderer/+config.ts b/packages/vike-vue-query/renderer/+config.ts
@@ -4,7 +4,7 @@ export default {
   name: 'vike-vue-query',
   onCreateApp: 'import:vike-vue-query/renderer/installVueQuery:installVueQuery',
   onAfterRenderSSRApp: 'import:vike-vue-query/renderer/dehydrateVueQuery:dehydrateVueQuery',
-  onBeforeMountApp: 'import:vike-vue-query/renderer/hydrateVueQuery:hydrateVueQuery',
+  onBeforeRenderClient: 'import:vike-vue-query/renderer/hydrateVueQuery:hydrateVueQuery',
   meta: {
     queryClientConfig: {
       env: {

diff --git a/packages/vike-vue-query/renderer/hydrateVueQuery.ts b/packages/vike-vue-query/renderer/hydrateVueQuery.ts
@@ -1,9 +1,12 @@
 import { hydrate } from '@tanstack/vue-query'
-import type { OnBeforeMountAppSync } from 'vike-vue/types'
+import type { onBeforeRenderClientSync } from 'vike-vue/types'
 
 export { hydrateVueQuery }
 
-const hydrateVueQuery: OnBeforeMountAppSync = ({ queryClient, fromHtmlRenderer }): ReturnType<OnBeforeMountAppSync> => {
+const hydrateVueQuery: onBeforeRenderClientSync = ({
+  queryClient,
+  fromHtmlRenderer,
+}): ReturnType<onBeforeRenderClientSync> => {
   const { vueQueryInitialState } = fromHtmlRenderer
 
   if (!queryClient || !vueQueryInitialState) {

diff --git a/packages/vike-vue/README.md b/packages/vike-vue/README.md
@@ -63,7 +63,7 @@ Vike and Vue.
 * [`onCreateApp()`](https://vike.dev/onCreateApp): Allows you to extend the Vue app, typically for registering a Vue
   plugin.
 * `onAfterRenderSSRApp()`: Called right after rendering the app on the server. Usually used for dehydration of state management libraries.
-* `onBeforeMountApp()`: Called before mounting the app on the client. Usually used for hydration of state management libraries.
+* `onBeforeRenderClient()`: Called before mounting the app on the client. Usually used for hydration of state management libraries.
 
 ## Settings
 

diff --git a/packages/vike-vue/src/hooks/types.ts b/packages/vike-vue/src/hooks/types.ts
@@ -3,8 +3,8 @@ export type {
   OnCreateAppAsync,
   OnAfterRenderSSRAppSync,
   OnAfterRenderSSRAppAsync,
-  OnBeforeMountAppSync,
-  OnBeforeMountAppAsync,
+  OnBeforeRenderClientSync,
+  OnBeforeRenderClientAsync,
 }
 
 import type { PageContext } from 'vike/types'
@@ -48,10 +48,10 @@ type OnAfterRenderSSRAppAsync = (pageContext: PageContext) => Promise<PageContex
  *
  * Typically used for hydrating state management libraries.
  */
-type OnBeforeMountAppSync = (pageContext: PageContext) => void
+type OnBeforeRenderClientSync = (pageContext: PageContext) => void
 /**
  * Hook called right before mounting the page's root Vue component.
  *
  * Typically used for hydrating state management libraries.
  */
-type OnBeforeMountAppAsync = (pageContext: PageContext) => Promise<void>
+type OnBeforeRenderClientAsync = (pageContext: PageContext) => Promise<void>
diff --git a/packages/vike-vue/src/renderer/onRenderClient.ts b/packages/vike-vue/src/renderer/onRenderClient.ts
@@ -21,12 +21,12 @@ const onRenderClient: OnRenderClientAsync = async (pageContext): ReturnType<OnRe
     app = res.app
     objectAssign(pageContext, { app })
 
-    await callCumulativeHooks(pageContext.config.onBeforeMountApp, pageContext)
+    await callCumulativeHooks(pageContext.config.onBeforeRenderClient, pageContext)
 
     app.mount(container)
   } else {
     // Client-side navigation
-
+    await callCumulativeHooks(pageContext.config.onBeforeRenderClient, pageContext)
     await changePage!(pageContext)
 
     const title = getHeadSetting('title', pageContext) || ''

diff --git a/packages/vike-vue/src/types/PageContext.ts b/packages/vike-vue/src/types/PageContext.ts
@@ -4,8 +4,8 @@ import type { App, defineComponent } from 'vue'
 import type {
   OnAfterRenderSSRAppAsync,
   OnAfterRenderSSRAppSync,
-  OnBeforeMountAppAsync,
-  OnBeforeMountAppSync,
+  OnBeforeRenderClientAsync,
+  OnBeforeRenderClientSync,
   OnCreateAppAsync,
   OnCreateAppSync,
 } from '../hooks/types'
@@ -28,7 +28,7 @@ declare global {
     interface ConfigResolved {
       onCreateApp?: Array<OnCreateAppSync | OnCreateAppAsync>
       onAfterRenderSSRApp?: Array<OnAfterRenderSSRAppSync | OnAfterRenderSSRAppAsync>
-      onBeforeMountApp?: Array<OnBeforeMountAppSync | OnBeforeMountAppAsync>
+      onBeforeRenderClient?: Array<OnBeforeRenderClientSync | OnBeforeRenderClientAsync>
     }
   }
 }