vike 0.4.236-commit-79f1ef0 → 0.4.236-commit-cd565e9

package/dist/cjs/node/runtime/globalContext.js

@@ -278,7 +278,7 @@ async function loadBuildEntry(outDir) {
     assertBuildEntry(buildEntry);
     globalObject.assetsManifest = buildEntry.assetsManifest;
     globalObject.buildInfo = buildEntry.buildInfo;
-    await setGlobalContext(buildEntry.virtualFileExports);
+    await createGlobalContext(buildEntry.virtualFileExports);
 }
 // This is the production entry, see:
 // https://github.com/vikejs/vike/blob/798e5465dc3e3e6723b38b601a50350c0a006fb8/packages/vike/node/vite/plugins/pluginBuild/pluginBuildEntry.ts#L47
@@ -323,6 +323,7 @@ function assertVersionAtBuildTime(versionAtBuildTime) {
     (0, utils_js_1.assertUsage)(versionAtBuildTime === versionAtRuntime, `Re-build your app (you're using ${pretty(versionAtRuntime)} but your app was built with ${pretty(versionAtBuildTime)})`);
 }
 async function updateUserFiles() {
+    debug('updateUserFiles()');
     (0, utils_js_1.assert)(!globalObject.isProduction);
     const { promise, resolve } = (0, utils_js_1.genPromise)();
     globalObject.waitForUserFilesUpdate = promise;
@@ -405,7 +406,7 @@ async function updateUserFiles() {
         return { success: false };
     }
     try {
-        await setGlobalContext(virtualFileExports);
+        await createGlobalContext(virtualFileExports);
     }
     catch (err_) {
         hasError = true;
@@ -417,8 +418,8 @@ async function updateUserFiles() {
         return onError(err);
     return onSuccess();
 }
-async function setGlobalContext(virtualFileExports) {
-    debug('setGlobalContext()');
+async function createGlobalContext(virtualFileExports) {
+    debug('createGlobalContext()');
     (0, utils_js_1.assert)(!(0, getVikeConfigError_js_1.getVikeConfigErrorBuild)());
     const globalContext = await (0, createGlobalContextShared_js_1.createGlobalContextShared)(virtualFileExports, globalObject, addGlobalContext, addGlobalContextTmp, addGlobalContextAsync);
     (0, assertV1Design_js_1.assertV1Design)(
@@ -426,8 +427,8 @@ async function setGlobalContext(virtualFileExports) {
     globalContext._pageConfigs.length > 0, globalContext._pageFilesAll);
     assertGlobalContextIsDefined();
     (0, utils_js_1.onSetupRuntime)();
-    debug('setGlobalContext() - done');
-    // Never actually used, only used for TypeScript `ReturnType<typeof setGlobalContext>`
+    debug('createGlobalContext() - done');
+    // Never actually used, only used for TypeScript `ReturnType<typeof createGlobalContext>`
     return globalContext;
 }
 async function addGlobalContextTmp(globalContext) {

package/dist/cjs/utils/PROJECT_VERSION.js

@@ -2,4 +2,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PROJECT_VERSION = void 0;
 // Automatically updated by @brillout/release-me
-exports.PROJECT_VERSION = '0.4.236-commit-79f1ef0';
+exports.PROJECT_VERSION = '0.4.236-commit-cd565e9';

package/dist/esm/client/runtime-client-routing/history.d.ts

@@ -2,8 +2,7 @@ export { pushHistoryState };
 export { replaceHistoryStateOriginal };
 export { onPopStateBegin };
 export { saveScrollPosition };
-export { initHistoryState };
-export { monkeyPatchHistoryAPI };
+export { initHistory };
 export type { HistoryInfo };
 export type { ScrollPosition };
 type StateEnhanced = {
@@ -18,8 +17,7 @@ type ScrollPosition = {
 };
 declare function saveScrollPosition(): void;
 declare function pushHistoryState(url: string, overwriteLastHistoryEntry: boolean): void;
-declare function replaceHistoryStateOriginal(state: unknown, url: string): void;
-declare function monkeyPatchHistoryAPI(): void;
+declare function replaceHistoryStateOriginal(state: unknown, url: Parameters<typeof window.history.replaceState>[2]): void;
 type HistoryInfo = {
     url: `/${string}`;
     state: StateEnhanced;
@@ -29,4 +27,4 @@ declare function onPopStateBegin(): {
     previous: HistoryInfo;
     current: HistoryInfo;
 };
-declare function initHistoryState(): void;
+declare function initHistory(): void;

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

@@ -2,12 +2,15 @@ export { pushHistoryState };
 export { replaceHistoryStateOriginal };
 export { onPopStateBegin };
 export { saveScrollPosition };
-export { initHistoryState };
-export { monkeyPatchHistoryAPI };
+export { initHistory };
 import { getCurrentUrl } from '../shared/getCurrentUrl.js';
-import { assert, assertUsage, getGlobalObject, isObject } from './utils.js';
-initHistoryState(); // we redundantly call initHistoryState() to ensure it's called early
-const globalObject = getGlobalObject('runtime-client-routing/history.ts', { previous: getHistoryInfo() });
+import { assert, assertUsage, getGlobalObject, isObject, deepEqual } 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();
 // `window.history.state === null` when:
 // - The very first render
 // - Click on `<a href="#some-hash" />`
@@ -41,7 +44,7 @@ function enhance(stateNotEnhanced) {
             _isVikeEnhanced: true,
         };
     }
-    assert(isVikeEnhanced(stateVikeEnhanced));
+    assertIsVikeEnhanced(stateVikeEnhanced);
     return stateVikeEnhanced;
 }
 function getState() {
@@ -51,7 +54,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()
-    assert(isVikeEnhanced(state), { state });
+    assertIsVikeEnhanced(state);
     return state;
 }
 function getStateNotEnhanced() {
@@ -90,6 +93,7 @@ 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.
@@ -100,7 +104,9 @@ function replaceHistoryStateOriginal(state, url) {
 // - history.pushState()
 // - history.replaceState()
 function monkeyPatchHistoryAPI() {
-    ;
+    if (globalObject.monkeyPatched)
+        return;
+    globalObject.monkeyPatched = true;
     ['pushState', 'replaceState'].forEach((funcName) => {
         const funcOriginal = window.history[funcName].bind(window.history);
         window.history[funcName] = (stateOriginal = {}, ...rest) => {
@@ -114,11 +120,21 @@ function monkeyPatchHistoryAPI() {
                     triggeredBy: 'user',
                     ...stateOriginal,
                 };
-            assert(isVikeEnhanced(stateEnhanced));
-            const ret = funcOriginal(stateEnhanced, ...rest);
+            assertIsVikeEnhanced(stateEnhanced);
+            funcOriginal(stateEnhanced, ...rest);
+            assertIsVikeEnhanced(getState());
             globalObject.previous = getHistoryInfo();
-            return ret;
+            // Workaround https://github.com/vikejs/vike/issues/2504#issuecomment-3149764736
+            assert(deepEqual(window.history.state, stateEnhanced));
+            queueMicrotask(() => {
+                if (deepEqual(window.history.state, stateEnhanced))
+                    return;
+                Object.assign(stateEnhanced, window.history.state);
+                replaceHistoryStateOriginal(stateEnhanced, rest[1]);
+                assert(deepEqual(window.history.state, stateEnhanced));
+            });
         };
+        window.history[funcName]._isVikeMonkeyPatch = true;
     });
 }
 function isVikeEnhanced(state) {
@@ -136,6 +152,16 @@ 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(),
@@ -147,11 +173,12 @@ function onPopStateBegin() {
     const isHistoryStateEnhanced = window.history.state !== null;
     if (!isHistoryStateEnhanced)
         enhanceHistoryState();
-    assert(isVikeEnhanced(window.history.state));
+    assertIsVikeEnhanced(window.history.state);
     const current = getHistoryInfo();
     globalObject.previous = current;
     return { isHistoryStateEnhanced, previous, current };
 }
-function initHistoryState() {
-    enhanceHistoryState();
+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`
 }

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 { initHistoryState, monkeyPatchHistoryAPI } from './history.js';
+import { initHistory } from './history.js';
 async function initClientRouter() {
     // Init navigation history and scroll restoration
     initHistoryAndScroll();
@@ -29,8 +29,7 @@ async function renderFirstPage() {
 }
 function initHistoryAndScroll() {
     scrollRestoration_init();
-    monkeyPatchHistoryAPI();
-    initHistoryState(); // we redundantly call initHistoryState() to ensure it's called early
+    initHistory(); // we redundantly call initHistory() to ensure it's called early
     autoSaveScrollPosition();
     // Handle back-/forward navigation
     initOnPopState();

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

@@ -111,8 +111,8 @@ async function renderPageClientSide(renderArgs) {
             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);
+                const { pageId, routeParams, ...rest } = pageContextFromRoute;
+                objectAssign(pageContext, rest);
                 assert(hasProp(pageContext, 'routeParams', 'string{}')); // Help TS
             }
             else {

package/dist/esm/client/runtime-client-routing/utils.d.ts

@@ -22,3 +22,4 @@ export * from '../../utils/PROJECT_VERSION.js';
 export * from '../../utils/genPromise.js';
 export * from '../../utils/catchInfiniteLoop.js';
 export * from '../../utils/changeEnumerable.js';
+export * from '../../utils/deepEqual.js';

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

@@ -26,3 +26,4 @@ export * from '../../utils/PROJECT_VERSION.js';
 export * from '../../utils/genPromise.js';
 export * from '../../utils/catchInfiniteLoop.js';
 export * from '../../utils/changeEnumerable.js';
+export * from '../../utils/deepEqual.js';

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

@@ -27,7 +27,7 @@ import type { GlobalContext } from '../../types/PageContext.js';
 import type { Hook } from '../../shared/hooks/getHook.js';
 declare const vikeConfigErrorRecoverMsg: "Vike config loaded";
 type GlobalContextServer = Pick<GlobalContextServerInternal, 'assetsManifest' | 'config' | 'viteConfig' | 'viteConfigRuntime' | 'pages' | 'baseServer' | 'baseAssets' | 'isClientSide'> & Vike.GlobalContext & Vike.GlobalContextServer;
-type GlobalContextServerInternal = Awaited<ReturnType<typeof setGlobalContext>>;
+type GlobalContextServerInternal = Awaited<ReturnType<typeof createGlobalContext>>;
 declare function getGlobalContextServerInternal(): Promise<{
     globalContext: (Record<string, unknown> & {
         isGlobalContext: true;
@@ -190,7 +190,7 @@ declare function assertBuildInfo(buildInfo: unknown): asserts buildInfo is Build
 declare function updateUserFiles(): Promise<{
     success: boolean;
 }>;
-declare function setGlobalContext(virtualFileExports: unknown): Promise<{
+declare function createGlobalContext(virtualFileExports: unknown): Promise<{
     isGlobalContext: true;
     _isOriginalObject: true;
     _virtualFileExports: unknown;

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

@@ -274,7 +274,7 @@ async function loadBuildEntry(outDir) {
     assertBuildEntry(buildEntry);
     globalObject.assetsManifest = buildEntry.assetsManifest;
     globalObject.buildInfo = buildEntry.buildInfo;
-    await setGlobalContext(buildEntry.virtualFileExports);
+    await createGlobalContext(buildEntry.virtualFileExports);
 }
 // This is the production entry, see:
 // https://github.com/vikejs/vike/blob/798e5465dc3e3e6723b38b601a50350c0a006fb8/packages/vike/node/vite/plugins/pluginBuild/pluginBuildEntry.ts#L47
@@ -319,6 +319,7 @@ function assertVersionAtBuildTime(versionAtBuildTime) {
     assertUsage(versionAtBuildTime === versionAtRuntime, `Re-build your app (you're using ${pretty(versionAtRuntime)} but your app was built with ${pretty(versionAtBuildTime)})`);
 }
 async function updateUserFiles() {
+    debug('updateUserFiles()');
     assert(!globalObject.isProduction);
     const { promise, resolve } = genPromise();
     globalObject.waitForUserFilesUpdate = promise;
@@ -401,7 +402,7 @@ async function updateUserFiles() {
         return { success: false };
     }
     try {
-        await setGlobalContext(virtualFileExports);
+        await createGlobalContext(virtualFileExports);
     }
     catch (err_) {
         hasError = true;
@@ -413,8 +414,8 @@ async function updateUserFiles() {
         return onError(err);
     return onSuccess();
 }
-async function setGlobalContext(virtualFileExports) {
-    debug('setGlobalContext()');
+async function createGlobalContext(virtualFileExports) {
+    debug('createGlobalContext()');
     assert(!getVikeConfigErrorBuild());
     const globalContext = await createGlobalContextShared(virtualFileExports, globalObject, addGlobalContext, addGlobalContextTmp, addGlobalContextAsync);
     assertV1Design(
@@ -422,8 +423,8 @@ async function setGlobalContext(virtualFileExports) {
     globalContext._pageConfigs.length > 0, globalContext._pageFilesAll);
     assertGlobalContextIsDefined();
     onSetupRuntime();
-    debug('setGlobalContext() - done');
-    // Never actually used, only used for TypeScript `ReturnType<typeof setGlobalContext>`
+    debug('createGlobalContext() - done');
+    // Never actually used, only used for TypeScript `ReturnType<typeof createGlobalContext>`
     return globalContext;
 }
 async function addGlobalContextTmp(globalContext) {

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

@@ -1 +1 @@
-export declare const PROJECT_VERSION: "0.4.236-commit-79f1ef0";
+export declare const PROJECT_VERSION: "0.4.236-commit-cd565e9";

package/dist/esm/utils/PROJECT_VERSION.js

@@ -1,2 +1,2 @@
 // Automatically updated by @brillout/release-me
-export const PROJECT_VERSION = '0.4.236-commit-79f1ef0';
+export const PROJECT_VERSION = '0.4.236-commit-cd565e9';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vike",
-  "version": "0.4.236-commit-79f1ef0",
+  "version": "0.4.236-commit-cd565e9",
   "repository": "https://github.com/vikejs/vike",
   "exports": {
     "./server": {