rename onAfterRenderSSRApp to onAfterRenderHtml

Signed-off-by: Chris-Robin Ennen <chris-robin@ennen.dev>
vikejs · Jun 4, 2024 · 88e98e1 · 88e98e1
1 parent 68816cb
commit 88e98e1
Show file tree

Hide file tree

Showing 9 changed files with 19 additions and 19 deletions.
diff --git a/packages/vike-vue-pinia/renderer/+config.ts b/packages/vike-vue-pinia/renderer/+config.ts
@@ -3,7 +3,7 @@ import type { Pinia, StateTree } from 'pinia'
 export default {
   name: 'vike-vue-pinia',
   onCreateApp: 'import:vike-vue-pinia/renderer/installPinia:installPinia',
-  onAfterRenderSSRApp: 'import:vike-vue-pinia/renderer/dehydratePinia:dehydratePinia',
+  onAfterRenderHtml: 'import:vike-vue-pinia/renderer/dehydratePinia:dehydratePinia',
   onBeforeRenderClient: 'import:vike-vue-pinia/renderer/hydratePinia:hydratePinia',
 }
 

diff --git a/packages/vike-vue-pinia/renderer/dehydratePinia.ts b/packages/vike-vue-pinia/renderer/dehydratePinia.ts
@@ -1,7 +1,7 @@
-import type { OnAfterRenderSSRAppSync } from 'vike-vue/types'
+import type { OnAfterRenderHtmlSync } from 'vike-vue/types'
 
 export { dehydratePinia }
 
