vike 0.4.144-commit-6aef8a6 → 0.4.144-commit-7f5e99a

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

@@ -14,20 +14,18 @@ import { preparePageContextForUserConsumptionClientSide } from '../shared/prepar
 import { loadPageFilesClientSide } from '../shared/loadPageFilesClientSide.js';
 import { removeBuiltInOverrides } from './getPageContext/removeBuiltInOverrides.js';
 import { getPageContextRequestUrl } from '../../shared/getPageContextRequestUrl.js';
-import { getConfigValue, getPageConfig } from '../../shared/page-configs/utils.js';
+import { getConfigValue, getPageConfig } from '../../shared/page-configs/helpers.js';
 import { assertOnBeforeRenderHookReturn } from '../../shared/assertOnBeforeRenderHookReturn.js';
 import { executeGuardHook } from '../../shared/route/executeGuardHook.js';
 import { AbortRender, isAbortPageContext } from '../../shared/route/abort.js';
 const globalObject = getGlobalObject('router/getPageContext.ts', {});
 async function getPageContext(pageContext) {
     if (pageContext._isFirstRenderAttempt && navigationState.isFirstUrl(pageContext.urlOriginal)) {
-        assert(hasProp(pageContext, '_isFirstRenderAttempt', 'true'));
         const pageContextAddendum = await getPageContextFirstRender(pageContext);
         setPageContextInitHasClientData(pageContextAddendum);
         return pageContextAddendum;
     }
     else {
-        assert(hasProp(pageContext, '_isFirstRenderAttempt', 'false'));
         const pageContextAddendum = await getPageContextUponNavigation(pageContext);
         setPageContextInitHasClientData(pageContextAddendum);
         return pageContextAddendum;
@@ -185,8 +183,8 @@ async function onBeforeRenderClientOnlyExists(pageContext) {
     }
 }
 async function getPageContextFromRoute(pageContext) {
-    const routeResult = await route(pageContext);
-    const pageContextFromRoute = routeResult.pageContextAddendum;
+    const pageContextFromRoute = await route(pageContext);
+    // We'll be able to remove this once async route functions are deprecated (because we'll be able to skip link hijacking if a link doesn't match a route (because whether to call event.preventDefault() needs to be determined synchronously))
     if (!pageContextFromRoute._pageId) {
         const err = new Error('No routing match');
         markIs404(err);
@@ -202,8 +200,7 @@ function checkIf404(err) {
     return isObject(err) && err._is404 === true;
 }
 async function fetchPageContextFromServer(pageContext) {
-    const urlLogical = pageContext._urlRewrite ?? pageContext._urlOriginalPristine ?? pageContext.urlOriginal;
-    const pageContextUrl = getPageContextRequestUrl(urlLogical);
+    const pageContextUrl = getPageContextRequestUrl(pageContext._urlRewrite ?? pageContext.urlOriginal);
     const response = await fetch(pageContextUrl);
     {
         const contentType = response.headers.get('content-type');

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

@@ -1,5 +1,5 @@
 export { getPageId };
-declare function getPageId(url: string): Promise<{
+declare function getPageId(urlOriginal: string): Promise<{
     pageId: null;
     pageFilesAll: import("../../shared/getPageFiles/getPageFileObject.js").PageFile[];
     pageConfigs: import("../../shared/page-configs/PageConfig.js").PageConfigRuntime[];

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

@@ -1,15 +1,12 @@
 export { getPageId };
 import { route } from '../../shared/route/index.js';
 import { createPageContext } from './createPageContext.js';
-async function getPageId(url) {
-    const pageContext = await createPageContext({ urlOriginal: url });
-    const routeContext = await route(pageContext);
+async function getPageId(urlOriginal) {
+    const pageContext = await createPageContext(urlOriginal);
     const pageFilesAll = pageContext._pageFilesAll;
     const pageConfigs = pageContext._pageConfigs;
-    if (!('pageContextAddendum' in routeContext)) {
-        return { pageId: null, pageFilesAll, pageConfigs };
-    }
-    const pageId = routeContext.pageContextAddendum._pageId;
+    const pageContextFromRoute = await route(pageContext);
+    const pageId = pageContextFromRoute._pageId;
     if (!pageId) {
         return { pageId: null, pageFilesAll, pageConfigs };
     }

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

@@ -1,7 +1,8 @@
-export { initHistoryState, getHistoryState, pushHistory, ScrollPosition, saveScrollPosition };
+export { initHistoryState, getHistoryState, pushHistory, ScrollPosition, saveScrollPosition, monkeyPatchHistoryPushState };
 type HistoryState = {
     timestamp?: number;
     scrollPosition?: null | ScrollPosition;
+    triggedBy?: 'user' | 'vike' | 'browser';
 };
 type ScrollPosition = {
     x: number;
@@ -11,3 +12,4 @@ declare function initHistoryState(): void;
 declare function getHistoryState(): HistoryState;
 declare function saveScrollPosition(): void;
 declare function pushHistory(url: string, overwriteLastHistoryEntry: boolean): void;
+declare function monkeyPatchHistoryPushState(): void;

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

@@ -1,10 +1,11 @@
-export { initHistoryState, getHistoryState, pushHistory, saveScrollPosition };
-import { assert, hasProp, isObject } from './utils.js';
-// Fill missing state information.
-//  - The very first render => `history.state` is uninitialized (`null`).
-//  - The vike app runs `location.hash = '#section'` => `history.state` is uninitialized (`null`).
-//  - The user clicks on an anchor link `<a href="#section">Section</a>` => `history.state` is uninitialized (`null`).
-//  - `history.state` set by an old vike version => state information may be incomplete. (E.g. `state.timestamp` was introduced for `pageContext.isBackwardNavigation` in `0.4.19`.)
+export { initHistoryState, getHistoryState, pushHistory, saveScrollPosition, monkeyPatchHistoryPushState };
+import { assert, assertUsage, hasProp, isObject } from './utils.js';
+// Fill missing state information:
+//  - `history.state` can uninitialized (i.e. `null`):
+//    - The very first render
+//    - The user's code runs `location.hash = '#section'`
+//    - The user clicks on an anchor link `<a href="#section">Section</a>` (Vike's `onLinkClick()` handler skips hash links).
+//  - State information may be incomplete if `history.state` is set by an old Vike version. (E.g. `state.timestamp` was introduced for `pageContext.isBackwardNavigation` in `0.4.19`.)
 function initHistoryState() {
     let state = window.history.state;
     if (!state) {
@@ -19,6 +20,9 @@ function initHistoryState() {
         hasModifications = true;
         state.scrollPosition = getScrollPosition();
     }
+    if (!('triggedBy' in state)) {
+        state.triggedBy = 'browser';
+    }
     assertState(state);
     if (hasModifications) {
         replaceHistoryState(state);
@@ -44,7 +48,7 @@ function saveScrollPosition() {
 function pushHistory(url, overwriteLastHistoryEntry) {
     if (!overwriteLastHistoryEntry) {
         const timestamp = getTimestamp();
-        pushHistoryState({ timestamp, scrollPosition: null }, url);
+        pushHistoryState({ timestamp, scrollPosition: null, triggedBy: 'vike' }, url);
     }
     else {
         replaceHistoryState(getHistoryState(), url);
@@ -69,3 +73,17 @@ function replaceHistoryState(state, url) {
 function pushHistoryState(state, url) {
     window.history.pushState(state, '', url);
 }
+function monkeyPatchHistoryPushState() {
+    const pushStateOriginal = history.pushState;
+    history.pushState = (stateFromUser = {}, ...rest) => {
+        assertUsage(null === stateFromUser || undefined === stateFromUser || isObject(stateFromUser), 'history.pushState(state) argument state must be an object');
+        const state = {
+            scrollPosition: getScrollPosition(),
+            timestamp: getTimestamp(),
+            ...stateFromUser,
+            // Don't allow user to overwrite triggedBy as it would break Vike's handling of the 'popstate' event
+            triggedBy: 'user'
+        };
+        return pushStateOriginal.apply(history, [state, ...rest]);
+    };
+}

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

@@ -0,0 +1,21 @@
+export { installClientRouter };
+export { disableClientRouting };
+export { isDisableAutomaticLinkInterception };
+export { renderPageClientSide };
+import { ScrollPosition } from './history.js';
+import { PageContextFromRewrite } from '../../shared/route/abort.js';
+declare function installClientRouter(): void;
+type RenderArgs = {
+    scrollTarget: ScrollTarget;
+    isBackwardNavigation: boolean | null;
+    urlOriginal?: string;
+    overwriteLastHistoryEntry?: boolean;
+    checkIfClientSideRenderable?: boolean;
+    pageContextsFromRewrite?: PageContextFromRewrite[];
+    redirectCount?: number;
+    isUserLandNavigation?: boolean;
+};
+declare function renderPageClientSide(renderArgs: RenderArgs): Promise<void>;
+type ScrollTarget = ScrollPosition | 'scroll-to-top-or-hash' | 'preserve-scroll';
+declare function isDisableAutomaticLinkInterception(): boolean;
+declare function disableClientRouting(err: unknown, log: boolean): void;