New hook onSessionBegin()

[brillout]

Description

New hook called right after renderPage() (before routing). I.e. it would be the first hook called upon rendering a page.

Thanks to #1588, the hook could be used for the server- and/or client-side.

Use case:

• Init the vue-query client.
• Init authentication for SSG apps. (See comment below.)

Potential alternative: https://vike.dev/onBeforeRoute.

[bravius]

Such a hook would be useful for globally transforming context, such as reconstituting a session class on the client from properties, prior to all other hooks, like guard.

Example:

file: +onRequestBegin.client.ts

export function onRequestBegin(pageContext:PageContext) {
   pageContext.session = new UserSession(pageContext.session);
}

onBeforeRoute does not seem to work in this case because the hook is not invoked on the client on first render, only on navigation.

+1 to have this hook implemented.

[brillout]

I think you can use onRenderClient() or onBeforeRenderClient() instead?

We should document this somewhere, this is particularly relevant for SSG folks.

[bravius]

I have a use case where this needs to happen before the guard hook is called. The documentation indicates onRenderClient() and onBeforeRenderClient() are ordered to occur after guard.

[brillout]

Makes sense, bumped its priority for the v1-release.