vike 0.4.225-commit-37a36a5 → 0.4.225-commit-2b7971f

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

@@ -1,6 +1,6 @@
 export { renderPage };
 export { renderPage_addAsyncHookwrapper };
-import { getPageContextInitEnhanced, renderPageAlreadyRouted } from './renderPage/renderPageAlreadyRouted.js';
+import { getPageContextInitEnhanced, renderPageAlreadyRouted, createPageContext } from './renderPage/renderPageAlreadyRouted.js';
 import { route } from '../../shared/route/index.js';
 import { assert, hasProp, objectAssign, isUrl, parseUrl, onSetupRuntime, assertWarning, getGlobalObject, checkType, assertUsage, normalizeUrlPathname, removeBaseServer, modifyUrlPathname, prependBase, removeUrlOrigin, setUrlOrigin, isUri, getUrlPretty } from './utils.js';
 import { assertNoInfiniteAbortLoop, getPageContextFromAllRewrites, isAbortError, logAbortErrorHandled } from '../../shared/route/abort.js';
@@ -103,15 +103,9 @@ async function renderPageAlreadyPrepared(pageContextInit, globalContext, httpReq
     // https://stackoverflow.com/questions/9683007/detect-infinite-http-redirect-loop-on-server-side
     0);
     let pageContextNominalPageSuccess;
