vike 0.4.247-commit-a642bde → 0.4.247-commit-903de25

package/dist/esm/client/runtime-client-routing/getPageContextFromHooks.js

@@ -1,3 +1,4 @@
+// TODO/now: rename
 export { getPageContextFromHooks_isHydration };
 export { getPageContextFromHooks_serialized };
 export { getPageContextFromServerHooks };
@@ -20,6 +21,10 @@ import { isServerSideError } from '../../shared/misc/isServerSideError.js';
 import { execHook } from '../../shared/hooks/execHook.js';
 import { preparePageContextForPublicUsageClient, } from './preparePageContextForPublicUsageClient.js';
 const globalObject = getGlobalObject('runtime-client-routing/getPageContextFromHooks.ts', {});
+// TO-DO/soon/cumulative-hooks: filter & execute all client-only hooks (see other TO-DO/soon/cumulative-hooks entries)
+// - The client-side needs to know what hooks are client-only
+//   - Possible implementation: new computed prop `clientOnlyHooks: string[]` (list of hook ids) and add `hookId` to serialized config values
+const clientHooks = ['guard', 'data', 'onBeforeRender'];
 // TO-DO/eventually: rename
 function getPageContextFromHooks_serialized() {
     const pageContextSerialized = getPageContextSerializedInHtml();
@@ -31,11 +36,13 @@ function getPageContextFromHooks_serialized() {
 }
 // TO-DO/eventually: rename
 async function getPageContextFromHooks_isHydration(pageContext) {
-    for (const hookName of ['data', 'onBeforeRender']) {
-        // TO-DO/soon/cumulative-hooks: filter & execute all client-only hooks
-        // - The client-side needs to know what hooks are client-only
-        //   - Possible implementation: new computed prop `clientOnlyHooks: string[]` (list of hook ids) and add `hookId` to serialized config values
-        if (hookClientOnlyExists(hookName, pageContext)) {
+    for (const hookName of clientHooks) {
+        if (!hookClientOnlyExists(hookName, pageContext))
+            continue;
+        if (hookName === 'guard') {
+            await execHookGuardClient(pageContext);
+        }
+        else {
             await execHookDataLike(hookName, pageContext);
         }
     }
@@ -73,24 +80,18 @@ async function getPageContextFromClientHooks(pageContext, isErrorPage) {
     // server-side, so we run only the client-only ones in this case.
     // Note: for the error page, we also execute the client-side data() and onBeforeRender() hooks, but maybe we
     // shouldn't? The server-side does it as well (but maybe it shouldn't).
-    for (const hookName of ['guard', 'data', 'onBeforeRender']) {
+    for (const hookName of clientHooks) {
+        if (!hookClientOnlyExists(hookName, pageContext) && pageContext._hasPageContextFromServer)
+            continue;
         if (hookName === 'guard') {
-            if (!isErrorPage &&
-                // We don't need to call guard() on the client-side if we fetch pageContext from the server side. (Because the `${url}.pageContext.json` HTTP request will already trigger the routing and guard() hook on the server-side.)
-                !pageContext._hasPageContextFromServer) {
-                // Should we really call the guard() hook on the client-side? Shouldn't we make the guard() hook a server-side
-                // only hook? Or maybe make its env configurable like data() and onBeforeRender()?
-                await execHookGuard(pageContext, (pageContext) => preparePageContextForPublicUsageClient(pageContext));
-            }
+            if (isErrorPage)
+                continue;
+            await execHookGuardClient(pageContext);
         }
         else {
-            // TO-DO/soon/cumulative-hooks: filter & execute all client-only hooks (see other TO-DO/soon/cumulative-hooks entries)
-            if (hookClientOnlyExists(hookName, pageContext) || !pageContext._hasPageContextFromServer) {
-                if (hookName === 'data')
-                    dataHookExecuted = true;
-                // This won't do anything if no hook has been defined or if the hook's env.client is false.
-                await execHookDataLike(hookName, pageContext);
-            }
+            if (hookName === 'data')
+                dataHookExecuted = true;
+            await execHookDataLike(hookName, pageContext);
         }
     }
     // Execute +onData
@@ -104,6 +105,9 @@ async function getPageContextFromClientHooks(pageContext, isErrorPage) {
 async function execHookClient(hookName, pageContext) {
     return await execHook(hookName, pageContext, (p) => preparePageContextForPublicUsageClient(p));
 }
+// It's a no-op if:
+// - No hook has been defined, or
+// - The hook's `env.client` is `false`
 async function execHookDataLike(hookName, pageContext) {
     let pageContextFromHook;
     if (hookName === 'data') {
@@ -178,7 +182,7 @@ function hookClientOnlyExists(hookName, pageContext) {
 }
 function getHookEnv(hookName, pageContext) {
     if (isOldDesign(pageContext)) {
-        // Client-only onBeforeRender() or data() hooks were never supported for the V0.4 design
+        // Client-only onBeforeRender(), data(), or guard() hooks were never supported for the V0.4 design
         return { client: false, server: true };
     }
     const pageConfig = getPageConfig(pageContext.pageId, pageContext._globalContext._pageConfigs);
@@ -225,3 +229,6 @@ function processPageContextFromServer(pageContext) {
 function isOldDesign(pageContext) {
     return pageContext._globalContext._pageConfigs.length === 0;
 }
+async function execHookGuardClient(pageContext) {
+    await execHookGuard(pageContext, (pageContext) => preparePageContextForPublicUsageClient(pageContext));
+}

package/dist/esm/node/vite/shared/resolveVikeConfigInternal/configDefinitionsBuiltIn.js

@@ -142,6 +142,7 @@ const configDefinitionsBuiltIn = {
                 !!getConfigEnv(pageConfig, 'Page')?.client);
         },
     },
+    // TODO/now: rename entries comments
     // TO-DO/soon/cumulative-hooks: remove and replace with new computed prop `clientOnlyHooks: string[]` (see other TO-DO/soon/cumulative-hooks entries)
     onBeforeRenderEnv: {
         env: { client: true },
@@ -158,6 +159,14 @@ const configDefinitionsBuiltIn = {
             return !isConfigSet(pageConfig, 'data') ? null : getConfigEnv(pageConfig, 'data');
         },
     },
+    // TO-DO/soon/cumulative-hooks: remove and replace with new computed prop `clientOnlyHooks: string[]` (see other TO-DO/soon/cumulative-hooks entries)
+    guardEnv: {
+        env: { client: true },
+        eager: true,
+        _computed: (pageConfig) => {
+            return !isConfigSet(pageConfig, 'guard') ? null : getConfigEnv(pageConfig, 'guard');
+        },
+    },
     hooksTimeout: {
         env: { server: true, client: true },
     },

package/dist/esm/types/Config.d.ts

@@ -52,7 +52,7 @@ type HookName = HookNamePage | HookNameGlobal;
 type HookNamePage = 'onHydrationEnd' | 'onBeforePrerenderStart' | 'onBeforeRender' | 'onPageTransitionStart' | 'onPageTransitionEnd' | 'onRenderHtml' | 'onRenderClient' | 'guard' | 'data' | 'onData' | 'route';
 type HookNameGlobal = 'onBeforeRoute' | 'onPrerenderStart' | 'onCreatePageContext' | 'onCreateGlobalContext' | 'onError';
 type HookNameOldDesign = 'render' | 'prerender' | 'onBeforePrerender';
-type ConfigNameBuiltIn = Exclude<keyof ConfigBuiltIn, keyof VikeVitePluginOptions | 'onBeforeRoute' | 'onPrerenderStart' | 'vite' | 'redirects'> | 'prerender' | 'hasServerOnlyHook' | 'isClientRuntimeLoaded' | 'onBeforeRenderEnv' | 'dataEnv' | 'hooksTimeout' | 'clientHooks' | 'middleware';
+type ConfigNameBuiltIn = Exclude<keyof ConfigBuiltIn, keyof VikeVitePluginOptions | 'onBeforeRoute' | 'onPrerenderStart' | 'vite' | 'redirects'> | 'prerender' | 'hasServerOnlyHook' | 'isClientRuntimeLoaded' | 'onBeforeRenderEnv' | 'dataEnv' | 'guardEnv' | 'hooksTimeout' | 'clientHooks' | 'middleware';
 type ConfigNameGlobal = 'onPrerenderStart' | 'onBeforeRoute' | 'prerender' | 'disableAutoFullBuild' | 'includeAssetsImportedByServer' | 'baseAssets' | 'baseServer' | 'redirects' | 'trailingSlash' | 'disableUrlNormalization' | 'vite';
 type Config = ConfigBuiltIn & Vike.Config;
 /** @deprecated This type is deprecated, see:

package/dist/esm/utils/PROJECT_VERSION.d.ts

@@ -1 +1 @@
-export declare const PROJECT_VERSION: "0.4.247-commit-a642bde";
+export declare const PROJECT_VERSION: "0.4.247-commit-903de25";

package/dist/esm/utils/PROJECT_VERSION.js

@@ -1,2 +1,2 @@
 // Automatically updated by @brillout/release-me
-export const PROJECT_VERSION = '0.4.247-commit-a642bde';
+export const PROJECT_VERSION = '0.4.247-commit-903de25';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vike",
-  "version": "0.4.247-commit-a642bde",
+  "version": "0.4.247-commit-903de25",
   "repository": "https://github.com/vikejs/vike",
   "exports": {
     "./server": {