vike 0.4.247-commit-dbcfa58 → 0.4.247-commit-e331796

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

@@ -5,14 +5,12 @@ export { saveScrollPosition };
 export { initHistory };
 export type { HistoryInfo };
 export type { ScrollPosition };
-type VikeHistoryData = {
-    timestamp: number;
-    scrollPosition: null | ScrollPosition;
-    triggeredBy: 'user' | 'vike' | 'browser';
-};
 type StateEnhanced = {
-    _isVikeEnhanced: VikeHistoryData;
-    [key: string]: unknown;
+    vike: {
+        timestamp: number;
+        scrollPosition: null | ScrollPosition;
+        triggeredBy: 'user' | 'vike' | 'browser';
+    };
 };
 type ScrollPosition = {
     x: number;

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

@@ -15,53 +15,17 @@ globalObject.previous = getHistoryInfo();
 // - The very first render
 // - Click on `<a href="#some-hash" />`
 // - `location.hash = 'some-hash'`
-function enhanceHistoryState() {
-    if (isVikeEnhanced(window.history.state))
+function enhance() {
+    if (isEnhanced(window.history.state))
         return;
-    const stateVikeEnhanced = enhance(window.history.state);
-    replaceHistoryState(stateVikeEnhanced);
-}
-function enhance(stateNotEnhanced) {
-    const timestamp = getTimestamp();
-    const scrollPosition = getScrollPosition();
-    const triggeredBy = 'browser';
-    let stateVikeEnhanced;
-    if (!stateNotEnhanced) {
-        stateVikeEnhanced = {
-            _isVikeEnhanced: {
-                timestamp,
-                scrollPosition,
-                triggeredBy,
-            },
-        };
-    }
-    else {
-        // State information may be incomplete if `window.history.state` is set by an old Vike version. (E.g. `state.timestamp` was introduced for `pageContext.isBackwardNavigation` in `0.4.19`.)
-        let oldVikeData;
-        if (isObject(stateNotEnhanced) && '_isVikeEnhanced' in stateNotEnhanced) {
-            if (isObject(stateNotEnhanced._isVikeEnhanced)) {
-                // New format: _isVikeEnhanced is an object with nested properties
-                oldVikeData = stateNotEnhanced._isVikeEnhanced;
-            }
-            else {
-                // Old format: _isVikeEnhanced is true, properties are on state root
-                oldVikeData = stateNotEnhanced;
-            }
-        }
-        else {
-            oldVikeData = {};
-        }
-        stateVikeEnhanced = {
-            ...stateNotEnhanced,
-            _isVikeEnhanced: {
-                timestamp: oldVikeData.timestamp ?? timestamp,
-                scrollPosition: oldVikeData.scrollPosition ?? scrollPosition,
-                triggeredBy: oldVikeData.triggeredBy ?? triggeredBy,
-            },
-        };
-    }
-    assertIsVikeEnhanced(stateVikeEnhanced);
-    return stateVikeEnhanced;
+    const stateEnhanced = {
+        vike: {
+            timestamp: getTimestamp(),
+            scrollPosition: getScrollPosition(),
+            triggeredBy: 'browser',
+        },
+    };
+    replaceHistoryState(stateEnhanced);
 }
 function getState() {
     const state = window.history.state;
@@ -70,7 +34,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);
+    assertIsEnhanced(state);
     return state;
 }
 function getScrollPosition() {
@@ -84,15 +48,15 @@ function saveScrollPosition() {
     const scrollPosition = getScrollPosition();
     // Don't overwrite history.state if it was set by a non-Vike history.pushState() call.
     // https://github.com/vikejs/vike/issues/2801#issuecomment-3490431479
-    if (!isVikeEnhanced(window.history.state))
+    if (!isEnhanced(window.history.state))
         return;
     const state = getState();
-    replaceHistoryState({ ...state, _isVikeEnhanced: { ...state._isVikeEnhanced, scrollPosition } });
+    replaceHistoryState({ ...state, vike: { ...state.vike, scrollPosition } });
 }
 function pushHistoryState(url, overwriteLastHistoryEntry) {
     if (!overwriteLastHistoryEntry) {
         const state = {
-            _isVikeEnhanced: {
+            vike: {
                 timestamp: getTimestamp(),
                 // I don't remember why I set it to `null`, maybe because setting it now would be too early? (Maybe there is a delay between renderPageClient() is finished and the browser updating the scroll position.) Anyways, it seems like autoSaveScrollPosition() is enough.
                 scrollPosition: null,
@@ -110,7 +74,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(window.history.state);
+    assertIsEnhanced(window.history.state);
 }
 function replaceHistoryStateOriginal(state, url) {
     // Bypass all monkey patches.
@@ -126,42 +90,42 @@ function monkeyPatchHistoryAPI() {
     globalObject.monkeyPatched = true;
     ['pushState', 'replaceState'].forEach((funcName) => {
         const funcOriginal = window.history[funcName].bind(window.history);
-        window.history[funcName] = (stateOriginal = {}, ...rest) => {
-            assertUsage(stateOriginal === undefined || stateOriginal === null || isObject(stateOriginal), `history.${funcName}(state) argument state must be an object`);
-            const stateEnhanced = isVikeEnhanced(stateOriginal)
-                ? stateOriginal
+        window.history[funcName] = (stateFromUser = {}, ...rest) => {
+            assertUsage(stateFromUser === undefined || stateFromUser === null || isObject(stateFromUser), `history.${funcName}(state) argument state must be an object`);
+            const state = isEnhanced(stateFromUser)
+                ? stateFromUser
                 : {
-                    ...stateOriginal,
-                    _isVikeEnhanced: {
+                    ...stateFromUser,
+                    vike: {
                         scrollPosition: getScrollPosition(),
                         timestamp: getTimestamp(),
                         triggeredBy: 'user',
-                        ...stateOriginal?._isVikeEnhanced,
                     },
                 };
-            assertIsVikeEnhanced(stateEnhanced);
-            funcOriginal(stateEnhanced, ...rest);
-            assert(isEqual(stateEnhanced, window.history.state));
+            assertIsEnhanced(state);
+            funcOriginal(state, ...rest);
+            // TO-DO/eventually remove excessive assertions to save client-side KBs
+            assert(isEqual(state, window.history.state));
             globalObject.previous = getHistoryInfo();
             // Workaround https://github.com/vikejs/vike/issues/2504#issuecomment-3149764736
             queueMicrotask(() => {
-                if (isEqual(stateEnhanced, window.history.state))
+                if (isEqual(state, window.history.state))
                     return;
-                Object.assign(stateEnhanced, window.history.state);
-                assertIsVikeEnhanced(stateEnhanced);
-                replaceHistoryStateOriginal(stateEnhanced, rest[1]);
-                assert(isEqual(stateEnhanced, window.history.state));
+                Object.assign(state, window.history.state);
+                assertIsEnhanced(state);
+                replaceHistoryStateOriginal(state, rest[1]);
+                assert(isEqual(state, window.history.state));
             });
         };
     });
 }
 function isEqual(state1, state2) {
-    return deepEqual(state1?._isVikeEnhanced, state2?._isVikeEnhanced);
+    return deepEqual(state1?.vike, state2?.vike);
 }
-function isVikeEnhanced(state) {
-    if (state?._isVikeEnhanced) {
+function isEnhanced(state) {
+    if (state?.vike) {
         /* We don't use the assert() below to save client-side KBs.
-        const vikeData = state._isVikeEnhanced
+        const vikeData = state.vike
         assert(isObject(vikeData))
         assert(hasProp(vikeData, 'timestamp', 'number'))
         assert(hasProp(vikeData, 'scrollPosition'))
@@ -174,8 +138,8 @@ function isVikeEnhanced(state) {
     }
     return false;
 }
-function assertIsVikeEnhanced(state) {
-    if (isVikeEnhanced(state))
+function assertIsEnhanced(state) {
+    if (isEnhanced(state))
         return;
     assert(false, { state });
 }
@@ -187,33 +151,32 @@ function getHistoryInfo() {
 }
 function onPopStateBegin() {
     const { previous } = globalObject;
-    const isHistoryStateEnhanced = isVikeEnhanced(window.history.state);
+    const isStateEnhanced = isEnhanced(window.history.state);
     // Either:
     // - `window.history.pushState(null, '', '/some-path')` , or
     // - hash navigation
     //   - Click on `<a href="#some-hash">`
     //   - Using the `location` API (only hash navigation)
     // See comments a the top of the ./initOnPopState.ts file.
-    const isHistoryStatePristine = window.history.state === null;
-    if (!isHistoryStateEnhanced && !isHistoryStatePristine) {
+    const isStatePristine = window.history.state === null;
+    if (!isStateEnhanced && !isStatePristine) {
         // Going to a history entry not created by Vike — entering another "SPA realm" => hard reload
         // https://github.com/vikejs/vike/issues/2801#issuecomment-3490431479
         redirectHard(getCurrentUrl());
         return { skip: true };
     }
-    if (!isHistoryStateEnhanced)
-        enhanceHistoryState();
-    assertIsVikeEnhanced(window.history.state);
+    if (!isStateEnhanced)
+        enhance();
     const current = getHistoryInfo();
     globalObject.previous = current;
     // Let the browser handle hash navigations.
     // - Upon hash navigation: `isHistoryStatePristine===true` (see comment above).
-    if (isHistoryStatePristine) {
+    if (isStatePristine) {
         return { skip: true };
     }
     return { 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`
+    enhance(); // enhance very first window.history.state which is `null`
 }

package/dist/client/runtime-client-routing/initOnPopState.js

@@ -37,18 +37,18 @@ async function onPopState() {
     await handleHistoryNavigation(previous, current);
 }
 async function handleHistoryNavigation(previous, current) {
-    const scrollTarget = current.state._isVikeEnhanced.scrollPosition || undefined;
+    const scrollTarget = current.state.vike.scrollPosition || undefined;
     const isHashNavigation = removeHash(current.url) === removeHash(previous.url) && current.url !== previous.url;
     if (isHashNavigation) {
         // We have to scroll ourselves because we have set `window.history.scrollRestoration = 'manual'`
         setScrollPosition(scrollTarget);
         return;
     }
-    const isUserPushStateNavigation = current.state._isVikeEnhanced.triggeredBy === 'user' || previous.state._isVikeEnhanced.triggeredBy === 'user';
+    const isUserPushStateNavigation = current.state.vike.triggeredBy === 'user' || previous.state.vike.triggeredBy === 'user';
     const doNotRenderIfSamePage = isUserPushStateNavigation;
-    const isBackwardNavigation = !current.state._isVikeEnhanced.timestamp || !previous.state._isVikeEnhanced.timestamp
+    const isBackwardNavigation = !current.state.vike.timestamp || !previous.state.vike.timestamp
         ? null
-        : current.state._isVikeEnhanced.timestamp < previous.state._isVikeEnhanced.timestamp;
+        : current.state.vike.timestamp < previous.state.vike.timestamp;
     await renderPageClient({ scrollTarget, isBackwardNavigation, doNotRenderIfSamePage, isHistoryNavigation: true });
 }
 function removeHash(url) {

package/dist/server/runtime/renderPageServer.js

@@ -220,6 +220,10 @@ function logHttpRequest(urlOriginal, pageContextInit, requestId) {
     logRuntimeInfo?.(getRequestInfoMessage(urlOriginal), pageContext_logRuntime, 'info');
 }
 /*
+const arrowRight = pc.dim('→')
+const arrowLeft = pc.dim('←')
+*/
+/*
 const arrowRight = pc.dim('>>')
 const arrowLeft = pc.dim('<<')
 /*/

package/dist/utils/PROJECT_VERSION.d.ts

@@ -1 +1 @@
-export declare const PROJECT_VERSION: "0.4.247-commit-dbcfa58";
+export declare const PROJECT_VERSION: "0.4.247-commit-e331796";

package/dist/utils/PROJECT_VERSION.js

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

package/package.json

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