-    let pageContextNominalPageInit = {};
-    {
-        const pageContextFromAllRewrites = getPageContextFromAllRewrites(pageContextsFromRewrite);
-        objectAssign(pageContextNominalPageInit, pageContextFromAllRewrites);
-    }
-    {
-        const pageContextInitEnhanced = await getPageContextInitEnhancedSSR(pageContextInit, globalContext, pageContextNominalPageInit._urlRewrite, httpRequestId);
-        objectAssign(pageContextNominalPageInit, pageContextInitEnhanced);
-    }
+    const pageContextFromAllRewrites = getPageContextFromAllRewrites(pageContextsFromRewrite);
+    const pageContextNominalPageInit = await getPageContextInitEnhancedSSR(pageContextInit, globalContext, pageContextFromAllRewrites._urlRewrite, httpRequestId);
+    objectAssign(pageContextNominalPageInit, pageContextFromAllRewrites);
     let errNominalPage;
     {
         try {
@@ -242,7 +236,7 @@ function prettyUrl(url) {
     return pc.bold(decodeURI(url));
 }
 function getPageContextHttpResponseError(err, pageContextInit, pageContext) {
-    const pageContextWithError = createPageContext(pageContextInit);
+    const pageContextWithError = createPageContext(pageContextInit, false);
     const httpResponse = createHttpResponseError(pageContext);
     objectAssign(pageContextWithError, {
         httpResponse,
@@ -250,13 +244,6 @@ function getPageContextHttpResponseError(err, pageContextInit, pageContext) {
     });
     return pageContextWithError;
 }
-function createPageContext(pageContextInit) {
-    const pageContext = {
-        _isPageContextObject: true
-    };
-    Object.assign(pageContext, pageContextInit);
-    return pageContext;
-}
 async function renderPageNominal(pageContext) {
     objectAssign(pageContext, { errorWhileRendering: null });
     // Route
@@ -281,10 +268,8 @@ async function renderPageNominal(pageContext) {
     return pageContextAfterRender;
 }
 async function getPageContextErrorPageInit(pageContextInit, globalContext, errNominalPage, pageContextNominalPagePartial, httpRequestId) {
-    const pageContextInitEnhanced = await getPageContextInitEnhancedSSR(pageContextInit, globalContext, null, httpRequestId);
+    const pageContext = await getPageContextInitEnhancedSSR(pageContextInit, globalContext, null, httpRequestId);
     assert(errNominalPage);
-    const pageContext = {};
-    objectAssign(pageContext, pageContextInitEnhanced);
     objectAssign(pageContext, {
         is404: false,
         errorWhileRendering: errNominalPage,
@@ -298,7 +283,7 @@ async function getPageContextErrorPageInit(pageContextInit, globalContext, errNo
 }
 async function getPageContextInitEnhancedSSR(pageContextInit, globalContext, urlRewrite, httpRequestId) {
     const { isClientSideNavigation, _urlHandler } = handlePageContextUrl(pageContextInit.urlOriginal);
-    const pageContextInitEnhanced = await getPageContextInitEnhanced(pageContextInit, globalContext, {
+    const pageContextInitEnhanced = await getPageContextInitEnhanced(pageContextInit, globalContext, false, {
         ssr: {
             urlRewrite,
             urlHandler: _urlHandler,
@@ -342,7 +327,7 @@ async function normalizeUrl(pageContextInit, globalContext, httpRequestId) {
         return null;
     logRuntimeInfo?.(`URL normalized from ${pc.cyan(urlOriginal)} to ${pc.cyan(urlNormalized)} (https://vike.dev/url-normalization)`, httpRequestId, 'info');
     const httpResponse = createHttpResponseRedirect({ url: urlNormalized, statusCode: 301 }, pageContextInit);
-    const pageContextHttpResponse = createPageContext(pageContextInit);
+    const pageContextHttpResponse = createPageContext(pageContextInit, false);
     objectAssign(pageContextHttpResponse, { httpResponse });
     return pageContextHttpResponse;
 }
@@ -384,7 +369,7 @@ async function getPermanentRedirect(pageContextInit, globalContext, httpRequestI
     }
     logRuntimeInfo?.(`Permanent redirection defined by config.redirects (https://vike.dev/redirects)`, httpRequestId, 'info');
     const httpResponse = createHttpResponseRedirect({ url: urlTarget, statusCode: 301 }, pageContextInit);
-    const pageContextHttpResponse = createPageContext(pageContextInit);
+    const pageContextHttpResponse = createPageContext(pageContextInit, false);
     objectAssign(pageContextHttpResponse, { httpResponse });
     return pageContextHttpResponse;
 }
@@ -405,10 +390,10 @@ pageContextNominalPageInit, httpRequestId, pageContextErrorPageInit, globalConte
             const abortCall = pageContextAbort._abortCall;
             assert(abortCall);
             assertUsage(errorPageId, `You called ${pc.cyan(abortCall)} but you didn't define an error page, make sure to define one https://vike.dev/error-page`);
-            const pageContext = createPageContext({});
+            const pageContext = createPageContext({}, false);
             objectAssign(pageContext, { pageId: errorPageId });
             objectAssign(pageContext, pageContextAbort);
-            objectAssign(pageContext, pageContextErrorPageInit);
+            objectAssign(pageContext, pageContextErrorPageInit, true);
             objectAssign(pageContext, await loadUserFilesServerSide(pageContext));
             // We include pageContextInit: we don't only serialize pageContextAbort because the error page may need to access pageContextInit
             pageContextSerialized = serializePageContextClientSide(pageContext);
@@ -429,7 +414,7 @@ pageContextNominalPageInit, httpRequestId, pageContextErrorPageInit, globalConte
         return { pageContextReturn };
     }
     if (pageContextAbort._urlRedirect) {
-        const pageContextReturn = createPageContext(pageContextInit);
+        const pageContextReturn = createPageContext(pageContextInit, false);
         objectAssign(pageContextReturn, pageContextAbort);
         const httpResponse = createHttpResponseRedirect(pageContextAbort._urlRedirect, pageContextInit);
         objectAssign(pageContextReturn, { httpResponse });
@@ -444,7 +429,7 @@ async function checkBaseUrl(pageContextInit, globalContext) {
     const { isBaseMissing } = parseUrl(urlOriginal, baseServer);
     if (!isBaseMissing)
         return;
-    const pageContext = createPageContext(pageContextInit);
+    const pageContext = createPageContext(pageContextInit, false);
     const httpResponse = createHttpResponseBaseIsMissing(urlOriginal, baseServer);
     objectAssign(pageContext, {
         httpResponse,
@@ -457,7 +442,7 @@ function renderInvalidRequest(pageContextInit) {
     const urlPathnameWithBase = parseUrl(pageContextInit.urlOriginal, '/').pathname;
     assertIsNotViteRequest(urlPathnameWithBase, pageContextInit.urlOriginal);
     if (urlPathnameWithBase.endsWith('/favicon.ico')) {
-        const pageContext = createPageContext(pageContextInit);
+        const pageContext = createPageContext(pageContextInit, false);
         const httpResponse = createHttpResponseFavicon404();
         objectAssign(pageContext, { httpResponse });
         checkType(pageContext);

package/dist/esm/shared/NOT_SERIALIZABLE.d.ts

@@ -0,0 +1 @@
+export declare const NOT_SERIALIZABLE = "__VIKE__NOT_SERIALIZABLE__";

package/dist/esm/shared/NOT_SERIALIZABLE.js

@@ -0,0 +1,2 @@
+// TODO: move to ../node/runtime/html/NOT_SERIALIZABLE.ts once code is distributed as ESM
+export const NOT_SERIALIZABLE = '__VIKE__NOT_SERIALIZABLE__';

package/dist/esm/shared/page-configs/Config.d.ts

@@ -299,13 +299,15 @@ type ConfigBuiltIn = {
         /**
          * Whether to enable pre-rendering.
          *
-         * Setting `value: null` enables you to set prerender settings without activating pre-rendering. (Useful for Vike extensions.)
+         * Setting `enable: null` enables you to set prerender settings without enabling pre-rendering by default.
          *
-         * https://vike.dev/prerender#value
+         * This is useful, for example, if you want pre-rendering to stay opt-in instead of opt-out while setting pre-render settings globally.
+         *
+         * https://vike.dev/prerender#enable
          *
          * @default true
          */
-        value?: boolean | null;
+        enable?: boolean | null;
     };
     /**
      * Install Vike extensions.

package/dist/esm/shared/page-configs/PageConfig.d.ts

@@ -97,7 +97,7 @@ type ConfigValueSource = {
     locationId: LocationId;
     /** Wether the config value is loaded at runtime, for example config.Page or config.onBeforeRender */
     valueIsLoadedWithImport: boolean;
-    /** Whether the config value is a file path, for example config.client */
+    /** Whether the config value is a file path, this is currently only true for +client */
     valueIsFilePath?: true;
     /** Whether the config value is defined by a +{configName}.js file */
     valueIsDefinedByPlusValueFile: boolean;

package/dist/esm/shared/route/abort.d.ts

@@ -100,9 +100,9 @@ declare function logAbortErrorHandled(err: ErrorAbort, isProduction: boolean, pa
 }): void;
 type PageContextFromRewrite = {
     _urlRewrite: string;
-} & Record<string, unknown>;
+};
 type PageContextFromAllRewrites = {
     _urlRewrite: null | string;
-} & Record<string, unknown>;
+};
 declare function getPageContextFromAllRewrites(pageContextsFromRewrite: PageContextFromRewrite[]): PageContextFromAllRewrites;
 declare function assertNoInfiniteAbortLoop(rewriteCount: number, redirectCount: number): void;

package/dist/esm/shared/types.d.ts

@@ -139,11 +139,26 @@ type PageContextBuiltInCommon<Data> = {
     isBaseMissing?: true;
 };
 type PageContextBuiltInServer<Data> = PageContextBuiltInCommon<Data> & PageContextUrlServer & {
+    /**
+     * Whether the page is being rendered on the client-side, or rendered on the server-side / pre-rendered.
+     *
+     * In order to save client-side KBs, we recommend using `import.meta.env.SSR` whenever possible instead, see https://vike.dev/pageContext
+     */
+    isClientSide: false;
+    /**
+     * Whether the page is being pre-rendered.
+     *
+     * The value is always `false` in development.
+     *
+     * https://vike.dev/pre-rendering
+     * https://vike.dev/pageContext
+     */
+    isPrerendering: boolean;
     isHydration?: undefined;
     isBackwardNavigation?: undefined;
     previousPageContext?: undefined;
 };
-type PageContextBuiltInClientWithClientRouting<Data> = Partial<PageContextBuiltInCommon<Data>> & Pick<PageContextBuiltInCommon<Data>, 'Page' | 'routeParams' | 'pageExports' | 'config' | 'configEntries' | 'exports' | 'exportsAll' | 'abortReason' | 'data' | 'pageId' | 'source' | 'sources' | 'from'> & {
+type PageContextBuiltInClientWithClientRouting<Data> = Partial<PageContextBuiltInCommon<Data>> & Pick<PageContextBuiltInCommon<Data>, 'Page' | 'routeParams' | 'pageExports' | 'config' | 'configEntries' | 'exports' | 'exportsAll' | 'abortReason' | 'data' | 'pageId' | 'source' | 'sources' | 'from'> & PageContextClientCommon & {
     /** Whether the current page is already rendered to HTML */
     isHydration: boolean;
     /**
@@ -159,7 +174,7 @@ type PageContextBuiltInClientWithClientRouting<Data> = Partial<PageContextBuiltI
      */
     previousPageContext: PageContextClient<Data> | null;
 } & PageContextUrlClient;
-type PageContextBuiltInClientWithServerRouting<Data> = Partial<PageContextBuiltInCommon<Data>> & Pick<PageContextBuiltInCommon<Data>, 'Page' | 'pageExports' | 'exports' | 'abortReason' | 'pageId' | 'data'> & {
+type PageContextBuiltInClientWithServerRouting<Data> = Partial<PageContextBuiltInCommon<Data>> & Pick<PageContextBuiltInCommon<Data>, 'Page' | 'pageExports' | 'exports' | 'abortReason' | 'pageId' | 'data'> & PageContextClientCommon & {
     /**
      * Whether the current page is already rendered to HTML.
      *
@@ -173,6 +188,23 @@ type PageContextBuiltInClientWithServerRouting<Data> = Partial<PageContextBuiltI
      */
     isBackwardNavigation: null;
 };
+type PageContextClientCommon = {
+    /**
+     * Whether the page is being rendered on the client-side, or rendered on the server-side / pre-rendered.
+     *
+     * In order to save client-side KBs, we recommend using `import.meta.env.SSR` whenever possible instead, see https://vike.dev/pageContext
+     */
+    isClientSide: true;
+    /**
+     * Whether the page is being pre-rendered.
+     *
+     * The value is always `false` in development.
+     *
+     * https://vike.dev/pre-rendering
+     * https://vike.dev/pageContext
+     */
+    isPrerendering: false;
+};
 /** For Vike internal use */
 type PageContextBuiltInServerInternal = Omit<PageContextBuiltInCommon<unknown> & PageContextUrlInternal, 'data'>;
 /** @deprecated

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

@@ -1 +1 @@
-export declare const PROJECT_VERSION: "0.4.225-commit-37a36a5";
+export declare const PROJECT_VERSION: "0.4.225-commit-2b7971f";

package/dist/esm/utils/PROJECT_VERSION.js

@@ -1,2 +1,2 @@
 // Automatically updated by @brillout/release-me
-export const PROJECT_VERSION = '0.4.225-commit-37a36a5';
+export const PROJECT_VERSION = '0.4.225-commit-2b7971f';

package/dist/esm/utils/assert.js

@@ -42,7 +42,7 @@ function assert(condition, debugInfo) {
         const debugInfoSerialized = typeof debugInfo === 'string' ? debugInfo : JSON.stringify(debugInfo);
         return pc.dim(`Debug info (for Vike maintainers; you can ignore this): ${debugInfoSerialized}`);
     })();
-    const link = pc.blue('https://github.com/vikejs/vike/issues/new?template=bug.yml');
+    const link = pc.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

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

@@ -1,2 +1,2 @@
 export { objectAssign };
-declare function objectAssign<Obj extends object, ObjAddendum extends object | null>(obj: Obj, objAddendum: ObjAddendum): asserts obj is Obj & ObjAddendum;
+declare function objectAssign<Obj extends object, ObjAddendum extends object | null>(obj: Obj, objAddendum: ObjAddendum, objAddendumCanBePageContextObject?: true): asserts obj is Obj & ObjAddendum;

package/dist/esm/utils/objectAssign.js

@@ -3,9 +3,14 @@ import { assert } from './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) {
-        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.
+            assert(!('_isPageContextObject' in objAddendum));
+        }
         Object.defineProperties(obj, Object.getOwnPropertyDescriptors(objAddendum));
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vike",
-  "version": "0.4.225-commit-37a36a5",
+  "version": "0.4.225-commit-2b7971f",
   "repository": "https://github.com/vikejs/vike",
   "exports": {
     "./server": {

package/dist/cjs/shared/notSerializable.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.notSerializable = void 0;
-// TODO: move to ../node/runtime/html/notSerializable.ts once code is distributed as ESM
-exports.notSerializable = 'not-serializable';

package/dist/esm/shared/notSerializable.d.ts

@@ -1 +0,0 @@
-export declare const notSerializable = "not-serializable";

package/dist/esm/shared/notSerializable.js

@@ -1,2 +0,0 @@
-// TODO: move to ../node/runtime/html/notSerializable.ts once code is distributed as ESM
-export const notSerializable = 'not-serializable';