vike 0.4.144-commit-f7ab002 → 0.4.144-commit-de18325

package/dist/cjs/shared/route/index.js

@@ -18,35 +18,25 @@ const resolveRouteFunction_js_1 = require("./resolveRouteFunction.js");
 const executeOnBeforeRouteHook_js_1 = require("./executeOnBeforeRouteHook.js");
 const debug_js_1 = require("./debug.js");
 const picocolors_1 = __importDefault(require("@brillout/picocolors"));
-async function route(pageContext) {
-    (0, addUrlComputedProps_js_1.addUrlComputedProps)(pageContext);
-    (0, debug_js_1.debug)('Pages routes:', pageContext._pageRoutes);
-    const pageContextAddendum = {};
-    if (pageContext._onBeforeRouteHook) {
-        const pageContextAddendumHook = await (0, executeOnBeforeRouteHook_js_1.executeOnBeforeRouteHook)(pageContext._onBeforeRouteHook, pageContext);
-        if (pageContextAddendumHook) {
-            (0, utils_js_1.objectAssign)(pageContextAddendum, pageContextAddendumHook);
-            if ((0, utils_js_1.hasProp)(pageContextAddendum, '_pageId', 'string') || (0, utils_js_1.hasProp)(pageContextAddendum, '_pageId', 'null')) {
-                // We bypass Vike's routing
-                if (!(0, utils_js_1.hasProp)(pageContextAddendum, 'routeParams')) {
-                    (0, utils_js_1.objectAssign)(pageContextAddendum, { routeParams: {} });
-                }
-                else {
-                    (0, utils_js_1.assert)((0, utils_js_1.hasProp)(pageContextAddendum, 'routeParams', 'object'));
-                }
-                (0, utils_js_1.objectAssign)(pageContextAddendum, {
-                    _routingProvidedByOnBeforeRouteHook: true,
-                    _routeMatches: 'CUSTOM_ROUTE'
-                });
-                return { pageContextAddendum };
-            }
-            // We already assign so that `pageContext.urlOriginal === pageContextAddendum.urlOriginal`; enabling the `onBeforeRoute()` hook to mutate `pageContext.urlOriginal` before routing.
-            (0, utils_js_1.objectAssign)(pageContext, pageContextAddendum);
+async function route(pageContextForRoute) {
+    (0, debug_js_1.debug)('Pages routes:', pageContextForRoute._pageRoutes);
+    (0, addUrlComputedProps_js_1.addUrlComputedProps)(pageContextForRoute);
+    const pageContextFromRoute = {};
+    // onBeforeRoute()
+    const pageContextFromOnBeforeRouteHook = await (0, executeOnBeforeRouteHook_js_1.executeOnBeforeRouteHook)(pageContextForRoute);
+    if (pageContextFromOnBeforeRouteHook) {
+        if (pageContextFromOnBeforeRouteHook._routingProvidedByOnBeforeRouteHook) {
+            (0, utils_js_1.assert)(pageContextFromOnBeforeRouteHook._pageId);
+            return pageContextFromOnBeforeRouteHook;
+        }
+        else {
+            (0, utils_js_1.objectAssign)(pageContextFromRoute, pageContextFromOnBeforeRouteHook);
         }
     }
-    (0, utils_js_1.objectAssign)(pageContextAddendum, {
-        _routingProvidedByOnBeforeRouteHook: false
-    });
+    // We take into account pageContext.urlLogical set by onBeforeRoute()
+    const pageContext = {};
+    (0, utils_js_1.objectAssign)(pageContext, pageContextForRoute);
+    (0, utils_js_1.objectAssign)(pageContext, pageContextFromOnBeforeRouteHook);
     // Vike's routing
     const allPageIds = pageContext._allPageIds;
     (0, utils_js_1.assert)(allPageIds.length >= 0);
@@ -98,22 +88,22 @@ async function route(pageContext) {
     (0, resolvePrecedence_js_1.resolvePrecendence)(routeMatches);
     const winner = routeMatches[0];
     (0, debug_js_1.debug)(`Route matches for URL ${picocolors_1.default.cyan(urlPathname)} (in precedence order):`, routeMatches);
-    (0, utils_js_1.objectAssign)(pageContextAddendum, { _routeMatches: routeMatches });
+    (0, utils_js_1.objectAssign)(pageContextFromRoute, { _debugRouteMatches: routeMatches });
     if (!winner) {
-        (0, utils_js_1.objectAssign)(pageContextAddendum, {
+        (0, utils_js_1.objectAssign)(pageContextFromRoute, {
             _pageId: null,
             routeParams: {}
         });
-        return { pageContextAddendum };
+        return pageContextFromRoute;
     }
     {
         const { routeParams } = winner;
         (0, utils_js_1.assert)((0, utils_js_1.isPlainObject)(routeParams));
-        (0, utils_js_1.objectAssign)(pageContextAddendum, {
+        (0, utils_js_1.objectAssign)(pageContextFromRoute, {
             _pageId: winner.pageId,
             routeParams: winner.routeParams
         });
     }
-    return { pageContextAddendum };
+    return pageContextFromRoute;
 }
 exports.route = route;

package/dist/cjs/shared/route/resolveRouteFunction.js

@@ -11,7 +11,7 @@ async function resolveRouteFunction(routeFunction, pageContext, routeDefinedAt)
     (0, addUrlComputedProps_js_1.assertPageContextUrlComputedProps)(pageContext);
     let result = routeFunction(pageContext);
     assertSyncRouting(result, `The Route Function ${routeDefinedAt}`);
-    // TODO/v1-release
+    // TODO/v1-release: make resolveRouteFunction() and route() sync
     //* We disallow asynchronous routing, because we need to check whether a link is a Vike link in a synchronous fashion before calling ev.preventDefault() in the 'click' event listener
     result = await result;
     //*/

package/dist/cjs/shared/utils.js

@@ -35,7 +35,7 @@ __exportStar(require("../utils/stringifyStringArray.js"), exports);
 __exportStar(require("../utils/filesystemPathHandling.js"), exports);
 __exportStar(require("../utils/cast.js"), exports);
 __exportStar(require("../utils/projectInfo.js"), exports);
-__exportStar(require("../utils/hasPropertyGetter.js"), exports);
+__exportStar(require("../utils/isPropertyGetter.js"), exports);
 __exportStar(require("../utils/isPromise.js"), exports);
 __exportStar(require("../utils/checkType.js"), exports);
 __exportStar(require("../utils/objectEntries.js"), exports);

package/dist/cjs/utils/{hasPropertyGetter.js → isPropertyGetter.js}

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.hasPropertyGetter = void 0;
-function hasPropertyGetter(obj, prop) {
+exports.isPropertyGetter = void 0;
+function isPropertyGetter(obj, prop) {
     const descriptor = Object.getOwnPropertyDescriptor(obj, prop);
     return !!descriptor && !('value' in descriptor) && !!descriptor.get;
 }
-exports.hasPropertyGetter = hasPropertyGetter;
+exports.isPropertyGetter = isPropertyGetter;

package/dist/cjs/utils/projectInfo.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.projectInfo = void 0;
 const assertSingleInstance_js_1 = require("./assertSingleInstance.js");
-const PROJECT_VERSION = '0.4.144-commit-f7ab002';
+const PROJECT_VERSION = '0.4.144-commit-de18325';
 const projectInfo = {
     projectName: 'Vike',
     projectVersion: PROJECT_VERSION,

package/dist/esm/__internal/index.d.ts

@@ -1,8 +1,8 @@
-import { route, type PageRoutes } from '../shared/route/index.js';
-import { type PageFile } from '../shared/getPageFiles.js';
-import { PageConfigRuntime } from '../shared/page-configs/PageConfig.js';
 export { route, getPagesAndRoutes };
 export type { PageRoutes, PageFile, PageConfigRuntime as PageConfig };
+import { route as routeInternal, type PageRoutes } from '../shared/route/index.js';
+import { type PageFile } from '../shared/getPageFiles.js';
+import { PageConfigRuntime } from '../shared/page-configs/PageConfig.js';
 /**
  * Used by {@link https://github.com/magne4000/vite-plugin-vercel|vite-plugin-vercel}
  * to compute some rewrite rules and extract { isr } configs.
@@ -15,3 +15,6 @@ declare function getPagesAndRoutes(): Promise<{
     pageConfigs: PageConfigRuntime[];
     allPageIds: string[];
 }>;
+declare function route(pageContext: Parameters<typeof routeInternal>[0]): Promise<{
+    pageContextAddendum: import("../shared/route/index.js").PageContextFromRoute;
+}>;

package/dist/esm/__internal/index.js

@@ -1,10 +1,10 @@
-// Internal functions of vike needed by other plugins are exported via this file
-import { route } from '../shared/route/index.js';
+// Internals needed by vite-plugin-vercel
+export { route, getPagesAndRoutes };
+import { route as routeInternal } from '../shared/route/index.js';
 import { getGlobalContext, initGlobalContext } from '../node/runtime/globalContext.js';
 import { setNodeEnvToProduction } from '../utils/nodeEnv.js';
 import { assert } from '../utils/assert.js';
 import { getRenderContext } from '../node/runtime/renderPage/renderPageAlreadyRouted.js';
-export { route, getPagesAndRoutes };
 /**
  * Used by {@link https://github.com/magne4000/vite-plugin-vercel|vite-plugin-vercel}
  * to compute some rewrite rules and extract { isr } configs.
@@ -25,3 +25,8 @@ async function getPagesAndRoutes() {
         allPageIds
     };
 }
+async function route(pageContext) {
+    const pageContextFromRoute = await routeInternal(pageContext);
+    // Old interface
+    return { pageContextAddendum: pageContextFromRoute };
+}

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

@@ -1,7 +1,6 @@
 export { createPageContext };
-declare function createPageContext<T extends {
+declare function createPageContext(urlOriginal: string): Promise<{
     urlOriginal: string;
-}>(pageContextBase?: T): Promise<{
     _objectCreatedByVike: boolean;
     _urlHandler: null;
     _urlRewrite: null;
@@ -13,6 +12,6 @@ declare function createPageContext<T extends {
     _allPageIds: string[];
     _pageRoutes: import("../../shared/route/loadPageRoutes.js").PageRoutes;
     _onBeforeRouteHook: import("../../shared/route/executeOnBeforeRouteHook.js").OnBeforeRouteHook | null;
-} & T & import("../../shared/addUrlComputedProps.js").PageContextUrlComputedPropsClient & {
+} & import("../../shared/addUrlComputedProps.js").PageContextUrlComputedPropsClient & {
     _urlRewrite: string | null;
 }>;

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

@@ -3,9 +3,9 @@ import { addUrlComputedProps } from '../../shared/addUrlComputedProps.js';
 import { getPageFilesAll } from '../../shared/getPageFiles.js';
 import { loadPageRoutes } from '../../shared/route/loadPageRoutes.js';
 import { getBaseServer } from './getBaseServer.js';
-import { assert, isBaseServer, objectAssign, getGlobalObject } from './utils.js';
+import { assert, isBaseServer, getGlobalObject } from './utils.js';
 const globalObject = getGlobalObject('createPageContext.ts', {});
-async function createPageContext(pageContextBase) {
+async function createPageContext(urlOriginal) {
     if (!globalObject.pageFilesData) {
         globalObject.pageFilesData = await getPageFilesAll(true);
     }
@@ -16,6 +16,7 @@ async function createPageContext(pageContextBase) {
     // @ts-ignore Since dist/cjs/client/ is never used, we can ignore this error.
     const isProd = import.meta.env.PROD;
     const pageContext = {
+        urlOriginal,
         _objectCreatedByVike: true,
         _urlHandler: null,
         _urlRewrite: null,
@@ -29,7 +30,6 @@ async function createPageContext(pageContextBase) {
         _pageRoutes: pageRoutes,
         _onBeforeRouteHook: onBeforeRouteHook
     };
-    objectAssign(pageContext, pageContextBase);
     addUrlComputedProps(pageContext);
     return pageContext;
 }

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

@@ -1,9 +1,9 @@
 import { assertClientRouting } from '../../utils/assertRoutingType.js';
 assertClientRouting();
 import './pageFiles';
-import { useClientRouter } from './useClientRouter.js';
+import { installClientRouter } from './installClientRouter.js';
 import { onClientEntry_ClientRouting } from './utils.js';
 // @ts-ignore Since dist/cjs/client/ is never used, we can ignore this error.
 const isProd = import.meta.env.PROD;
 onClientEntry_ClientRouting(isProd);
-useClientRouter();
+installClientRouter();

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

@@ -21,7 +21,6 @@ declare function getPageContext(pageContext: {
 declare function getPageContextErrorPage(pageContext: {
     urlOriginal: string;
     _allPageIds: string[];
-    _isFirstRenderAttempt: boolean;
     _pageFilesAll: PageFile[];
     _pageConfigs: PageConfigRuntime[];
 } & PageContextPassThrough): Promise<PageContextAddendum>;

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

@@ -21,13 +21,11 @@ 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;
@@ -40,7 +38,7 @@ async function getPageContextFirstRender(pageContext) {
         isHydration: true,
         _hasPageContextFromClient: false
     });
-    objectAssign(pageContextAddendum, await loadPageFilesClientSide(pageContext._pageFilesAll, pageContext._pageConfigs, pageContextAddendum._pageId));
+    objectAssign(pageContextAddendum, await loadPageFilesClientSide(pageContextAddendum._pageId, pageContext));
     {
         const pageContextForHook = { ...pageContext, ...pageContextAddendum };
         if (await onBeforeRenderClientOnlyExists(pageContextForHook)) {
@@ -71,7 +69,7 @@ async function getPageContextUponNavigation(pageContext) {
 }
 async function getPageContextAlreadyRouted(pageContext, isErrorPage) {
     let pageContextAddendum = {};
-    objectAssign(pageContextAddendum, await loadPageFilesClientSide(pageContext._pageFilesAll, pageContext._pageConfigs, pageContext._pageId));
+    objectAssign(pageContextAddendum, await loadPageFilesClientSide(pageContext._pageId, pageContext));
     // Needs to be called before any client-side hook, because it may contain pageContextInit.user which is needed for guard() and onBeforeRender()
     if (
     // For the error page, we cannot fetch pageContext from the server because the pageContext JSON request is based on the URL
@@ -89,7 +87,7 @@ async function getPageContextAlreadyRouted(pageContext, isErrorPage) {
                 isHydration: false,
                 _pageId: errorPageId
             });
-            objectAssign(pageContextAddendum, await loadPageFilesClientSide(pageContext._pageFilesAll, pageContext._pageConfigs, pageContextAddendum._pageId));
+            objectAssign(pageContextAddendum, await loadPageFilesClientSide(pageContextAddendum._pageId, pageContext));
             assert(hasProp(pageContextFromServer, 'is404', 'boolean'));
             assert(hasProp(pageContextFromServer, 'pageProps', 'object'));
             assert(hasProp(pageContextFromServer.pageProps, 'is404', 'boolean'));
@@ -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/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;