From 88e98e1f6078e92c038df391eb5c93c6c9a8a100 Mon Sep 17 00:00:00 2001 From: Chris-Robin Ennen Date: Mon, 3 Jun 2024 16:06:07 +0200 Subject: [PATCH] rename onAfterRenderSSRApp to onAfterRenderHtml Signed-off-by: Chris-Robin Ennen --- packages/vike-vue-pinia/renderer/+config.ts | 2 +- packages/vike-vue-pinia/renderer/dehydratePinia.ts | 4 ++-- packages/vike-vue-query/renderer/+config.ts | 2 +- packages/vike-vue-query/renderer/dehydrateVueQuery.ts | 4 ++-- packages/vike-vue/README.md | 2 +- packages/vike-vue/src/+config.ts | 8 ++++---- packages/vike-vue/src/hooks/types.ts | 8 ++++---- packages/vike-vue/src/renderer/onRenderHtml.ts | 2 +- packages/vike-vue/src/types/PageContext.ts | 6 +++--- 9 files changed, 19 insertions(+), 19 deletions(-) diff --git a/packages/vike-vue-pinia/renderer/+config.ts b/packages/vike-vue-pinia/renderer/+config.ts index 928aed4d..0f0db8e9 100644 --- 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 index ce352dc6..b6cceba5 100644 --- 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 => { +const dehydratePinia: OnAfterRenderHtmlSync = ({ pinia }): ReturnType => { return { piniaInitialState: pinia!.state.value } } diff --git a/packages/vike-vue-query/renderer/+config.ts b/packages/vike-vue-query/renderer/+config.ts index a7128210..7a058567 100644 --- 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 index 8935ccd7..fc207125 100644 --- 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 => { +const dehydrateVueQuery: OnAfterRenderHtmlSync = ({ queryClient }): ReturnType => { return { vueQueryInitialState: dehydrate(queryClient!) } } diff --git a/packages/vike-vue/README.md b/packages/vike-vue/README.md index c830d65e..846ff9c8 100644 --- 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 index fed9a261..a4cf4842 100644 --- 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 index 21356933..ab5f40a8 100644 --- 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 * * 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 +type OnAfterRenderHtmlAsync = (pageContext: PageContext) => Promise /** * 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 index b8b624f6..1e1ce8f3 100644 --- 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 - onAfterRenderSSRApp?: Array + onAfterRenderHtml?: Array onBeforeRenderClient?: Array } }