vike 0.4.225 → 0.4.226-commit-a0035ee

package/dist/cjs/shared/modifyUrlSameOrigin.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.modifyUrlSameOrigin = modifyUrlSameOrigin;
+const utils_js_1 = require("./utils.js");
+function modifyUrlSameOrigin(url, modify) {
+    const urlParsed = (0, utils_js_1.parseUrl)(url, '/');
+    // Pathname
+    const pathname = modify.pathname ?? urlParsed.pathnameOriginal;
+    (0, utils_js_1.assertUsageUrlPathnameAbsolute)(pathname, 'modify.pathname');
+    // Search
+    let search = modify.search === null ? '' : !modify.search ? urlParsed.searchOriginal : resolveSearch(urlParsed, modify.search);
+    if (search === '?')
+        search = '';
+    // Hash
+    let hash;
+    if (modify.hash === null) {
+        hash = '';
+    }
+    else if (modify.hash === undefined) {
+        hash = urlParsed.hashOriginal ?? '';
+    }
+    else {
+        hash = modify.hash;
+        if (!hash.startsWith('#'))
+            hash = '#' + hash;
+    }
+    const urlModified = (0, utils_js_1.createUrlFromComponents)(urlParsed.origin, pathname, search, hash);
+    return urlModified;
+}
+function resolveSearch(urlParsed, search) {
+    let searchParams;
+    if (search instanceof URLSearchParams) {
+        // Overwrite
+        searchParams = search;
+    }
+    else {
+        // Merge
+        const searchMap = (0, utils_js_1.objectFilter)({ ...urlParsed.search, ...search }, (utils_js_1.isNotNullish_keyVal));
+        searchParams = new URLSearchParams(searchMap);
+    }
+    return '?' + searchParams.toString();
+}

package/dist/cjs/shared/page-configs/getConfigDefinedAt.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getConfigDefinedAt = getConfigDefinedAt;
 exports.getConfigDefinedAtOptional = getConfigDefinedAtOptional;
 exports.getDefinedAtString = getDefinedAtString;
+exports.getDefinedByString = getDefinedByString;
 const utils_js_1 = require("../utils.js");
 const picocolors_1 = __importDefault(require("@brillout/picocolors"));
 const getExportPath_js_1 = require("./getExportPath.js");
