vike 0.4.246 → 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/api/resolveViteConfigFromUser.js

@@ -89,7 +89,7 @@ async function getViteInfo(viteConfigFromUserVikeApiOptions, viteContext) {
         // Show a warning because Vike supports Vite's CLI (as well as third-party CLIs).
         // - Encourage users to define a vite.config.js file that also works with Vite's CLI (and potentially other third-party CLIs).
         // - Vike-based frameworks, such as DocPress, allow their users to omit defining a vite.config.js file.
-        assertWarning(viteConfigFromUserViteConfigFile, // Only show the warning if the user defined a vite.config.js file
+        assertWarning(!viteConfigFromUserViteConfigFile, // Only show the warning if the user defined a vite.config.js file
         "Omitting Vike's Vite plugin (inside your vite.config.js) is deprecated — make sure to always add Vike's Vite plugin https://vike.dev/vite-plugin", { onlyOnce: true });
         // Add Vike to plugins if not present.
         // Using a dynamic import because the script calling the Vike API may not live in the same place as vite.config.js, thus vike/plugin may resolved to two different node_modules/vike directories.

package/dist/esm/node/shared/virtualFileId.js

@@ -30,24 +30,12 @@ const virtualFileIdPageEntryPrefix =
 const virtualFileIdGlobalEntryPrefix = 
 //
 'virtual:vike:global-entry:';
-const virtualFileIdGlobalEntries = [
-    virtualFileIdGlobalEntryServer,
-    virtualFileIdGlobalEntryClientCR,
-    virtualFileIdGlobalEntryClientSR,
-];
-assert(virtualFileIdGlobalEntries.every((v) => 
-//
-v.startsWith(virtualFileIdGlobalEntryPrefix)));
-assert([virtualFileIdPageEntryClient, virtualFileIdPageEntryServer].every((v) => 
-//
-v.startsWith(virtualFileIdPageEntryPrefix)));
 function parseVirtualFileId(id) {
     id = removeVirtualFileIdPrefix(id);
     if (!id.startsWith(virtualFileIdGlobalEntryPrefix) && !id.startsWith(virtualFileIdPageEntryPrefix))
         return false;
     // Global entry
     if (id.includes(virtualFileIdGlobalEntryPrefix)) {
-        assert(virtualFileIdGlobalEntries.includes(id));
         const isForClientSide = id !== virtualFileIdGlobalEntryServer;
         const isClientRouting = id === virtualFileIdGlobalEntryClientCR;
         return {
@@ -58,23 +46,26 @@ function parseVirtualFileId(id) {
     }
     // Page entry
     if (id.includes(virtualFileIdPageEntryPrefix)) {
-        assert(id.startsWith(virtualFileIdPageEntryPrefix));
         const idOriginal = id;
         id = extractAssetsRemoveQuery(id);
         const isExtractAssets = idOriginal !== id;
         if (id.startsWith(virtualFileIdPageEntryClient)) {
             assert(isExtractAssets === false);
+            const pageIdSerialized = id.slice(virtualFileIdPageEntryClient.length);
+            const pageId = deserializePageId(pageIdSerialized);
             return {
                 type: 'page-entry',
-                pageId: id.slice(virtualFileIdPageEntryClient.length),
+                pageId,
                 isForClientSide: true,
                 isExtractAssets,
             };
         }
         if (id.startsWith(virtualFileIdPageEntryServer)) {
+            const pageIdSerialized = id.slice(virtualFileIdPageEntryServer.length);
+            const pageId = deserializePageId(pageIdSerialized);
             return {
                 type: 'page-entry',
-                pageId: id.slice(virtualFileIdPageEntryServer.length),
+                pageId,
                 isForClientSide: false,
                 isExtractAssets,
             };
@@ -86,7 +77,6 @@ function parseVirtualFileId(id) {
 function generateVirtualFileId(args) {
     if (args.type === 'global-entry') {
         const { isForClientSide, isClientRouting } = args;
-        assert(typeof isClientRouting === 'boolean');
         if (!isForClientSide) {
             return virtualFileIdGlobalEntryServer;
         }
@@ -99,9 +89,20 @@ function generateVirtualFileId(args) {
     }
     if (args.type === 'page-entry') {
         const { pageId, isForClientSide } = args;
-        assert(typeof pageId === 'string');
-        const id = `${isForClientSide ? virtualFileIdPageEntryClient : virtualFileIdPageEntryServer}${pageId}`;
+        const pageIdSerialized = serializePageId(pageId);
+        const id = `${isForClientSide ? virtualFileIdPageEntryClient : virtualFileIdPageEntryServer}${pageIdSerialized}`;
         return id;
     }
     assert(false);
 }
+// Workaround:
+// - We replace virtual:vike:page-entry:client:/ with virtual:vike:page-entry:client:ROOT
+// - In order to avoid Vite to replace `virtual:vike:page-entry:client:/` with `virtual:vike:page-entry:client:`
+// - I guess Vite/Rollup mistakenly treat the virtual ID as a path and tries to normalize id
+const ROOT = 'ROOT';
+function serializePageId(pageId) {
+    return pageId === '/' ? ROOT : pageId;
+}
+function deserializePageId(pageId) {
+    return pageId === ROOT ? '/' : pageId;
+}

package/dist/esm/node/vite/plugins/pluginDev/determineOptimizeDeps.js

@@ -1,22 +1,46 @@
 export { determineOptimizeDeps };
 import { findPageFiles } from '../../shared/findPageFiles.js';
-import { assert, assertIsImportPathNpmPackage, createDebugger, getNpmPackageName, isArray, isFilePathAbsoluteFilesystem, isVirtualFileId, } from '../../utils.js';
+import { assert, assertIsImportPathNpmPackage, createDebugger, getNpmPackageName, isArray, isFilePathAbsoluteFilesystem, isVirtualFileId, requireResolveOptional, } from '../../utils.js';
 import { getVikeConfigInternal } from '../../shared/resolveVikeConfigInternal.js';
 import { analyzeClientEntries } from '../build/pluginBuildConfig.js';
 import { virtualFileIdGlobalEntryClientCR, virtualFileIdGlobalEntryClientSR } from '../../../shared/virtualFileId.js';
 import { getFilePathResolved } from '../../shared/getFilePath.js';
 import { getConfigValueSourcesRelevant } from '../pluginVirtualFiles/getConfigValueSourcesRelevant.js';
 const debug = createDebugger('vike:optimizeDeps');
+const WORKAROUND_LATE_DISCOVERY = [
+    // Workaround for https://github.com/vitejs/vite-plugin-react/issues/650
+    // - The issue was closed as completed with https://github.com/vitejs/vite/pull/20495 but it doesn't fix the issue and the workaround is still needed.
+    // - TO-DO/eventually: try removing the workaround and see if the CI fails (at test/@cloudflare_vite-plugin/) — maybe the issue will get fixed at some point.
+    'react/jsx-dev-runtime',
+    // Workaround for https://github.com/vikejs/vike/issues/2823#issuecomment-3514325487
+    '@compiled/react/runtime',
+];
 async function determineOptimizeDeps(config) {
     const vikeConfig = await getVikeConfigInternal();
     const { _pageConfigs: pageConfigs } = vikeConfig;
     const { entriesClient, entriesServer, includeClient, includeServer } = await getPageDeps(config, pageConfigs);
+    WORKAROUND_LATE_DISCOVERY.forEach((dep) => {
+        const userRootDir = config.root;
+        const resolved = requireResolveOptional({ importPath: dep, userRootDir, importerFilePath: null });
+        const resolvedInsideRepo = resolved && resolved.startsWith(userRootDir);
+        if (resolvedInsideRepo) {
+            // We add `dep` only if `resolvedInsideRepo === true` otherwise Vite logs a warning like the following.
+            // - ```console
+            //   [11:22:42.464][/examples/vue-full][npm run dev][stderr] Failed to resolve dependency: react/jsx-dev-runtime, present in client 'optimizeDeps.include'
+            //   ```
+            // - ```console
+            //   [12:24:53.225][/test/@cloudflare_vite-plugin/test-dev.test.ts][npm run dev][stderr] Failed to resolve dependency: @compiled/react/runtime, present in ssr 'optimizeDeps.include'
+            //   ```
+            includeClient.push(dep);
+            includeServer.push(dep);
+        }
+        else if (config.optimizeDeps.include?.includes(dep)) {
+            // Monorepo => always `resolvedInsideRepo === false` — we use this other approach to workaround missing 'react/jsx-dev-runtime'
+            includeServer.push(dep);
+        }
+    });
     config.optimizeDeps.include = add(config.optimizeDeps.include, includeClient);
     config.optimizeDeps.entries = add(config.optimizeDeps.entries, entriesClient);
-    // Workaround for https://github.com/vitejs/vite-plugin-react/issues/650
-    // - The issue was closed as completed with https://github.com/vitejs/vite/pull/20495 but it doesn't fix the issue and the workaround is still needed.
-    // - TO-DO/eventually: try removing the workaround and see if the CI fails (at test/@cloudflare_vite-plugin/) — maybe the issue will get fixed at some point.
-    includeServer.push('react/jsx-dev-runtime');
     for (const envName in config.environments) {
         const env = config.environments[envName];
         if (env.consumer === 'server' && env.optimizeDeps.noDiscovery === false) {

package/dist/esm/node/vite/plugins/pluginDev.js

@@ -21,38 +21,21 @@ function pluginDev() {
                 handler() {
                     return {
                         appType: 'custom',
-                        // TO-DO/next-major-release: remove (AFAICT we only need to use config.optimizeDeps for the old design)
                         optimizeDeps: {
                             exclude: [
-                                // We exclude Vike's client runtime to be able to use Vite's import.meta.glob()
+                                // We must exclude Vike's client runtime so it can import virtual modules
                                 'vike/client',
                                 'vike/client/router',
-                                // It seems like client-side/isomorphic imports also need to be excluded, in order to avoid the following:
-                                //   ```
-                                //   Client runtime loaded twice https://vike.dev/client-runtime-duplicated
-                                //   ```
-                                'vike/routing',
-                                'vike/getPageContext',
-                                // We exclude @brillout/json-serializer and @brillout/picocolors to avoid:
+                            ],
+                            include: [
+                                // Avoid:
                                 // ```
                                 // 9:28:58 AM [vite] ✨ new dependencies optimized: @brillout/json-serializer/parse
                                 // 9:28:58 AM [vite] ✨ optimized dependencies changed. reloading
                                 // ```
-                                '@brillout/json-serializer/parse',
-                                '@brillout/json-serializer/stringify',
-                                '@brillout/picocolors',
-                                // We exclude all packages that depend on any optimizeDeps.exclude entry because, otherwise, the entry cannot be resolved when using pnpm. For example:
-                                // ```
-                                // Failed to resolve import "@brillout/json-serializer/parse" from "../../packages/vike-react-query/dist/renderer/VikeReactQueryWrapper.js". Does the file exist?
-                                // 343|  // ../../node_modules/.pnpm/react-streaming@0.3.16_react-dom@18.2.0_react@18.2.0/node_modules/react-streaming/dist/esm/client/useAsync.js
-                                // 344|  import { parse as parse2 } from "@brillout/json-serializer/parse";
-                                // ```
-                                // The source map is confusing, the import actually lives at node_modules/.vite/deps/vike-react-query_renderer_VikeReactQueryWrapper.js which contains:
-                                // ```js
-                                // // ../../node_modules/.pnpm/react-streaming@0.3.16_react-dom@18.2.0_react@18.2.0/node_modules/react-streaming/dist/esm/client/useAsync.js
-                                // import { parse as parse2 } from "@brillout/json-serializer/parse";
-                                // ```
-                                'react-streaming',
+                                'vike > @brillout/json-serializer/parse',
+                                'vike > @brillout/json-serializer/stringify',
+                                'vike > @brillout/picocolors',
                             ],
                         },
                     };

package/dist/esm/node/vite/plugins/pluginViteConfigVikeExtensions.js

@@ -21,6 +21,8 @@ async function pluginViteConfigVikeExtensions() {
     }));
     const pluginsFromExtensions = (viteConfigFromExtensions.plugins ?? []);
     delete viteConfigFromExtensions.plugins;
+    // Avoid infinite loop
+    assertUsage(!pluginsFromExtensions.some((p) => p.name?.startsWith('vike:')), "Adding Vike's Vite plugin using +vite is forbidden");
     return [
         ...pluginsFromExtensions,
         {

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/node/vite/shared/resolveVikeConfigInternal/resolvePointerImport.js

@@ -73,8 +73,10 @@ function resolveImportPathWithNode(pointerImportData, importerFilePath, userRoot
     });
     if (!filePathAbsoluteFilesystem) {
         assert(!isImportPathRelative(pointerImportData.importPath));
+        /* This assertion fails if the npm package has a wrongly defined package.json#exports
         // Libraries don't use path aliases => filePathAbsoluteFilesystem should be defined
-        assert(!importerFilePathAbsolute.includes('node_modules'));
+        assert(!importerFilePathAbsolute.includes('node_modules'))
+        */
     }
     return filePathAbsoluteFilesystem;
 }

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/types/defineConfig.d.ts

@@ -1,3 +1,3 @@
 export { defineConfig };
 import type { Config } from './Config.js';
-declare function defineConfig(config: Config): Config;
+declare function defineConfig<T extends Config>(config: T): T;

package/dist/esm/types/defineConfig.js

@@ -1,4 +1,6 @@
 export { defineConfig };
+// For JavaScript users. AFAICT there isn't another practical reason to use defineConfig() instead of `Config`.
+// https://github.com/vikejs/vike/issues/1156
 function defineConfig(config) {
     return config;
 }

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

@@ -1 +1 @@
-export declare const PROJECT_VERSION: "0.4.246";
+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.246';
+export const PROJECT_VERSION = '0.4.247-commit-903de25';

package/dist/esm/utils/assert.js

@@ -41,7 +41,7 @@ function assert(condition, debugInfo) {
             return null;
         }
         const debugInfoSerialized = typeof debugInfo === 'string' ? debugInfo : JSON.stringify(debugInfo);
-        return pc.dim(`Debug info for Vike maintainers (you can ignore this): ${debugInfoSerialized}`);
+        return pc.dim(`Debug for maintainers (you can ignore this): ${debugInfoSerialized}`);
     })();
     const link = pc.underline('https://github.com/vikejs/vike/issues/new?template=bug.yml');
     let errMsg = [

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

@@ -5,7 +5,7 @@ export { requireResolveDistFile };
 export { getPackageNodeModulesDirectory };
 declare function requireResolveOptional({ importPath, importerFilePath, userRootDir, }: {
     importPath: string;
-    importerFilePath: string;
+    importerFilePath: string | null;
     userRootDir: string;
 }): string | null;
 declare function requireResolveOptionalDir({ importPath, importerDir, userRootDir, }: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vike",
-  "version": "0.4.246",
+  "version": "0.4.247-commit-903de25",
   "repository": "https://github.com/vikejs/vike",
   "exports": {
     "./server": {
@@ -15,7 +15,8 @@
       "types": "./dist/esm/client/runtime-server-routing/index.d.ts"
     },
     "./types": {
-      "types": "./dist/esm/types/index.d.ts"
+      "types": "./dist/esm/types/index.d.ts",
+      "default": "./dist/esm/types/index.js"
     },
     "./client/router": {
       "worker": "./dist/esm/node/client/router.js",