vike 0.4.236-commit-e752d12 → 0.4.236-commit-08fbc10

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

@@ -2,15 +2,12 @@ export { pushHistoryState };
 export { replaceHistoryStateOriginal };
 export { onPopStateBegin };
 export { saveScrollPosition };
-export { initHistory };
+export { initHistoryState };
+export { monkeyPatchHistoryAPI };
 import { getCurrentUrl } from '../shared/getCurrentUrl.js';
 import { assert, assertUsage, getGlobalObject, isObject } from './utils.js';
-const globalObject = getGlobalObject('history.ts', {
-    monkeyPatched: false,
-    previous: undefined,
-});
-initHistory(); // we redundantly call initHistory() to ensure it's called early
-globalObject.previous = getHistoryInfo();
+initHistoryState(); // we redundantly call initHistoryState() to ensure it's called early
+const globalObject = getGlobalObject('runtime-client-routing/history.ts', { previous: getHistoryInfo() });
 // `window.history.state === null` when:
 // - The very first render
 // - Click on `<a href="#some-hash" />`
@@ -44,7 +41,7 @@ function enhance(stateNotEnhanced) {
             _isVikeEnhanced: true,
         };
     }
-    assertIsVikeEnhanced(stateVikeEnhanced);
+    assert(isVikeEnhanced(stateVikeEnhanced));
     return stateVikeEnhanced;
 }
 function getState() {
@@ -54,7 +51,7 @@ function getState() {
     // - Therefore, we have to monkey patch history.pushState() and history.replaceState()
     // - Therefore, we need the assert() below to ensure history.state has been enhanced by Vike
     //   - If users stumble upon this assert() then let's make it a assertUsage()
-    assertIsVikeEnhanced(state);
+    assert(isVikeEnhanced(state), { state });
     return state;
 }
 function getStateNotEnhanced() {
@@ -93,7 +90,6 @@ function pushHistoryState(url, overwriteLastHistoryEntry) {
 function replaceHistoryState(state, url) {
     const url_ = url ?? null; // Passing `undefined` chokes older Edge versions.
     window.history.replaceState(state, '', url_);
-    assertIsVikeEnhanced(getState());
 }
 function replaceHistoryStateOriginal(state, url) {
     // Bypass all monkey patches.
@@ -104,11 +100,7 @@ function replaceHistoryStateOriginal(state, url) {
 // - history.pushState()
 // - history.replaceState()
 function monkeyPatchHistoryAPI() {
-    if (globalObject.monkeyPatched)
-        return;
-    globalObject.monkeyPatched = true;
-    // Ensure Vike's monkey patch is the first.
-    assert(window.history.pushState === History.prototype.pushState);
+    ;
     ['pushState', 'replaceState'].forEach((funcName) => {
         const funcOriginal = window.history[funcName].bind(window.history);
         window.history[funcName] = (stateOriginal = {}, ...rest) => {
@@ -122,14 +114,11 @@ function monkeyPatchHistoryAPI() {
                     triggeredBy: 'user',
                     ...stateOriginal,
                 };
-            assertIsVikeEnhanced(stateEnhanced);
-            funcOriginal(stateEnhanced, ...rest);
-            assertIsVikeEnhanced(getState());
+            assert(isVikeEnhanced(stateEnhanced));
+            const ret = funcOriginal(stateEnhanced, ...rest);
             globalObject.previous = getHistoryInfo();
+            return ret;
         };
-        window.history[funcName]._isVikeMonkeyPatch = true;
-        // Ensure assert() above isn't a false positive
-        assert(window.history.pushState !== History.prototype.pushState);
     });
 }
 function isVikeEnhanced(state) {
@@ -147,16 +136,6 @@ function isVikeEnhanced(state) {
     }
     return false;
 }
-function assertIsVikeEnhanced(state) {
-    if (isVikeEnhanced(state))
-        return;
-    assert(false, {
-        state,
-        // TO-DO/eventually: remove _isVikeMonkeyPatch debug info to save KBs
-        pushStateIsVikeMonkeyPatch: window.history.pushState._isVikeMonkeyPatch,
-        replaceStateIsVikeMonkeyPatch: window.history.replaceState._isVikeMonkeyPatch,
-    });
-}
 function getHistoryInfo() {
     return {
         url: getCurrentUrl(),
@@ -168,12 +147,11 @@ function onPopStateBegin() {
     const isHistoryStateEnhanced = window.history.state !== null;
     if (!isHistoryStateEnhanced)
         enhanceHistoryState();
-    assertIsVikeEnhanced(window.history.state);
+    assert(isVikeEnhanced(window.history.state));
     const current = getHistoryInfo();
     globalObject.previous = current;
     return { isHistoryStateEnhanced, previous, current };
 }
-function initHistory() {
-    monkeyPatchHistoryAPI(); // the earlier we call it the better (Vike can workaround erroneous library monkey patches if Vike is the last one in the monkey patch chain)
-    enhanceHistoryState(); // enhance very first window.history.state which is `null`
+function initHistoryState() {
+    enhanceHistoryState();
 }

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

@@ -6,7 +6,7 @@ import { initOnLinkClick } from './initOnLinkClick.js';
 import { scrollRestoration_init } from './scrollRestoration.js';
 import { autoSaveScrollPosition } from './setScrollPosition.js';
 import { initLinkPrefetchHandlers } from './prefetch.js';
-import { initHistory } from './history.js';
+import { initHistoryState, monkeyPatchHistoryAPI } from './history.js';
 async function initClientRouter() {
     // Init navigation history and scroll restoration
     initHistoryAndScroll();
@@ -29,7 +29,8 @@ async function renderFirstPage() {
 }
 function initHistoryAndScroll() {
     scrollRestoration_init();
-    initHistory(); // we redundantly call initHistory() to ensure it's called early
+    monkeyPatchHistoryAPI();
+    initHistoryState(); // we redundantly call initHistoryState() to ensure it's called early
     autoSaveScrollPosition();
     // Handle back-/forward navigation
     initOnPopState();

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

@@ -84,7 +84,7 @@ async function renderPageClientSide(renderArgs) {
                     return;
             }
         }
-        // Route
+        // Get pageContext serialized in <script id="vike_pageContext" type="application/json">
         if (isFirstRender) {
             const pageContextSerialized = getPageContextFromHooks_serialized();
             // TO-DO/eventually: create helper assertPageContextFromHook()
@@ -93,7 +93,9 @@ async function renderPageClientSide(renderArgs) {
             // TO-DO/pageContext-prefetch: remove or change, because this only makes sense for a pre-rendered page
             populatePageContextPrefetchCache(pageContext, { pageContextFromServerHooks: pageContextSerialized });
         }
-        else {
+        // Route
+        // - We must also run it upon hydration to call the onBeforeRoute() hook, which is needed for i18n URL locale extraction.
+        {
             let pageContextFromRoute;
             try {
                 pageContextFromRoute = await route(pageContext);
@@ -104,38 +106,49 @@ async function renderPageClientSide(renderArgs) {
             }
             if (isRenderOutdated())
                 return;
-            if (!pageContextFromRoute.pageId) {
-                /*
-                // We don't use the client router to render the 404 page:
-                //  - So that the +redirects setting (https://vike.dev/redirects) can be applied.
-                //    - This is the main argument.
-                //    - See also failed CI: https://github.com/vikejs/vike/pull/1871
-                //  - So that server-side error tracking can track 404 links?
-                //    - We do use the client router for rendering the error page, so I don't think this is much of an argument.
-                await renderErrorPage({ is404: true })
-                */
-                redirectHard(urlOriginal);
-                return;
+            // TO-DO/eventually: create helper assertPageContextFromHook()
+            assert(!('urlOriginal' in pageContextFromRoute));
+            if (isFirstRender) {
+                // Set pageContext properties set by onBeforeRoute()
+                // - But we skip pageId and routeParams because routing may have been aborted by a server-side `throw render()`
+                const { pageId, routeParams, ...pageContextFromRouteRest } = pageContextFromRoute;
+                objectAssign(pageContext, pageContextFromRouteRest);
+                assert(hasProp(pageContext, 'routeParams', 'string{}')); // Help TS
             }
-            assert(hasProp(pageContextFromRoute, 'pageId', 'string')); // Help TS
-            const isClientRoutable = await isClientSideRoutable(pageContextFromRoute.pageId, pageContext);
-            if (isRenderOutdated())
-                return;
-            if (!isClientRoutable) {
-                redirectHard(urlOriginal);
-                return;
+            else {
+                objectAssign(pageContext, pageContextFromRoute);
             }
-            const isSamePage = pageContextFromRoute.pageId &&
-                previousPageContext?.pageId &&
-                pageContextFromRoute.pageId === previousPageContext.pageId;
-            if (doNotRenderIfSamePage && isSamePage) {
-                // Skip's Vike's rendering; let the user handle the navigation
-                return;
+            if (!isFirstRender) {
+                if (!pageContextFromRoute.pageId) {
+                    /*
+                    // We don't use the client router to render the 404 page:
+                    //  - So that the +redirects setting (https://vike.dev/redirects) can be applied.
+                    //    - This is the main argument.
+                    //    - See also failed CI: https://github.com/vikejs/vike/pull/1871
+                    //  - So that server-side error tracking can track 404 links?
+                    //    - We do use the client router for rendering the error page, so I don't think this is much of an argument.
+                    await renderErrorPage({ is404: true })
+                    */
+                    redirectHard(urlOriginal);
+                    return;
+                }
+                const isClientRoutable = await isClientSideRoutable(pageContextFromRoute.pageId, pageContext);
+                if (isRenderOutdated())
+                    return;
+                if (!isClientRoutable) {
+                    redirectHard(urlOriginal);
+                    return;
+                }
+                const isSamePage = pageContextFromRoute.pageId &&
+                    previousPageContext?.pageId &&
+                    pageContextFromRoute.pageId === previousPageContext.pageId;
+                if (doNotRenderIfSamePage && isSamePage) {
+                    // Skip's Vike's rendering; let the user handle the navigation
+                    return;
+                }
             }
-            // TO-DO/eventually: create helper assertPageContextFromHook()
-            assert(!('urlOriginal' in pageContextFromRoute));
-            objectAssign(pageContext, pageContextFromRoute);
         }
+        assert(hasProp(pageContext, 'pageId', 'string')); // Help TS
         const res = await loadPageConfigsLazyClientSideAndExecHook(pageContext, isFirstRender, isRenderOutdated);
         /* Already called inside loadPageConfigsLazyClientSideAndExecHook()
         if (isRenderOutdated()) return

package/dist/esm/node/runtime/renderPage/getPageAssets/retrieveAssetsDev.js

@@ -1,11 +1,13 @@
 export { retrieveAssetsDev };
 import { assert, styleFileRE } from '../../utils.js';
+import { isVirtualFileIdEntry } from '../../../shared/virtualFiles/virtualFileEntry.js';
 async function retrieveAssetsDev(clientDependencies, viteDevServer) {
     const assetUrls = new Set();
     await Promise.all(clientDependencies.map(async ({ id }) => {
         if (id.startsWith('@@vike'))
             return; // vike doesn't have any CSS
         assert(id);
+        assert(!isVirtualFileIdEntry(id));
         const { moduleGraph } = viteDevServer;
         const [_, graphId] = await moduleGraph.resolveUrl(id);
         assert(graphId, { id });
@@ -32,6 +34,8 @@ function collectCss(mod, styleUrls, visitedModules, importer) {
     if (visitedModules.has(mod.url))
         return;
     visitedModules.add(mod.url);
+    if (isVirtualFileIdEntry(mod.id || mod.url))
+        return; // virtual:vike:entry:server dependency list includes all pages
     if (isStyle(mod) && (!importer || !isStyle(importer))) {
         if (mod.url.startsWith('/')) {
             styleUrls.add(mod.url);

package/dist/esm/node/runtime/utils.d.ts

@@ -42,6 +42,7 @@ export * from '../../utils/assertSetup.js';
 export * from '../../utils/path.js';
 export * from '../../utils/isHtml.js';
 export * from '../../utils/warnIfErrorIsNotObject.js';
+export * from '../../utils/virtualFileId.js';
 export * from '../../utils/stripAnsi.js';
 export * from '../../utils/getTerminWidth.js';
 export * from '../../utils/truncateString.js';

package/dist/esm/node/runtime/utils.js

@@ -46,6 +46,7 @@ export * from '../../utils/assertSetup.js';
 export * from '../../utils/path.js';
 export * from '../../utils/isHtml.js';
 export * from '../../utils/warnIfErrorIsNotObject.js';
+export * from '../../utils/virtualFileId.js';
 export * from '../../utils/stripAnsi.js';
 export * from '../../utils/getTerminWidth.js';
 export * from '../../utils/truncateString.js';

package/dist/esm/node/shared/utils.d.ts

@@ -14,3 +14,4 @@ export * from '../../utils/assertIsNotBrowser.js';
 export * from '../../utils/isNullish.js';
 export * from '../../utils/unique.js';
 export * from '../../utils/debug.js';
+export * from '../../utils/virtualFileId.js';

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

@@ -16,3 +16,4 @@ export * from '../../utils/assertIsNotBrowser.js';
 export * from '../../utils/isNullish.js';
 export * from '../../utils/unique.js';
 export * from '../../utils/debug.js';
+export * from '../../utils/virtualFileId.js';

package/dist/esm/node/shared/virtualFiles/virtualFileEntry.js

@@ -2,24 +2,26 @@ export { virtualFileIdEntryServer };
 export { virtualFileIdEntryClientSR };
 export { virtualFileIdEntryClientCR };
 export { isVirtualFileIdEntry };
-import { assert } from '../utils.js';
-import { getVirtualFileId } from '../virtualFiles.js';
+// TODO/now: merge virtualFileEntry.ts and virtualFilePageConfigLazy.ts
+// - One function parseVirtualFileIdEntry() to rule them all?
+import { assert, assertIsNotBrowser, removeVirtualFileIdPrefix } from '../utils.js';
+assertIsNotBrowser();
+// TODO/now: rename:
+// ```diff
+// - virtual:vike:entry:server
+// + virtual:vike:entry:global:server
+// ```
+const virtualFileIdEntryServer = 'virtual:vike:entry:server';
+const virtualFileIdEntryClientSR = 'virtual:vike:entry:client:server-routing';
+const virtualFileIdEntryClientCR = 'virtual:vike:entry:client:client-routing';
+const virtualFileIdEntries = [virtualFileIdEntryServer, virtualFileIdEntryClientCR, virtualFileIdEntryClientSR];
 const idBase = 'virtual:vike:entry';
-const virtualFileIdEntryServer = `${idBase}:server`;
-const virtualFileIdEntryClientSR = `${idBase}:client:server-routing`;
-const virtualFileIdEntryClientCR = `${idBase}:client:client-routing`;
+assert(virtualFileIdEntries.every((v) => v.startsWith(`${idBase}:`)));
 function isVirtualFileIdEntry(id) {
-    id = getVirtualFileId(id);
+    id = removeVirtualFileIdPrefix(id);
     if (!id.startsWith(idBase))
         return false;
-    assert(
-    // prettier-ignore
-    // biome-ignore format:
-    [
-        virtualFileIdEntryServer,
-        virtualFileIdEntryClientCR,
-        virtualFileIdEntryClientSR
-    ].includes(id));
+    assert(virtualFileIdEntries.includes(id));
     const isForClientSide = id !== virtualFileIdEntryServer;
     const isClientRouting = id === virtualFileIdEntryClientCR;
     return { isForClientSide, isClientRouting };

package/dist/esm/node/shared/virtualFiles/virtualFilePageConfigLazy.js

@@ -1,17 +1,23 @@
 export { isVirtualFileIdPageConfigLazy };
 export { getVirtualFileIdPageConfigLazy };
 import { extractAssetsRemoveQuery } from '../extractAssetsQuery.js';
-import { assert } from '../utils.js';
-import { getVirtualFileId } from '../virtualFiles.js';
+import { assert, assertIsNotBrowser, removeVirtualFileIdPrefix } from '../utils.js';
+assertIsNotBrowser();
+// TODO/now: rename:
+// ```diff
+// - virtual:vike:pageConfigLazy:server:
+// + virtual:vike:entry:page:server:
+// ```
+const idBaseClient = 'virtual:vike:pageConfigLazy:client:';
+const idBaseServer = 'virtual:vike:pageConfigLazy:server:';
 const idBase = 'virtual:vike:pageConfigLazy:';
-const idBaseClient = `${idBase}client:`;
-const idBaseServer = `${idBase}server:`;
+// TODO/now: rename to generateVirtualFileIdEntry()
 function getVirtualFileIdPageConfigLazy(pageId, isForClientSide) {
     const id = `${isForClientSide ? idBaseClient : idBaseServer}${pageId}`;
     return id;
 }
 function isVirtualFileIdPageConfigLazy(id) {
-    id = getVirtualFileId(id);
+    id = removeVirtualFileIdPrefix(id);
     if (!id.includes(idBase))
         return false;
     assert(id.startsWith(idBase));

package/dist/esm/node/vite/plugins/pluginBuild/pluginBuildApp.js

@@ -6,6 +6,34 @@ import { isPrerenderForceExit } from './pluginAutoFullBuild.js';
 import { getVikeConfigInternal } from '../../shared/resolveVikeConfigInternal.js';
 function pluginBuildApp() {
     return [
+        {
+            name: 'vike:build:pluginBuildApp:pre',
+            apply: 'build',
+            enforce: 'pre',
+            config: {
+                order: 'pre',
+                async handler(_config) {
+                    const vikeConfig = await getVikeConfigInternal();
+                    if (!vikeConfig.config.vite6BuilderApp)
+                        return;
+                    return {
+                        builder: {
+                            // Can be overridden by another plugin e.g vike-vercel https://github.com/vikejs/vike/pull/2184#issuecomment-2659425195
+                            async buildApp(builder) {
+                                assert(builder.environments.client);
+                                assert(builder.environments.ssr);
+                                await builder.build(builder.environments.client);
+                                await builder.build(builder.environments.ssr);
+                                if (isPrerenderForceExit()) {
+                                    runPrerender_forceExit();
+                                    assert(false);
+                                }
+                            },
+                        },
+                    };
+                },
+            },
+        },
         {
             name: 'vike:build:pluginBuildApp',
             apply: 'build',
@@ -14,19 +42,6 @@ function pluginBuildApp() {
                 if (!vikeConfig.config.vite6BuilderApp)
                     return;
                 return {
-                    builder: {
-                        // Can be overridden by another plugin e.g vike-vercel https://github.com/vikejs/vike/pull/2184#issuecomment-2659425195
-                        async buildApp(builder) {
-                            assert(builder.environments.client);
-                            assert(builder.environments.ssr);
-                            await builder.build(builder.environments.client);
-                            await builder.build(builder.environments.ssr);
-                            if (isPrerenderForceExit()) {
-                                runPrerender_forceExit();
-                                assert(false);
-                            }
-                        },
-                    },
                     environments: {
                         ssr: {
                             consumer: 'server',

package/dist/esm/node/vite/plugins/pluginBuild/pluginDistFileNames.js

@@ -151,13 +151,8 @@ function getEntryFileName(chunkInfo, config, isEntry) {
         return `${name}.${isEntry ? 'mjs' : 'js'}`;
     }
 }
-function removePathSeparators(name, userRootDir) {
+function removePathSeparators(name) {
     assertPosixPath(name);
-    if (name.startsWith(userRootDir)) {
-        name = name.slice(userRootDir.length);
-        if (name.startsWith('/'))
-            name = name.slice(1);
-    }
     assert(!name.startsWith('/'), { name });
     const entryDir = 'entries/';
     const hasEntryDir = name.startsWith(entryDir);
@@ -171,14 +166,24 @@ function removePathSeparators(name, userRootDir) {
     }
     return name;
 }
+function removeUserRootDir(name, userRootDir) {
+    if (name.startsWith(userRootDir)) {
+        name = name.slice(userRootDir.length);
+        if (name.startsWith('/'))
+            name = name.slice(1);
+    }
+    assert(!name.startsWith('/'), { name });
+    return name;
+}
 function clean(name, userRootDir, removePathSep, fixGlob) {
+    name = removeUserRootDir(name, userRootDir);
     name = fixExtractAssetsQuery(name);
     if (fixGlob) {
         name = workaroundGlob(name);
     }
     name = replaceNonLatinCharacters(name);
     if (removePathSep) {
-        name = removePathSeparators(name, userRootDir);
+        name = removePathSeparators(name);
     }
     name = removeLeadingUnderscoreInFilename(name);
     name = removeUnderscoreDoublets(name);

package/dist/esm/node/vite/plugins/pluginBuild/pluginModuleBanner.js

@@ -1,6 +1,6 @@
 export { pluginModuleBanner };
 import MagicString from 'magic-string';
-import { removeVirtualIdTag } from '../../../shared/virtualFiles.js';
+import { removeVirtualFileIdPrefix } from '../../utils.js';
 import { isViteServerBuild_safe } from '../../shared/isViteServerBuild.js';
 // Rollup's banner feature doesn't work with Vite: https://github.com/vitejs/vite/issues/8412
 // But, anyways, we want to prepend the banner at the beginning of each module, not at the beginning of each file (I believe that's what Rollup's banner feature does).
@@ -23,7 +23,7 @@ function pluginModuleBanner() {
                 }
                 if (id.startsWith('\0'))
                     id = id;
-                id = removeVirtualIdTag(id);
+                id = removeVirtualFileIdPrefix(id);
                 if (id.startsWith(config.root))
                     id = id.slice(config.root.length + 1);
                 id = id.replaceAll('*/', '*\\/'); // https://github.com/vikejs/vike/issues/2377