@@ -49,14 +50,14 @@ function getDefinedAtString(definedAtData, configName) {
 }
 function getDefinedByString(definedAt, configName) {
     if (definedAt.definedBy === 'api') {
-        return `API call ${picocolors_1.default.cyan(`${definedAt.operation}({${configName}})`)}`;
+        return `API call ${picocolors_1.default.cyan(`${definedAt.operation}({ vikeConfig: { ${configName} } })`)}`;
     }
     const { definedBy } = definedAt;
     if (definedBy === 'cli') {
         return `CLI option ${picocolors_1.default.cyan(`--${configName}`)}`;
     }
     if (definedBy === 'env') {
-        return `environment variable ${picocolors_1.default.cyan(`VIKE_OPTIONS="{${configName}}"`)}`;
+        return `environment variable ${picocolors_1.default.cyan(`VIKE_CONFIG="{${configName}}"`)}`;
     }
     (0, utils_js_1.checkType)(definedBy);
     (0, utils_js_1.assert)(false);

package/dist/cjs/shared/page-configs/getConfigValueBuildTime.js

@@ -58,11 +58,11 @@ function mergeCumulative(configValueSources) {
     return { value, definedAtData };
 }
 function getDefinedAt(configValueSource) {
-    const { definedAtFilePath } = configValueSource;
-    if (definedAtFilePath.definedBy)
-        return definedAtFilePath;
+    const { definedAt } = configValueSource;
+    if (definedAt.definedBy)
+        return definedAt;
     return {
-        filePathToShowToUser: definedAtFilePath.filePathToShowToUser,
-        fileExportPathToShowToUser: definedAtFilePath.fileExportPathToShowToUser
+        filePathToShowToUser: definedAt.filePathToShowToUser,
+        fileExportPathToShowToUser: definedAt.fileExportPathToShowToUser
     };
 }

package/dist/cjs/shared/page-configs/serialize/serializeConfigValues.js

@@ -52,7 +52,7 @@ function serializeConfigValues(pageConfig, importStatements, filesEnv, isEnvMatc
 function getValueSerializedFromSource(configValueSource, configName, importStatements, filesEnv) {
     let valueData;
     if (configValueSource.valueIsLoaded && !configValueSource.valueIsLoadedWithImport) {
-        valueData = getValueSerializedWithJson(configValueSource.value, configName, configValueSource.definedAtFilePath, importStatements, filesEnv, configValueSource.configEnv);
+        valueData = getValueSerializedWithJson(configValueSource.value, configName, configValueSource.definedAt, importStatements, filesEnv, configValueSource.configEnv);
     }
     else {
         valueData = getValueSerializedWithImport(configValueSource, importStatements, filesEnv, configName);
@@ -103,9 +103,9 @@ function serializeConfigValue(configValueBase, valueData, configName, lines, tab
 }
 function getValueSerializedWithImport(configValueSource, importStatements, filesEnv, configName) {
     (0, utils_js_1.assert)(!configValueSource.valueIsFilePath);
-    const { valueIsDefinedByPlusValueFile, definedAtFilePath, configEnv } = configValueSource;
-    (0, utils_js_1.assert)(!definedAtFilePath.definedBy);
-    const { filePathAbsoluteVite, fileExportName } = definedAtFilePath;
+    const { valueIsDefinedByPlusValueFile, definedAt, configEnv } = configValueSource;
+    (0, utils_js_1.assert)(!definedAt.definedBy);
+    const { filePathAbsoluteVite, fileExportName } = definedAt;
     if (valueIsDefinedByPlusValueFile)
         (0, utils_js_1.assert)(fileExportName === undefined);
     const { importName } = addImportStatement(importStatements, filePathAbsoluteVite, fileExportName || '*', filesEnv, configEnv, configName);
@@ -232,12 +232,12 @@ function getConfigValuesBase(pageConfig, isEnvMatch, isEager) {
     return [...fromComputed, ...fromSources].filter((r) => r !== 'SKIP');
 }
 function getDefinedAtFileSource(source) {
-    const { definedAtFilePath } = source;
-    if (definedAtFilePath.definedBy)
-        return definedAtFilePath;
+    const { definedAt } = source;
+    if (definedAt.definedBy)
+        return definedAt;
     const definedAtFile = {
-        filePathToShowToUser: definedAtFilePath.filePathToShowToUser,
-        fileExportPathToShowToUser: definedAtFilePath.fileExportPathToShowToUser
+        filePathToShowToUser: definedAt.filePathToShowToUser,
+        fileExportPathToShowToUser: definedAt.fileExportPathToShowToUser
     };
     return definedAtFile;
 }

package/dist/cjs/shared/utils.js

@@ -30,7 +30,7 @@ __exportStar(require("../utils/isBrowser.js"), exports);
 __exportStar(require("../utils/hasProp.js"), exports);
 __exportStar(require("../utils/isPlainObject.js"), exports);
 __exportStar(require("../utils/compareString.js"), exports);
-__exportStar(require("../utils/isNotNullish.js"), exports);
+__exportStar(require("../utils/isNullish.js"), exports);
 __exportStar(require("../utils/stringifyStringArray.js"), exports);
 __exportStar(require("../utils/cast.js"), exports);
 __exportStar(require("../utils/isPropertyGetter.js"), exports);
@@ -42,3 +42,4 @@ __exportStar(require("../utils/isArray.js"), exports);
 __exportStar(require("../utils/changeEnumerable.js"), exports);
 __exportStar(require("../utils/objectDefineProperty.js"), exports);
 __exportStar(require("../utils/isScriptFile.js"), exports);
+__exportStar(require("../utils/objectFilter.js"), exports);

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.225';
+exports.PROJECT_VERSION = '0.4.226-commit-a0035ee';

package/dist/cjs/utils/assert.js

@@ -47,7 +47,7 @@ function assert(condition, debugInfo) {
         const debugInfoSerialized = typeof debugInfo === 'string' ? debugInfo : JSON.stringify(debugInfo);
         return picocolors_1.default.dim(`Debug info (for Vike maintainers; you can ignore this): ${debugInfoSerialized}`);
     })();
-    const link = picocolors_1.default.blue('https://github.com/vikejs/vike/issues/new?template=bug.yml');
+    const link = picocolors_1.default.underline('https://github.com/vikejs/vike/issues/new?template=bug.yml');
     let errMsg = [
         `You stumbled upon a Vike bug. Go to ${link} and copy-paste this error. A maintainer will fix the bug (usually within 24 hours).`,
         debugStr
@@ -61,7 +61,7 @@ function assert(condition, debugInfo) {
     globalObject.onBeforeLog?.();
     throw internalError;
 }
-function assertUsage(condition, errMsg, { showStackTrace } = {}) {
+function assertUsage(condition, errMsg, { showStackTrace, exitOnError } = {}) {
     if (condition)
         return;
     showStackTrace = showStackTrace || globalObject.alwaysShowStackTrace;
@@ -73,7 +73,13 @@ function assertUsage(condition, errMsg, { showStackTrace } = {}) {
         globalObject.showStackTraceList.add(usageError);
     }
     globalObject.onBeforeLog?.();
-    throw usageError;
+    if (!exitOnError) {
+        throw usageError;
+    }
+    else {
+        console.error(showStackTrace ? usageError : errMsg);
+        process.exit(1);
+    }
 }
 function getProjectError(errMsg) {
     errMsg = addWhitespace(errMsg);
@@ -187,6 +193,7 @@ function overwriteAssertProductionLogger(logger) {
 function isBug(err) {
     return String(err).includes(`[${bugTag}]`);
 }
+// Called upon `DEBUG=vike:error`
 function setAlwaysShowStackTrace() {
     globalObject.alwaysShowStackTrace = true;
 }

package/dist/cjs/utils/assertSetup.js

@@ -7,12 +7,12 @@ exports.assertIsNotProductionRuntime = assertIsNotProductionRuntime;
 exports.onSetupRuntime = onSetupRuntime;
 exports.onSetupBuild = onSetupBuild;
 exports.onSetupPrerender = onSetupPrerender;
+exports.onSetupPreview = onSetupPreview;
 exports.setNodeEnvProduction = setNodeEnvProduction;
 exports.markSetup_viteDevServer = markSetup_viteDevServer;
 exports.markSetup_vitePreviewServer = markSetup_vitePreviewServer;
 exports.markSetup_vikeVitePlugin = markSetup_vikeVitePlugin;
 exports.markSetup_isViteDev = markSetup_isViteDev;
-exports.markSetup_isPrerendering = markSetup_isPrerendering;
 const assert_js_1 = require("./assert.js");
 const assertIsNotBrowser_js_1 = require("./assertIsNotBrowser.js");
 const debug_js_1 = require("./debug.js");
@@ -34,7 +34,7 @@ function onSetupRuntime() {
     if (isTest())
         return;
     assertNodeEnvIsNotUndefinedString();
-    if (!isViteLoaded()) {
+    if (!setup.viteDevServer && setup.isViteDev === undefined) {
         // TODO: make it assertUsage() again once https://github.com/vikejs/vike/issues/1528 is implemented.
         (0, assert_js_1.assertWarning)(!isNodeEnvDev(), `The ${getEnvDescription()}, which is contradictory because the environment seems to be a production environment (Vite isn't loaded), see https://vike.dev/NODE_ENV`, { onlyOnce: true });
         (0, assert_js_1.assertUsage)(!setup.vikeVitePlugin, `Loading Vike's Vite plugin (the ${picocolors_1.default.cyan('vike/plugin')} module) is prohibited in production.`);
@@ -42,11 +42,10 @@ function onSetupRuntime() {
         (0, assert_js_1.assert)(!setup.shouldNotBeProduction);
     }
     else {
-        if (!setup.vitePreviewServer && !setup.isPrerendering) {
+        if (!setup.isPreview && !setup.vitePreviewServer && !setup.isPrerendering) {
             // TODO: make it assertUsage() again once https://github.com/vikejs/vike/issues/1528 is implemented.
             (0, assert_js_1.assertWarning)(isNodeEnvDev(), `The ${getEnvDescription()}, but Vite is loaded which is prohibited in production, see https://vike.dev/NODE_ENV`, { onlyOnce: true });
         }
-        // These two assert() calls aren't that interesting
         (0, assert_js_1.assert)(setup.vikeVitePlugin);
         (0, assert_js_1.assert)(setup.shouldNotBeProduction);
     }
@@ -63,15 +62,16 @@ function onSetupBuild() {
     setNodeEnvProduction()
     */
 }
+// Called by ../node/prerender/runPrerender.ts
 function onSetupPrerender() {
     markSetup_isPrerendering();
     if (getNodeEnv())
         assertUsageNodeEnvIsNotDev('pre-rendering');
     setNodeEnvProduction();
 }
-function isViteLoaded() {
-    // Do we need setup.viteDevServer or setup.vitePreviewServer ?
-    return setup.viteDevServer || setup.vitePreviewServer || setup.isViteDev !== undefined;
+// Called by ../node/api/preview.ts
+function onSetupPreview() {
+    markSetup_isPreview();
 }
 function isTest() {
     return (0, isVitest_js_1.isVitest)() || isNodeEnv('test');
@@ -100,12 +100,16 @@ function markSetup_isViteDev(isViteDev) {
         debug('markSetup_isViteDev()', new Error().stack);
     setup.isViteDev = isViteDev;
 }
-// Called by ../node/prerender/runPrerender.ts
 function markSetup_isPrerendering() {
     if (debug.isActivated)
         debug('markSetup_isPrerendering()', new Error().stack);
     setup.isPrerendering = true;
 }
+function markSetup_isPreview() {
+    if (debug.isActivated)
+        debug('markSetup_isPreview()', new Error().stack);
+    setup.isPreview = true;
+}
 function assertUsageNodeEnvIsNotDev(operation) {
     if (!isNodeEnvDev())
         return;

package/dist/cjs/utils/assertSingleInstance.js

@@ -16,13 +16,24 @@ const PROJECT_VERSION_js_1 = require("./PROJECT_VERSION.js");
 /* Use original assertWarning() after all CJS is removed from node_modules/vike/dist/
 import { assertWarning } from './assert.js'
 */
-const globalObject = (0, getGlobalObject_js_1.getGlobalObject)('utils/assertSingleInstance.ts', {
-    instances: [],
-    alreadyLogged: new Set()
-});
+let globalObject;
+// getGlobalObjectSafe() can be called before this line
+globalObject ?? (globalObject = genGlobalConfig());
+function genGlobalConfig() {
+    return (0, getGlobalObject_js_1.getGlobalObject)('utils/assertSingleInstance.ts', {
+        instances: [],
+        alreadyLogged: new Set()
+    });
+}
+// We need getGlobalObjectSafe() because globalObject is `undefined` when exported functions are called before globalObject is initialized
+function getGlobalObjectSafe() {
+    globalObject ?? (globalObject = genGlobalConfig());
+    return globalObject;
+}
 const clientRuntimesClonflict = 'Client runtime of both Server Routing and Client Routing loaded https://vike.dev/client-runtimes-conflict';
 const clientNotSingleInstance = 'Client runtime loaded twice https://vike.dev/client-runtime-duplicated';
 function assertSingleInstance() {
+    const globalObject = getGlobalObjectSafe();
     {
         const versions = (0, unique_js_1.unique)(globalObject.instances);
         assertWarning(versions.length <= 1, 
@@ -39,6 +50,7 @@ function assertSingleInstance() {
     }
 }
 function assertSingleInstance_onClientEntryServerRouting(isProduction) {
+    const globalObject = getGlobalObjectSafe();
     assertWarning(globalObject.isClientRouting !== true, clientRuntimesClonflict, {
         onlyOnce: true,
         showStackTrace: true
@@ -53,6 +65,7 @@ function assertSingleInstance_onClientEntryServerRouting(isProduction) {
     assertSingleInstance();
 }
 function assertSingleInstance_onClientEntryClientRouting(isProduction) {
+    const globalObject = getGlobalObjectSafe();
     assertWarning(globalObject.isClientRouting !== false, clientRuntimesClonflict, {
         onlyOnce: true,
         showStackTrace: true
@@ -68,10 +81,12 @@ function assertSingleInstance_onClientEntryClientRouting(isProduction) {
 }
 // Called by utils/assert.ts which is (most certainly) loaded by all entries. That way we don't have to call a callback for every entry. (There are a lot of entries: `client/router/`, `client/`, `node/runtime/`, `node/plugin/`, `node/cli`.)
 function assertSingleInstance_onAssertModuleLoad() {
+    const globalObject = getGlobalObjectSafe();
     globalObject.instances.push(PROJECT_VERSION_js_1.PROJECT_VERSION);
     assertSingleInstance();
 }
 function assertWarning(condition, errorMessage, { onlyOnce, showStackTrace }) {
+    const globalObject = getGlobalObjectSafe();
     if (condition) {
         return;
     }

package/dist/cjs/utils/getRandomId.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getRandomId = getRandomId;
 const assert_js_1 = require("./assert.js");
 // https://stackoverflow.com/questions/1349404/generate-random-string-characters-in-javascript
-function getRandomId(length) {
+function getRandomId(length = 12) {
     let randomId = '';
     while (randomId.length < length) {
         randomId += Math.random().toString(36).slice(2);

package/dist/cjs/utils/isNullish.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isNullish = isNullish;
+exports.isNotNullish = isNotNullish;
+exports.isNotNullish_keyVal = isNotNullish_keyVal;
+function isNullish(val) {
+    return val === null || val === undefined;
+}
+// someArray.filter(isNotNullish)
+function isNotNullish(p) {
+    return !isNullish(p);
+}
+// objectFilter(obj).filter(isNotNullish_keyVal)
+function isNotNullish_keyVal(arg) {
+    return !isNullish(arg[1]);
+}

package/dist/cjs/utils/normalizeHeaders.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.normalizeHeaders = normalizeHeaders;
 const isObject_js_1 = require("./isObject.js");
 function normalizeHeaders(
-/* This type is precise, too precise which can be annoying: e.g. cannot pass a string[][] argument because it doesn't match the more precise [string,string][] type.
+/* This type is too strict which is annoying: cannot pass `string[][]` because it doesn't match the more precise type `[string,string][]`.
 headersOriginal ConstructorParameters<typeof Headers>[0]
 */
 headersOriginal) {

package/dist/cjs/utils/objectAssign.js

@@ -5,9 +5,14 @@ const assert_js_1 = require("./assert.js");
 // Same as Object.assign() but:
 //  - With type inference
 //  - Preserves property descriptors, which we need for preserving the getters added by getPageContextUrlComputed()
-function objectAssign(obj, objAddendum) {
+function objectAssign(obj, objAddendum, objAddendumCanBePageContextObject) {
     if (objAddendum) {
-        (0, assert_js_1.assert)(!('_isPageContextObject' in objAddendum));
+        if (!objAddendumCanBePageContextObject) {
+            // We only need this assert() in the rare case when the user is expected to mutate `pageContext` after the Vike hook was executed (and its promise resolved).
+            // - The only use case I can think of is the user mutating `pageContext` after the onRenderClient() promise resolved (which can happen when client-side rendering finishes after onRenderClient() resolves). In that case, having Vike await async Vike hooks isn't enough.
+            // - IIRC this assert() was mostly needed for preserving the getters added by getPageContextUrlComputed() but we don't need this anymore.
+            (0, assert_js_1.assert)(!('_isPageContextObject' in objAddendum));
+        }
         Object.defineProperties(obj, Object.getOwnPropertyDescriptors(objAddendum));
     }
 }

package/dist/cjs/utils/objectFilter.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.objectFilter = objectFilter;
+// Type inference for:
+// ```js
+// Object.fromEntries(Object.entries(obj).filter(someFilter))
+// ```
+function objectFilter(obj, filter) {
+    return Object.fromEntries(Object.entries(obj).filter(filter));
+}

package/dist/cjs/utils/pick.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pick = pick;
+function pick(obj, keys) {
+    const result = {};
+    for (const key of keys) {
+        if (key in obj) {
+            result[key] = obj[key];
+        }
+    }
+    return result;
+}

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

@@ -1,5 +1,8 @@
 export { createPageContext };
 declare function createPageContext(urlOriginal: string): Promise<{
+    _isPageContextObject: boolean;
+    isClientSide: boolean;
+    isPrerendering: boolean;
     urlOriginal: string;
     _objectCreatedByVike: boolean;
     _urlHandler: null;
@@ -11,7 +14,6 @@ declare function createPageContext(urlOriginal: string): Promise<{
     _allPageIds: string[];
     _pageRoutes: import("../../shared/route/loadPageRoutes.js").PageRoutes;
     _onBeforeRouteHook: import("../../shared/hooks/getHook.js").Hook | null;
-    _isPageContextObject: boolean;
 } & {
     urlParsed: import("./utils.js").UrlPublic;
     urlPathname: string;

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

@@ -4,7 +4,6 @@ import { getPageContextUrlComputed } from '../../shared/getPageContextUrlCompute
 import { loadPageRoutes } from '../../shared/route/loadPageRoutes.js';
 import { getBaseServer } from './getBaseServer.js';
 import { assert, isBaseServer, objectAssign } from './utils.js';
-// TODO/now: can we avoid optimizeDeps.exclude of client runtime?
 // @ts-ignore
 import * as virtualFileExports from 'virtual:vike:importUserCode:client:client-routing';
 const { pageFilesAll, allPageIds, pageConfigs, pageConfigGlobal } = getPageConfigsRuntime(virtualFileExports);
@@ -13,6 +12,9 @@ async function createPageContext(urlOriginal) {
     const baseServer = getBaseServer();
     assert(isBaseServer(baseServer));
     const pageContext = {
+        _isPageContextObject: true,
+        isClientSide: true,
+        isPrerendering: false,
         urlOriginal,
         _objectCreatedByVike: true,
         _urlHandler: null,
@@ -23,8 +25,7 @@ async function createPageContext(urlOriginal) {
         _pageConfigGlobal: pageConfigGlobal,
         _allPageIds: allPageIds,
         _pageRoutes: pageRoutes,
-        _onBeforeRouteHook: onBeforeRouteHook,
-        _isPageContextObject: true
+        _onBeforeRouteHook: onBeforeRouteHook
     };
     const pageContextUrlComputed = getPageContextUrlComputed(pageContext);
     objectAssign(pageContext, pageContextUrlComputed);

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

@@ -1,5 +1,10 @@
 export { navigate };
 export { reload };
+type Options = {
+    keepScrollPosition?: boolean;
+    overwriteLastHistoryEntry?: boolean;
+    pageContext?: Record<string, unknown>;
+};
 /** Programmatically navigate to a new page.
  *
  * https://vike.dev/navigate
@@ -8,9 +13,5 @@ export { reload };
  * @param keepScrollPosition - Don't scroll to the top of the page, instead keep the current scroll position.
  * @param overwriteLastHistoryEntry - Don't create a new entry in the browser's history, instead let the new URL replace the current URL. (This effectively removes the current URL from the browser history).
  */
-declare function navigate(url: string, { keepScrollPosition, overwriteLastHistoryEntry, pageContext }?: {
-    keepScrollPosition?: boolean;
-    overwriteLastHistoryEntry?: boolean;
-    pageContext?: Record<string, unknown>;
-}): Promise<void>;
+declare function navigate(url: string, options?: Options): Promise<void>;
 declare function reload(): Promise<void>;

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

@@ -1,5 +1,6 @@
 export { navigate };
 export { reload };
+// import { modifyUrlSameOrigin, ModifyUrlSameOriginOptions } from '../../shared/modifyUrlSameOrigin.js'
 import { getCurrentUrl } from '../shared/getCurrentUrl.js';
 import { normalizeUrlArgument } from './normalizeUrlArgument.js';
 import { firstRenderStartPromise, renderPageClientSide } from './renderPageClientSide.js';
@@ -13,11 +14,14 @@ assertClientRouting();
  * @param keepScrollPosition - Don't scroll to the top of the page, instead keep the current scroll position.
  * @param overwriteLastHistoryEntry - Don't create a new entry in the browser's history, instead let the new URL replace the current URL. (This effectively removes the current URL from the browser history).
  */
-async function navigate(url, { keepScrollPosition = false, overwriteLastHistoryEntry = false, pageContext } = {}) {
+async function navigate(url, options) {
+    // let url = normalizeUrlArgument(options.url ?? getCurrentUrl(), 'navigate')
+    // url = modifyUrlSameOrigin(url, options)
     normalizeUrlArgument(url, 'navigate');
     // If `hydrationCanBeAborted === false` (e.g. Vue) then we can apply navigate() only after hydration is done
     await firstRenderStartPromise;
-    const scrollTarget = { preserveScroll: keepScrollPosition };
+    const { keepScrollPosition, overwriteLastHistoryEntry, pageContext } = options ?? {};
+    const scrollTarget = { preserveScroll: keepScrollPosition ?? false };
     await renderPageClientSide({
         scrollTarget,
         urlOriginal: url,

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

@@ -2,7 +2,7 @@ export { normalizeUrlArgument };
 import { assertUsage, isUrl, isUrlRelative } from './utils.js';
 function normalizeUrlArgument(url, fnName) {
     // Succinct error message to save client-side KBs
-    const errMsg = `[${fnName}(url)] Invalid URL ${url}`;
+    const errMsg = `URL ${url} passed to ${fnName}() is invalid`;
     assertUsage(isUrl(url), errMsg);
     if (url.startsWith(location.origin)) {
         // Use normalizeClientSideUrl() instead?

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

@@ -276,7 +276,7 @@ async function renderPageClientSide(renderArgs) {
         if ('err' in args) {
             const { err } = args;
             assert(!('errorWhileRendering' in pageContext));
-            pageContext.errorWhileRendering = err;
+            objectAssign(pageContext, { errorWhileRendering: err });
             if (isAbortError(err)) {
                 const errAbort = err;
                 logAbortErrorHandled(err, !import.meta.env.DEV, pageContext);

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

@@ -1,12 +1,15 @@
 export { getPageContext };
 declare function getPageContext(): Promise<{
-    pageId: string;
-    routeParams: Record<string, string>;
-} & {
+    _isPageContextObject: boolean;
+    isPrerendering: boolean;
+    isClientSide: boolean;
     isHydration: true;
     isBackwardNavigation: null;
     _hasPageContextFromServer: true;
     _hasPageContextFromClient: false;
+} & {
+    pageId: string;
+    routeParams: Record<string, string>;
 } & {
     _pageFilesAll: import("../../shared/getPageFiles.js").PageFile[];
     _pageConfigs: import("../../__internal/index.js").PageConfig[];

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

@@ -9,13 +9,16 @@ import * as virtualFileExports from 'virtual:vike:importUserCode:client:server-r
 const { pageFilesAll, pageConfigs, pageConfigGlobal } = getPageConfigsRuntime(virtualFileExports);
 const urlFirst = getCurrentUrl({ withoutHash: true });
 async function getPageContext() {
-    const pageContext = getPageContextSerializedInHtml();
-    objectAssign(pageContext, {
+    const pageContext = {
+        _isPageContextObject: true,
+        isPrerendering: false,
+        isClientSide: true,
         isHydration: true,
         isBackwardNavigation: null,
         _hasPageContextFromServer: true,
         _hasPageContextFromClient: false
-    });
+    };
+    objectAssign(pageContext, getPageContextSerializedInHtml());
     objectAssign(pageContext, await loadPageUserFiles(pageContext.pageId));
     assertPristineUrl();
     return pageContext;

package/dist/esm/client/shared/getPageContextProxyForUser.d.ts

@@ -1,12 +1,2 @@
 export { getPageContextProxyForUser };
-export { PageContextForPassToClientWarning };
-type PageContextForPassToClientWarning = {
-    _hasPageContextFromServer: boolean;
-    _hasPageContextFromClient: boolean;
-};
-/**
- * Throw error when pageContext value isn't:
- * - serializable, or
- * - defined.
- */
-declare function getPageContextProxyForUser<PageContext extends Record<string, unknown> & PageContextForPassToClientWarning>(pageContext: PageContext): PageContext;
+declare function getPageContextProxyForUser<PageContext extends Record<string, unknown>>(pageContext: PageContext): PageContext;