-const dehydratePinia: OnAfterRenderSSRAppSync = ({ pinia }): ReturnType<OnAfterRenderSSRAppSync> => {
+const dehydratePinia: OnAfterRenderHtmlSync = ({ pinia }): ReturnType<OnAfterRenderHtmlSync> => {
   return { piniaInitialState: pinia!.state.value }
 }
diff --git a/packages/vike-vue-query/renderer/+config.ts b/packages/vike-vue-query/renderer/+config.ts
@@ -3,7 +3,7 @@ import type { DehydratedState, QueryClient, QueryClientConfig } from '@tanstack/
 export default {
   name: 'vike-vue-query',
   onCreateApp: 'import:vike-vue-query/renderer/installVueQuery:installVueQuery',
-  onAfterRenderSSRApp: 'import:vike-vue-query/renderer/dehydrateVueQuery:dehydrateVueQuery',
+  onAfterRenderHtml: 'import:vike-vue-query/renderer/dehydrateVueQuery:dehydrateVueQuery',
   onBeforeRenderClient: 'import:vike-vue-query/renderer/hydrateVueQuery:hydrateVueQuery',
   meta: {
     queryClientConfig: {

diff --git a/packages/vike-vue-query/renderer/dehydrateVueQuery.ts b/packages/vike-vue-query/renderer/dehydrateVueQuery.ts
@@ -1,8 +1,8 @@
 import { dehydrate } from '@tanstack/vue-query'
-import type { OnAfterRenderSSRAppSync } from 'vike-vue/types'
+import type { OnAfterRenderHtmlSync } from 'vike-vue/types'
 
 export { dehydrateVueQuery }
 
-const dehydrateVueQuery: OnAfterRenderSSRAppSync = ({ queryClient }): ReturnType<OnAfterRenderSSRAppSync> => {
+const dehydrateVueQuery: OnAfterRenderHtmlSync = ({ queryClient }): ReturnType<OnAfterRenderHtmlSync> => {
   return { vueQueryInitialState: dehydrate(queryClient!) }
 }
diff --git a/packages/vike-vue/README.md b/packages/vike-vue/README.md
@@ -62,7 +62,7 @@ Vike and Vue.
 `vike-vue` introduces the following new hooks:
 * [`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.
+* `onAfterRenderHtml()`: Called right after rendering the app on the server. Usually used for dehydration 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/+config.ts b/packages/vike-vue/src/+config.ts
@@ -1,8 +1,8 @@
 import type {
   OnCreateAppSync,
   OnCreateAppAsync,
-  OnAfterRenderSSRAppSync,
-  OnAfterRenderSSRAppAsync,
+  OnAfterRenderHtmlSync,
+  OnAfterRenderHtmlAsync,
   OnBeforeRenderClientSync,
   OnBeforeRenderClientAsync,
 } from './hooks/types'
@@ -85,7 +85,7 @@ export default {
       env: { server: true, client: true },
       cumulative: true,
     },
-    onAfterRenderSSRApp: {
+    onAfterRenderHtml: {
       env: { server: true },
       cumulative: true,
     },
@@ -169,7 +169,7 @@ declare global {
        *
        * Typically used for dehydrating state management libraries.
        */
-      onAfterRenderSSRApp?: OnAfterRenderSSRAppSync | OnAfterRenderSSRAppAsync
+      onAfterRenderHtml?: OnAfterRenderHtmlSync | OnAfterRenderHtmlAsync
 
       /**
        * Hook called right before mounting the page's root Vue component.

diff --git a/packages/vike-vue/src/hooks/types.ts b/packages/vike-vue/src/hooks/types.ts
@@ -1,8 +1,8 @@
 export type {
   OnCreateAppSync,
   OnCreateAppAsync,
-  OnAfterRenderSSRAppSync,
-  OnAfterRenderSSRAppAsync,
+  OnAfterRenderHtmlSync,
+  OnAfterRenderHtmlAsync,
   OnBeforeRenderClientSync,
   OnBeforeRenderClientAsync,
 }
@@ -34,14 +34,14 @@ type OnCreateAppAsync = (pageContext: PageContextWithApp) => Promise<void>
  *
  * Typically used for dehydrating state management libraries.
  */
-type OnAfterRenderSSRAppSync = (pageContext: PageContext) => PageContext['fromHtmlRenderer']
+type OnAfterRenderHtmlSync = (pageContext: PageContext) => PageContext['fromHtmlRenderer']
 /**
  * Hook called right after rendering the page's root Vue component.
  * The hook can return additional page context that will be passed to the client under `pageContext.fromHtmlRenderer`.
  *
  * Typically used for dehydrating state management libraries.
  */
-type OnAfterRenderSSRAppAsync = (pageContext: PageContext) => Promise<PageContext['fromHtmlRenderer']>
+type OnAfterRenderHtmlAsync = (pageContext: PageContext) => Promise<PageContext['fromHtmlRenderer']>
 
 /**
  * Hook called right before mounting the page's root Vue component.

diff --git a/packages/vike-vue/src/renderer/onRenderHtml.ts b/packages/vike-vue/src/renderer/onRenderHtml.ts
@@ -31,7 +31,7 @@ const onRenderHtml: OnRenderHtmlAsync = async (pageContext): ReturnType<OnRender
       ? dangerouslySkipEscape(await renderToStringWithErrorHandling(app))
       : renderToNodeStreamWithErrorHandling(app)
 
-    const afterRenderResults = await callCumulativeHooks(pageContext.config.onAfterRenderSSRApp, pageContext)
+    const afterRenderResults = await callCumulativeHooks(pageContext.config.onAfterRenderHtml, pageContext)
 
     Object.assign(fromHtmlRenderer, ...afterRenderResults)
   }

diff --git a/packages/vike-vue/src/types/PageContext.ts b/packages/vike-vue/src/types/PageContext.ts
@@ -2,8 +2,8 @@ export type { Component }
 
 import type { App, defineComponent } from 'vue'
 import type {
-  OnAfterRenderSSRAppAsync,
-  OnAfterRenderSSRAppSync,
+  OnAfterRenderHtmlAsync,
+  OnAfterRenderHtmlSync,
   OnBeforeRenderClientAsync,
   OnBeforeRenderClientSync,
   OnCreateAppAsync,
@@ -27,7 +27,7 @@ declare global {
     }
     interface ConfigResolved {
       onCreateApp?: Array<OnCreateAppSync | OnCreateAppAsync>
-      onAfterRenderSSRApp?: Array<OnAfterRenderSSRAppSync | OnAfterRenderSSRAppAsync>
+      onAfterRenderHtml?: Array<OnAfterRenderHtmlSync | OnAfterRenderHtmlAsync>
       onBeforeRenderClient?: Array<OnBeforeRenderClientSync | OnBeforeRenderClientAsync>
     }
   }