vike 0.4.235 → 0.4.236-commit-85d361d

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

@@ -13,7 +13,7 @@ export { setGlobalContext_viteDevServer };
 export { setGlobalContext_viteConfig };
 export { setGlobalContext_isPrerendering };
 export { setGlobalContext_isProduction };
-export { setGlobalContext_buildEntry };
+export { setGlobalContext_buildEntry }; // production entry
 export { clearGlobalContext };
 export { assertBuildInfo };
 export { updateUserFiles };
@@ -30,7 +30,7 @@ import { assert, onSetupRuntime, assertUsage, assertWarning, isPlainObject, obje
 import { importServerProductionEntry } from '@brillout/vite-plugin-server-entry/runtime';
 import { virtualFileIdEntryServer } from '../shared/virtualFiles/virtualFileEntry.js';
 import pc from '@brillout/picocolors';
-import { loadPageRoutes } from '../../shared/route/loadPageRoutes.js';
+import { loadPageRoutes, loadPageRoutesSync } from '../../shared/route/loadPageRoutes.js';
 import { assertV1Design } from '../shared/assertV1Design.js';
 import { resolveBase } from '../shared/resolveBase.js';
 import { createGlobalContextShared, getGlobalContextSyncErrMsg, } from '../../shared/createGlobalContextShared.js';
@@ -39,7 +39,7 @@ import { logRuntimeError, logRuntimeInfo } from './loggerRuntime.js';
 import { getVikeConfigErrorBuild, setVikeConfigError } from '../shared/getVikeConfigError.js';
 import { hasAlreadyLogged } from './renderPage/isNewError.js';
 const debug = createDebugger('vike:globalContext');
-const globalObject = getGlobalObject('runtime/globalContext.ts', getInitialGlobalContext());
+const globalObject = getGlobalObject('runtime/globalContext.ts', getInitialGlobalObject());
 // Trick to break down TypeScript circular dependency
 // https://chat.deepseek.com/a/chat/s/d7e9f90a-c7f3-4108-9cd5-4ad6caed3539
 const globalObjectTyped = globalObject;
@@ -99,17 +99,19 @@ async function getGlobalContextAsync(isProduction) {
  * Get runtime information about your app.
  *
  * https://vike.dev/getGlobalContext
- *
- * @deprecated
  */
 function getGlobalContextSync() {
     debug('getGlobalContextSync()');
     const { globalContext } = globalObjectTyped;
     assertUsage(globalContext, getGlobalContextSyncErrMsg);
-    assertWarning(false, 
-    // We discourage users from using it because `pageContext.globalContext` is safer: I ain't sure but there could be race conditions when using `getGlobalContextSync()` inside React/Vue components upon HMR.
-    // We're lying about "is going to be deprecated in the next major release": let's keep it and see if users need it (so far I can't see a use case for it).
-    'getGlobalContextSync() is going to be deprecated in the next major release, see https://vike.dev/getGlobalContext', { onlyOnce: true });
+    const isProd = globalContext._isProduction;
+    assert(typeof isProd === 'boolean');
+    assertWarning(isProd, 
+    // - We discourage users from using it in development because `pageContext.globalContext` is safer: I ain't sure but there could be race conditions when using `getGlobalContextSync()` inside React/Vue components upon HMR.
+    // - I don't see any issues with getGlobalContextSync() in production.
+    // - getGlobalContextSync() is used in production by vike-vercel
+    //   - https://discord.com/channels/@me/942519153502339072/1389546794676916344 (PM between Rom and Joël)
+    "getGlobalContextSync() shouldn't be used in development, see https://vike.dev/getGlobalContext", { onlyOnce: true });
     return getGlobalContextForPublicUsage();
 }
 function getGlobalContextForPublicUsage() {
@@ -148,7 +150,9 @@ function setGlobalContext_isPrerendering() {
     globalObject.isPrerendering = true;
     setIsProduction(true);
 }
-function setGlobalContext_isProduction(isProduction, tolerateContraditction) {
+function setGlobalContext_isProduction(isProduction, tolerateContraditction = false) {
+    if (debug.isActivated)
+        debug('setGlobalContext_isProduction()', { isProduction, tolerateContraditction });
     if (globalObject.isProduction === undefined) {
         setIsProduction(isProduction);
     }
@@ -230,6 +234,7 @@ function assertViteManifest(manifest) {
 async function loadBuildEntry(outDir) {
     debug('loadBuildEntry()');
     if (globalObject.globalContext) {
+        debug('loadBuildEntry() - already done');
         return;
     }
     if (!globalObject.buildEntry) {
@@ -255,6 +260,8 @@ async function loadBuildEntry(outDir) {
     globalObject.buildInfo = buildEntry.buildInfo;
     await setGlobalContext(buildEntry.virtualFileExports);
 }
+// This is the production entry, see:
+// https://github.com/vikejs/vike/blob/798e5465dc3e3e6723b38b601a50350c0a006fb8/packages/vike/node/vite/plugins/pluginBuild/pluginBuildEntry.ts#L47
 async function setGlobalContext_buildEntry(buildEntry) {
     debug('setGlobalContext_buildEntry()');
     setIsProduction(true);
@@ -264,6 +271,7 @@ async function setGlobalContext_buildEntry(buildEntry) {
     assert(globalObject.buildEntry); // ensure no infinite loop
     await loadBuildEntry();
     assertGlobalContextIsDefined();
+    debug('setGlobalContext_buildEntry() - done');
 }
 function assertBuildEntry(buildEntry) {
     assert(isObject(buildEntry));
@@ -360,18 +368,29 @@ async function updateUserFiles() {
     return onSuccess();
 }
 async function setGlobalContext(virtualFileExports) {
+    debug('setGlobalContext()');
     assert(!getVikeConfigErrorBuild());
-    const globalContext = await createGlobalContextShared(virtualFileExports, globalObject, addGlobalContext);
+    const globalContext = await createGlobalContextShared(virtualFileExports, globalObject, addGlobalContextAsync, addGlobalContextSync);
     assertV1Design(
     // pageConfigs is PageConfigRuntime[] but assertV1Design() requires PageConfigBuildTime[]
     globalContext._pageConfigs.length > 0, globalContext._pageFilesAll);
     assertGlobalContextIsDefined();
     onSetupRuntime();
+    debug('setGlobalContext() - done');
     // Never actually used, only used for TypeScript `ReturnType<typeof setGlobalContext>`
     return globalContext;
 }
-async function addGlobalContext(globalContext) {
+async function addGlobalContextAsync(globalContext) {
+    debug('addGlobalContextAsync()');
     const { pageRoutes, onBeforeRouteHook } = await loadPageRoutes(globalContext._pageFilesAll, globalContext._pageConfigs, globalContext._pageConfigGlobal, globalContext._allPageIds);
+    return addGlobalContextCommon(globalContext, pageRoutes, onBeforeRouteHook);
+}
+function addGlobalContextSync(globalContext) {
+    debug('addGlobalContextSync()');
+    const { pageRoutes, onBeforeRouteHook } = loadPageRoutesSync(globalContext._pageFilesAll, globalContext._pageConfigs, globalContext._pageConfigGlobal, globalContext._allPageIds);
+    return addGlobalContextCommon(globalContext, pageRoutes, onBeforeRouteHook);
+}
+function addGlobalContextCommon(globalContext, pageRoutes, onBeforeRouteHook) {
     const globalContextBase = {
         isClientSide: false,
         _pageRoutes: pageRoutes,
@@ -430,10 +449,10 @@ async function addGlobalContext(globalContext) {
 }
 function clearGlobalContext() {
     debug('clearGlobalContext()');
-    objectReplace(globalObject, getInitialGlobalContext(), ['buildEntryPrevious']);
+    objectReplace(globalObject, getInitialGlobalObject(), ['buildEntryPrevious']);
 }
-function getInitialGlobalContext() {
-    debug('getInitialGlobalContext()');
+function getInitialGlobalObject() {
+    debug('getInitialGlobalObject()');
     const { promise: viteDevServerPromise, resolve: viteDevServerPromiseResolve } = genPromise();
     return {
         viteDevServerPromise,

package/dist/esm/node/runtime/html/injectAssets/injectAssets__public.js

@@ -1,7 +1,7 @@
 export { injectAssets__public };
 import { assertUsage, assertWarning, castProp, hasProp } from '../../utils.js';
 import { injectHtmlTagsToString } from '../injectAssets.js';
-// TODO/v1-release: remove
+// TO-DO/next-major-release: remove
 async function injectAssets__public(htmlString, pageContext) {
     assertWarning(false, '`_injectAssets()` is deprecated and will be removed.', { onlyOnce: true, showStackTrace: true });
     assertUsage(typeof htmlString === 'string', '[injectAssets(htmlString, pageContext)]: Argument `htmlString` should be a string.', { showStackTrace: true });

package/dist/esm/node/runtime/html/injectAssets/injectHtmlTags.js

@@ -149,6 +149,8 @@ function getTagClosing(tag) {
     return tagClosing;
 }
 function injectAtPlaceholder(htmlFragment, htmlString, isFirst) {
+    // TO-DO/eventually: soft deprecate in favor of https://github.com/vikejs/vike/issues/695
+    // Used by BurdaForward https://github.com/vikejs/vike/discussions/2528#discussioncomment-13637156
     const placeholder = isFirst ? '__VITE_PLUGIN_SSR__ASSETS_FIRST__' : '__VITE_PLUGIN__SSR_ASSETS_LAST__';
     const parts = htmlString.split(placeholder);
     if (parts.length === 1)

package/dist/esm/node/runtime/html/serializeContext.d.ts

@@ -2,19 +2,25 @@ export { getPageContextClientSerialized };
 export { getPageContextClientSerializedAbort };
 export { getGlobalContextClientSerialized };
 export type { PageContextSerialization };
+export type { PassToClient };
 import type { UrlRedirect } from '../../../shared/route/abort.js';
 import type { GlobalContextServerInternal } from '../globalContext.js';
 type PageContextSerialization = {
     pageId: string;
     routeParams: Record<string, string>;
-    _passToClient: string[];
+    _passToClient: PassToClient;
     is404: null | boolean;
     pageProps?: Record<string, unknown>;
     _pageContextInit: Record<string, unknown>;
     _globalContext: GlobalContextServerInternal;
+    isClientSideNavigation: boolean;
 };
 declare function getPageContextClientSerialized(pageContext: PageContextSerialization): string;
 declare function getGlobalContextClientSerialized(pageContext: PageContextSerialization): string;
+type PassToClient = (string | {
+    prop: string;
+    once?: boolean;
+})[];
 declare function getPageContextClientSerializedAbort(pageContext: Record<string, unknown> & ({
     _urlRedirect: UrlRedirect;
 } | {

package/dist/esm/node/runtime/html/serializeContext.js

@@ -27,20 +27,41 @@ const passToClientBuiltInPageContext = [
 const pageToClientBuiltInPageContextError = ['pageProps', 'is404', isServerSideError];
 function getPageContextClientSerialized(pageContext) {
     const passToClientPageContext = getPassToClientPageContext(pageContext);
-    const pageContextClient = applyPassToClient(passToClientPageContext, pageContext);
-    if (passToClientPageContext.some((prop) => getPropVal(pageContext._pageContextInit, prop))) {
+    const getObj = (passToClientEntry) => {
+        if (passToClientEntry.once)
+            return undefined; // pass it to client-side globalContext
+        return { obj: pageContext, objName: 'pageContext' };
+    };
+    const res = applyPassToClient(passToClientPageContext, getObj);
+    const pageContextClient = res.objClient;
+    const pageContextClientProps = res.objClientProps;
+    if (pageContextClientProps.some((prop) => getPropVal(pageContext._pageContextInit, prop))) {
         pageContextClient[pageContextInitIsPassedToClient] = true;
     }
-    const pageContextClientSerialized = serializeObject(pageContextClient, 'pageContext', passToClientPageContext);
+    const pageContextClientSerialized = serializeObject(pageContextClient, passToClientPageContext, getObj);
     return pageContextClientSerialized;
 }
 function getGlobalContextClientSerialized(pageContext) {
     const passToClient = pageContext._passToClient;
-    const globalContextClient = applyPassToClient(passToClient, pageContext._globalContext);
-    const globalContextClientSerialized = serializeObject(globalContextClient, 'globalContext', passToClient);
+    const globalContext = pageContext._globalContext;
+    const getObj = ({ prop, once }) => {
+        if (once && getPropVal(pageContext, prop)) {
+            assert(typeof pageContext.isClientSideNavigation === 'boolean');
+            if (!pageContext.isClientSideNavigation) {
+                return { obj: pageContext, objName: 'pageContext' }; // pass it to client-side globalContext
+            }
+            else {
+                return undefined; // already passed to client-side
+            }
+        }
+        return { obj: globalContext, objName: 'globalContext' };
+    };
+    const res = applyPassToClient(passToClient, getObj);
+    const globalContextClient = res.objClient;
+    const globalContextClientSerialized = serializeObject(globalContextClient, passToClient, getObj);
     return globalContextClientSerialized;
 }
-function serializeObject(obj, objName, passToClient) {
+function serializeObject(obj, passToClient, getObj) {
     let serialized;
     try {
         serialized = serializeValue(obj);
@@ -49,11 +70,15 @@ function serializeObject(obj, objName, passToClient) {
         const h = (s) => pc.cyan(s);
         let hasWarned = false;
         const propsNonSerializable = [];
-        passToClient.forEach((prop) => {
+        passToClient.forEach((entry) => {
+            const entryNormalized = normalizePassToClientEntry(entry);
+            const { prop } = entryNormalized;
             const res = getPropVal(obj, prop);
             if (!res)
                 return;
             const { value } = res;
+            const { objName } = getObj(entryNormalized) ?? {};
+            assert(objName);
             const varName = `${objName}${getPropKeys(prop).map(getPropAccessNotation).join('')}`;
             try {
                 serializeValue(value, varName);
@@ -103,7 +128,20 @@ function serializeObject(obj, objName, passToClient) {
     return serialized;
 }
 function serializeValue(value, varName) {
-    return stringify(value, { forbidReactElements: true, valueName: varName });
+    return stringify(value, {
+        forbidReactElements: true,
+        valueName: varName,
+        // Prevent Google from crawling URLs in JSON:
+        //  - https://github.com/vikejs/vike/discussions/2541#discussioncomment-13660198
+        //  - https://github.com/vikejs/vike/discussions/2277
+        //  - https://github.com/vikejs/vike/pull/2542
+        replacer(_key, value) {
+            if (typeof value === 'string' && value.startsWith('/')) {
+                // No need to use a reviver: https://github.com/brillout/json-serializer/blob/70fc8ed3741306391b51655b05df24e6963d1fdb/test/main.spec.ts#L74-L80
+                return { replacement: (value = '!' + value) };
+            }
+        },
+    });
 }
 function getPassToClientPageContext(pageContext) {
     let passToClient = [...pageContext._passToClient, ...passToClientBuiltInPageContext];
@@ -139,7 +177,7 @@ function getPageContextClientSerializedAbort(pageContext) {
         assert(unknownProps.length === 0);
     }
     else {
-        // TODO/v1-release: remove
+        // TO-DO/next-major-release: remove
         assertWarning(unknownProps.length === 0, [
             "The following pageContext values won't be available on the client-side:",
             unknownProps.map((p) => `  pageContext[${JSON.stringify(p)}]`),
@@ -150,16 +188,36 @@ function getPageContextClientSerializedAbort(pageContext) {
     }
     return serializeValue(pageContext);
 }
-function applyPassToClient(passToClient, pageContext) {
-    const pageContextClient = {};
-    passToClient.forEach((prop) => {
+function applyPassToClient(passToClient, getObj) {
+    const objClient = {};
+    const objClientProps = [];
+    passToClient.forEach((entry) => {
+        const entryNormalized = normalizePassToClientEntry(entry);
+        const { prop } = entryNormalized;
+        const { obj } = getObj(entryNormalized) ?? {};
+        if (!obj)
+            return;
         // Get value from pageContext
-        const res = getPropVal(pageContext, prop);
+        const res = getPropVal(obj, prop);
         if (!res)
             return;
         const { value } = res;
         // Set value to pageContextClient
-        setPropVal(pageContextClient, prop, value);
+        setPropVal(objClient, prop, value);
+        objClientProps.push(prop);
     });
-    return pageContextClient;
+    return { objClient, objClientProps };
+}
+function normalizePassToClientEntry(entry) {
+    let once;
+    let prop;
+    if (typeof entry === 'string') {
+        prop = entry;
+        once = false;
+    }
+    else {
+        prop = entry.prop;
+        once = entry.once ?? false;
+    }
+    return { prop, once };
 }

package/dist/esm/node/runtime/index-deprecated.js

@@ -1,4 +1,4 @@
-// TO-DO/soon: point package.json#exports['./server'] to this file.
+// TO-DO/eventually: point package.json#exports['./server'] to this file.
 // - Write migration guide, see comment below.
 export * from './index.js';
 import { assertWarning } from './utils.js';

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

@@ -7,7 +7,7 @@ export { pipeWebStream, pipeNodeStream, pipeStream, stampPipe } from './html/str
 export { PROJECT_VERSION as version } from './utils.js';
 export { getGlobalContext, getGlobalContextSync, getGlobalContextAsync } from './globalContext.js';
 export { createDevMiddleware } from '../runtime-dev/index.js';
-// TODO/v1-release: remove
+// TO-DO/next-major-release: remove
 // Deprecated exports
 export * from '../../types/index-dreprecated.js';
 export { injectAssets__public as _injectAssets } from './html/injectAssets/injectAssets__public.js';

package/dist/esm/node/runtime/page-files/setup.js

@@ -1,3 +1,3 @@
 export {};
-// TODO/v1-release: remove https://github.com/vikejs/vike/issues/2122
+// TO-DO/next-major-release: remove https://github.com/vikejs/vike/issues/2122
 // This doesn't do anything anymore. (It's kept to avoid introducing a breaking change.)

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

@@ -10,7 +10,7 @@ function assertArguments(...args) {
         showStackTrace: true,
     });
     assertUsage(isObject(pageContextInit), `${prefix} called with ${pc.code(`typeof pageContextInit === ${JSON.stringify(typeof pageContextInit)}`)} but ${pc.code('pageContextInit')} should be an object.`, { showStackTrace: true });
-    // TODO/v1-release: remove
+    // TO-DO/next-major-release: remove
     if ('url' in pageContextInit) {
         assertWarning(false, '`pageContextInit.url` has been renamed to `pageContextInit.urlOriginal`: replace `renderPage({ url })` with `renderPage({ urlOriginal })`. (See https://vike.dev/migration/0.4.23 for more information.)', { showStackTrace: true, onlyOnce: true });
         pageContextInit.urlOriginal = pageContextInit.url;

package/dist/esm/node/runtime/renderPage/createHttpResponse.d.ts

@@ -28,6 +28,7 @@ declare function createHttpResponsePage(htmlRender: HtmlRender, renderHook: null
     __getPageAssets: GetPageAssets;
     _globalContext: GlobalContextServerInternal;
     abortStatusCode?: AbortStatusCode;
+    headersResponse?: Headers;
 }): Promise<HttpResponse>;
 declare function createHttpResponse404(errMsg404: string): HttpResponse;
 declare function createHttpResponseBaseIsMissing(urlOriginal: string, baseServer: string): HttpResponse;

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

@@ -9,8 +9,8 @@ import { assert, assertWarning, escapeHtml } from '../utils.js';
 import { getErrorPageId, isErrorPage } from '../../../shared/error-page.js';
 import { getHttpResponseBody, getHttpResponseBodyStreamHandlers } from './getHttpResponseBody.js';
 import { getEarlyHints } from './getEarlyHints.js';
-import { getCacheControl } from './createHttpResponse/getCacheControl.js';
 import { assertNoInfiniteHttpRedirect } from './createHttpResponse/assertNoInfiniteHttpRedirect.js';
+import { cacheControlDisable } from './getCacheControl.js';
 async function createHttpResponsePage(htmlRender, renderHook, pageContext) {
     let statusCode = pageContext.abortStatusCode;
     if (!statusCode) {
@@ -29,10 +29,13 @@ async function createHttpResponsePage(htmlRender, renderHook, pageContext) {
     }
     const earlyHints = getEarlyHints(await pageContext.__getPageAssets());
     const headers = [];
-    const cacheControl = getCacheControl(pageContext.pageId, pageContext._globalContext._pageConfigs, statusCode);
-    if (cacheControl) {
-        headers.push(['Cache-Control', cacheControl]);
-    }
+    const headersResponse = pageContext.headersResponse || new Headers();
+    headersResponse.forEach((value, key) => {
+        headers.push([key, value]);
+    });
+    // An 5xx error page shouldn't be cached (it should be temporary)
+    if (statusCode >= 500)
+        headersResponse.set('Cache-Control', cacheControlDisable);
     return createHttpResponse(statusCode, 'text/html;charset=utf-8', headers, htmlRender, earlyHints, renderHook);
 }
 function createHttpResponse404(errMsg404) {
@@ -102,7 +105,7 @@ function createHttpResponse(statusCode, contentType, headers, htmlRender, earlyH
     return {
         statusCode,
         headers,
-        // TODO/v1-release: remove
+        // TO-DO/next-major-release: remove
         get contentType() {
             assertWarning(false, 'pageContext.httpResponse.contentType is deprecated and will be removed in the next major release. Use pageContext.httpResponse.headers instead, see https://vike.dev/migration/0.4.134', { onlyOnce: true });
             return contentType;

package/dist/esm/node/runtime/renderPage/createPageContextServerSide.d.ts

@@ -13,7 +13,7 @@ declare function createPageContextServerSide(pageContextInit: PageContextInit, g
 } | {
     isPrerendering: true;
     ssr?: undefined;
-}): Promise<{
+}): {
     _isOriginalObject: true;
     isPageContext: true;
 } & {
@@ -125,7 +125,7 @@ declare function createPageContextServerSide(pageContextInit: PageContextInit, g
     url: string;
 } & {
     headers: Record<string, string> | null;
-}>;
+};
 declare function createPageContextServerSideWithoutGlobalContext(pageContextInit: PageContextInit): {
     _isOriginalObject: true;
     isPageContext: true;

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

@@ -3,7 +3,7 @@ export { createPageContextServerSideWithoutGlobalContext };
 import { assert, assertUsage, assertWarning, augmentType, normalizeHeaders, objectAssign } from '../utils.js';
 import { getPageContextUrlComputed } from '../../../shared/getPageContextUrlComputed.js';
 import { createPageContextObject, createPageContextShared } from '../../../shared/createPageContextShared.js';
-async function createPageContextServerSide(pageContextInit, globalContext, { isPrerendering, ssr: { urlHandler, isClientSideNavigation } = {
+function createPageContextServerSide(pageContextInit, globalContext, { isPrerendering, ssr: { urlHandler, isClientSideNavigation } = {
     urlHandler: null,
     isClientSideNavigation: false,
 }, }) {
@@ -11,7 +11,7 @@ async function createPageContextServerSide(pageContextInit, globalContext, { isP
     const pageContextCreated = createPageContext(pageContextInit, isPrerendering);
     objectAssign(pageContextCreated, {
         _globalContext: globalContext,
-        _pageFilesAll: globalContext._pageFilesAll, // TODO/v1-release: remove
+        _pageFilesAll: globalContext._pageFilesAll, // TO-DO/next-major-release: remove
         // We use pageContext._baseServer and pageContext._baseAssets instead of pageContext._globalContext.baseServer and pageContext._globalContext.baseAssets because the Base URLs can (eventually one day if needed) be made non-global
         _baseServer: globalContext.baseServer,
         _baseAssets: globalContext.baseAssets,
@@ -33,7 +33,7 @@ async function createPageContextServerSide(pageContextInit, globalContext, { isP
         }
         else if (pageContextInit.headers) {
             headers = pageContextInit.headers;
-            // TODO/next-major-release: remove
+            // TO-DO/next-major-release: remove
             assertWarning(false, 'Setting pageContextInit.headers is deprecated: set pageContextInit.headersOriginal instead, see https://vike.dev/headers', { onlyOnce: true });
         }
         else {
@@ -41,7 +41,7 @@ async function createPageContextServerSide(pageContextInit, globalContext, { isP
         }
         objectAssign(pageContextCreated, { headers });
     }
-    const pageContextAugmented = await createPageContextShared(pageContextCreated, globalContext._pageConfigGlobal, globalContext._vikeConfigPublicGlobal);
+    const pageContextAugmented = createPageContextShared(pageContextCreated, globalContext._vikeConfigPublicGlobal);
     augmentType(pageContextCreated, pageContextAugmented);
     return pageContextCreated;
 }

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

@@ -6,7 +6,7 @@ async function execHookDataAndOnBeforeRender(pageContext) {
         return;
     }
     const hooks = await execHookServer('data', pageContext);
-    const dataHook = hooks[0]; // TO-DO/soon: support cumulative
+    const dataHook = hooks[0]; // TO-DO/soon/cumulative-hooks: support cumulative
     if (dataHook) {
         // Note: hookReturn can be anything (e.g. an object) and is to be assigned to pageContext.data
         const pageContextFromHook = {
@@ -19,7 +19,7 @@ async function execHookDataAndOnBeforeRender(pageContext) {
         }
     }
     const res = await execHookServer('onBeforeRender', pageContext);
-    const onBeforeRenderHook = res[0]; // TO-DO/soon: support cumulative
+    const onBeforeRenderHook = res[0]; // TO-DO/soon/cumulative-hooks: support cumulative
     if (onBeforeRenderHook) {
         const { hookReturn } = onBeforeRenderHook;
         assertOnBeforeRenderHookReturn(hookReturn, onBeforeRenderHook.hookFilePath);

package/dist/esm/node/runtime/renderPage/getCacheControl.d.ts

@@ -0,0 +1,5 @@
+export { getCacheControl };
+export { cacheControlDisable };
+import type { PageConfigRuntime } from '../../../types/PageConfig.js';
+declare const cacheControlDisable = "no-store, max-age=0";
+declare function getCacheControl(pageId: string | null, pageConfigs: PageConfigRuntime[]): string;

package/dist/esm/node/runtime/renderPage/{createHttpResponse/getCacheControl.js → getCacheControl.js}

@@ -1,13 +1,12 @@
 export { getCacheControl };
-import { getPageConfig } from '../../../../shared/page-configs/helpers.js';
-import { getConfigValueRuntime } from '../../../../shared/page-configs/getConfigValueRuntime.js';
-const defaultValue = 'no-store, max-age=0';
-function getCacheControl(pageId, pageConfigs, statusCode) {
-    // TODO/v1-release: remove
+export { cacheControlDisable };
+import { getPageConfig } from '../../../shared/page-configs/helpers.js';
+import { getConfigValueRuntime } from '../../../shared/page-configs/getConfigValueRuntime.js';
+const cacheControlDisable = 'no-store, max-age=0';
+function getCacheControl(pageId, pageConfigs) {
+    // TO-DO/next-major-release: remove this line
     if (pageConfigs.length === 0)
-        return defaultValue;
-    if (statusCode > 499)
-        return defaultValue;
+        return cacheControlDisable;
     if (pageId) {
         const pageConfig = getPageConfig(pageId, pageConfigs);
         const configValue = getConfigValueRuntime(pageConfig, 'cacheControl', 'string');
@@ -18,5 +17,5 @@ function getCacheControl(pageId, pageConfigs, statusCode) {
     // - Disabling caching by default is the safest strategy, because caching is problematic with authentication as described in https://github.com/vikejs/vike/issues/1275#issuecomment-1824366875
     // - Are there use cases when we don't need to disable caching?
     //   - When there isn't any <script id="vike_pageContext" type="application/json"> then we can safely have caching. (We don't implement this exception because we're lazy and it's quite a rare situation.)
-    return defaultValue;
+    return cacheControlDisable;
 }

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

@@ -56,7 +56,7 @@ function getHttpResponseBodyStreamHandlers(htmlRender, renderHook) {
             const body = await getHtmlString(htmlRender);
             return body;
         },
-        // TODO/v1-release: remove
+        // TO-DO/next-major-release: remove
         async getNodeStream() {
             assertWarning(false, '`pageContext.httpResponse.getNodeStream()` is outdated, use `pageContext.httpResponse.getReadableNodeStream()` instead. ' +
                 streamDocs, { onlyOnce: true, showStackTrace: true });
@@ -66,7 +66,7 @@ function getHttpResponseBodyStreamHandlers(htmlRender, renderHook) {
             }
             return nodeStream;
         },
-        // TODO/v1-release: remove
+        // TO-DO/next-major-release: remove
         getWebStream() {
             assertWarning(false, '`pageContext.httpResponse.getWebStream(res)` is outdated, use `pageContext.httpResponse.getReadableWebStream(res)` instead. ' +
                 streamDocs, { onlyOnce: true, showStackTrace: true });
@@ -76,7 +76,7 @@ function getHttpResponseBodyStreamHandlers(htmlRender, renderHook) {
             }
             return webStream;
         },
-        // TODO/v1-release: remove
+        // TO-DO/next-major-release: remove
         pipeToWebWritable(writable) {
             assertWarning(false, '`pageContext.httpResponse.pipeToWebWritable(res)` is outdated, use `pageContext.httpResponse.pipe(res)` instead. ' +
                 streamDocs, { onlyOnce: true, showStackTrace: true });
@@ -85,7 +85,7 @@ function getHttpResponseBodyStreamHandlers(htmlRender, renderHook) {
                 assertUsage(false, getErrMsg(htmlRender, renderHook, 'pipeToWebWritable()'));
             }
         },
-        // TODO/v1-release: remove
+        // TO-DO/next-major-release: remove
         pipeToNodeWritable(writable) {
             assertWarning(false, '`pageContext.httpResponse.pipeToNodeWritable(res)` is outdated, use `pageContext.httpResponse.pipe(res)` instead. ' +
                 streamDocs, { onlyOnce: true, showStackTrace: true });

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

@@ -9,7 +9,7 @@ function retrieveAssetsProd(clientDependencies, assetsManifest, includeAssetsImp
     clientDependencies.forEach(({ id, onlyAssets, eagerlyImported }) => {
         if (eagerlyImported)
             return; // Eagerly imported assets aren't imported with import() and therefore don't create a new Rollup entry and aren't listed in the manifest file
-        // TODO/v1-release: remove
+        // TO-DO/next-major-release: remove
         if (includeAssetsImportedByServer &&
             onlyAssets &&
             id.includes('.page.server.') &&

package/dist/esm/node/runtime/renderPage/loadPageConfigsLazyServerSide.d.ts

@@ -1,11 +1,13 @@
 export { loadPageConfigsLazyServerSideAndExecHook };
 export type { PageContext_loadPageConfigsLazyServerSide };
 export type { PageConfigsLazy };
+import { type VikeConfigPublicPageLazy } from '../../../shared/getPageFiles.js';
 import { PromiseType } from '../utils.js';
 import { PageContextGetPageAssets, type PageAsset } from './getPageAssets.js';
 import { type PageContextDebugRouteMatches } from './debugPageFiles.js';
 import type { GlobalContextServerInternal } from '../globalContext.js';
 import { type PageContextExecHookServer } from './execHookServer.js';
+import type { PassToClient } from '../html/serializeContext.js';
 type PageContextExecuteHook = Omit<PageContextExecHookServer, keyof Awaited<ReturnType<typeof loadPageConfigsLazyServerSide>>>;
 type PageContext_loadPageConfigsLazyServerSide = PageContextGetPageAssets & PageContextDebugRouteMatches & {
     pageId: string;
@@ -13,19 +15,21 @@ type PageContext_loadPageConfigsLazyServerSide = PageContextGetPageAssets & Page
     _globalContext: GlobalContextServerInternal;
 };
 type PageConfigsLazy = PromiseType<ReturnType<typeof loadPageConfigsLazyServerSide>>;
-declare function loadPageConfigsLazyServerSideAndExecHook<PageContext extends PageContext_loadPageConfigsLazyServerSide & PageContextExecuteHook>(pageContext: PageContext): Promise<PageContext & import("../../../shared/getPageFiles.js").VikeConfigPublicPageLazy & {
+declare function loadPageConfigsLazyServerSideAndExecHook<PageContext extends PageContext_loadPageConfigsLazyServerSide & PageContextExecuteHook>(pageContext: PageContext): Promise<PageContext & VikeConfigPublicPageLazy & {
     Page: unknown;
     _isHtmlOnly: boolean;
-    _passToClient: string[];
+    _passToClient: PassToClient;
     _pageFilePathsLoaded: string[];
+    headersResponse: Headers;
 } & {
     __getPageAssets: () => Promise<PageAsset[]>;
 }>;
-declare function loadPageConfigsLazyServerSide(pageContext: PageContext_loadPageConfigsLazyServerSide): Promise<import("../../../shared/getPageFiles.js").VikeConfigPublicPageLazy & {
+declare function loadPageConfigsLazyServerSide(pageContext: PageContext_loadPageConfigsLazyServerSide): Promise<VikeConfigPublicPageLazy & {
     Page: unknown;
     _isHtmlOnly: boolean;
-    _passToClient: string[];
+    _passToClient: PassToClient;
     _pageFilePathsLoaded: string[];
+    headersResponse: Headers;
 } & {
     __getPageAssets: () => Promise<PageAsset[]>;
 }>;