vike 0.4.235 → 0.4.236

package/dist/esm/shared/page-configs/resolveVikeConfigPublic.js

@@ -1,5 +1,5 @@
-// TODO/now-same-api: use public API internally?
-// TODO/now-flat-pageContext: rename definedAt => definedBy
+// TO-DO/soon/same-api: use public API internally?
+// TO-DO/soon/flat-pageContext: rename definedAt => definedBy
 export { resolveVikeConfigPublicGlobal };
 export { resolveVikeConfigPublicPageEager };
 export { resolveVikeConfigPublicPageLazy };
@@ -47,10 +47,10 @@ function resolveVikeConfigPublicPageLazy(pageFiles, // V0.4 design
 pageConfig, // V1 design
 pageConfigGlobal) {
     const config = {};
-    const configEntries = {}; // TODO/v1-release: remove
-    const exportsAll = {}; // TODO/v1-release: remove
+    const configEntries = {}; // TO-DO/next-major-release: remove
+    const exportsAll = {}; // TO-DO/next-major-release: remove
     // V0.4 design
-    // TODO/v1-release: remove
+    // TO-DO/next-major-release: remove
     pageFiles.forEach((pageFile) => {
         const exportValues = getExportValues(pageFile);
         exportValues.forEach(({ exportName, exportValue, isFromDefaultExport }) => {
@@ -60,7 +60,7 @@ pageConfigGlobal) {
                 exportValue,
                 exportSource: `${pageFile.filePath} > ${isFromDefaultExport ? `\`export default { ${exportName} }\`` : `\`export { ${exportName} }\``}`,
                 filePath: pageFile.filePath,
-                _filePath: pageFile.filePath, // TODO/next-major-release: remove
+                _filePath: pageFile.filePath, // TO-DO/next-major-release: remove
                 _fileType: pageFile.fileType,
                 _isFromDefaultExport: isFromDefaultExport,
             });
@@ -105,18 +105,18 @@ pageConfigGlobal) {
     });
     assert(!('default' in exports));
     assert(!('default' in exportsAll));
-    const pageContextExports = {
+    const configPublicPageLazy = {
         config: config,
         from,
         source,
         sources,
-        // TODO/now-flat-pageContext: deprecate every prop below
+        // TO-DO/soon/flat-pageContext: deprecate every prop below
         configEntries,
         exports,
         exportsAll,
     };
-    // TODO/v1-release: remove
-    objectDefineProperty(pageContextExports, 'pageExports', {
+    // TO-DO/next-major-release: remove
+    objectDefineProperty(configPublicPageLazy, 'pageExports', {
         get: () => {
             // We only show the warning in Node.js because when using Client Routing Vue integration uses `Object.assign(pageContextReactive, pageContext)` which will wrongully trigger the warning. There is no cross-browser way to catch whether the property accessor was initiated by an `Object.assign()` call.
             if (!isBrowser()) {
@@ -130,7 +130,7 @@ pageConfigGlobal) {
         enumerable: false,
         configurable: true,
     });
-    return pageContextExports;
+    return configPublicPageLazy;
 }
 // V1 design
 function resolveVikeConfigPublic_V1Design(pageConfig) {
@@ -158,7 +158,7 @@ function resolveVikeConfigPublic_V1Design(pageConfig) {
             configDefinedAt,
             configDefinedByFile: configValueFilePathToShowToUser,
         });
-        // TODO/v1-release: remove
+        // TO-DO/next-major-release: remove
         const exportName = configName;
         exportsAll[exportName] = exportsAll[exportName] ?? [];
         exportsAll[exportName].push({

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

@@ -173,7 +173,7 @@ function logJsonSerializeError(err, configName, definedAtData) {
     //*/
     const configValueFilePathToShowToUser = getConfigValueFilePathToShowToUser(definedAtData);
     assert(configValueFilePathToShowToUser);
-    assertUsage(false, `${pc.cyan(configName)} defined by ${configValueFilePathToShowToUser} must be defined over a so-called "pointer import", see https://vike.dev/config#pointer-imports`);
+    assertUsage(false, `${pc.cyan(configName)} defined by ${configValueFilePathToShowToUser} must be defined using a separate file ${pc.bold(`+${configName}.js`)}, see https://vike.dev/error/runtime-in-config`);
 }
 function getConfigValuesBase(pageConfig, isEnvMatch, isEager) {
     const fromComputed = Object.entries(pageConfig.configValuesComputed ?? {}).map(([configName, valueInfo]) => {

package/dist/esm/shared/preparePageContextForPublicUsage.js

@@ -9,7 +9,7 @@ function preparePageContextForPublicUsage(pageContext) {
     assert(!pageContext.globalContext); // pageContext.globalContext should only be available to users — Vike itself should use pageContext._globalContext instead
     assert(pageContext._isOriginalObject); // ensure we preserve the original object reference
     addIs404ToPageProps(pageContext);
-    // TODO/next-major-release: remove
+    // TO-DO/next-major-release: remove
     if (!('_pageId' in pageContext)) {
         Object.defineProperty(pageContext, '_pageId', {
             get() {
@@ -27,7 +27,7 @@ function preparePageContextForPublicUsage(pageContext) {
     const globalContextPublic = prepareGlobalContextForPublicUsage(pageContext._globalContext);
     const pageContextPublic = getProxyForPublicUsage(pageContext, 'pageContext', 
     // We must skip it in the client-side because of the reactivity mechanism of UI frameworks like Solid.
-    // - TODO/now-proxy: double check whether that's true
+    // - TO-DO/soon/proxy: double check whether that's true
     true, (prop) => {
         if (prop === 'globalContext') {
             return globalContextPublic;
@@ -65,11 +65,11 @@ function assertPropertyGetters(pageContext) {
     ;
     [
         'urlPathname',
-        // TODO/v1-release: remove
+        // TO-DO/next-major-release: remove
         'urlParsed',
-        // TODO/v1-release: remove
+        // TO-DO/next-major-release: remove
         'url',
-        // TODO/v1-release: remove
+        // TO-DO/next-major-release: remove
         'pageExports',
     ].forEach((prop) => {
         if (pageContext.prop)

package/dist/esm/shared/route/abort.js

@@ -82,7 +82,7 @@ function AbortRender(pageContextAbort) {
     checkType(err);
     return err;
 }
-// TODO/v1-release: remove
+// TO-DO/next-major-release: remove
 /**
  * @deprecated Use `throw render()` or `throw redirect()` instead, see https://vike.dev/render'
  */

package/dist/esm/shared/route/deduceRouteStringFromFilesystemPath.js

@@ -1,7 +1,7 @@
 // Unit tests at ./deduceRouteStringFromFilesystemPath.spec.ts
 import { assert, higherFirst, slice } from './utils.js';
 export { deduceRouteStringFromFilesystemPath };
-// TODO/next-major-update: remove this and whole filesystemRoot mechanism
+// TO-DO/next-major-release: remove this and whole filesystemRoot mechanism
 function deduceRouteStringFromFilesystemPath(pageId, filesystemRoots) {
     // Handle Filesystem Routing Root
     const filesystemRootsMatch = filesystemRoots

package/dist/esm/shared/route/execHookGuard.js

@@ -6,7 +6,7 @@ const errIntro = 'The guard() hook defined by';
 async function execHookGuard(pageContext, prepareForPublicUsage) {
     let hook;
     if (pageContext._globalContext._pageFilesAll.length > 0) {
-        // TODO/v1-release: remove
+        // TO-DO/next-major-release: remove
         // V0.4 design
         assert(pageContext._globalContext._pageConfigs.length === 0);
         hook = findPageGuard(pageContext.pageId, pageContext._globalContext._pageFilesAll);

package/dist/esm/shared/route/execHookOnBeforeRoute.js

@@ -36,7 +36,7 @@ async function execHookOnBeforeRoute(pageContext) {
 async function getPageContextFromHook(onBeforeRouteHook, pageContext) {
     let { hookReturn } = execHookDirectSync(onBeforeRouteHook, pageContext, preparePageContextForPublicUsage);
     assertSyncRouting(hookReturn, `The onBeforeRoute() hook ${onBeforeRouteHook.hookFilePath}`);
-    // TODO/v1-release: make execHookOnBeforeRoute() and route() sync
+    // TO-DO/next-major-release: make execHookOnBeforeRoute() and route() sync
     hookReturn = await hookReturn;
     const errPrefix = `The onBeforeRoute() hook defined by ${onBeforeRouteHook.hookFilePath}`;
     assertUsage(hookReturn === null ||

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

@@ -12,7 +12,7 @@ import { resolveRouteFunction } from './resolveRouteFunction.js';
 import { execHookOnBeforeRoute } from './execHookOnBeforeRoute.js';
 import { debug } from './debug.js';
 import pc from '@brillout/picocolors';
-// TODO/next-major-release: make it sync
+// TO-DO/next-major-release: make it sync
 async function route(pageContext, skipOnBeforeRouteHook) {
     debug('Pages routes:', pageContext._globalContext._pageRoutes);
     const pageContextFromRoute = {};

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

@@ -1,4 +1,5 @@
 export { loadPageRoutes };
+export { loadPageRoutesSync };
 export type { PageRoutes };
 export type { RouteType };
 import type { PageFile } from '../getPageFiles.js';
@@ -28,3 +29,7 @@ declare function loadPageRoutes(pageFilesAll: PageFile[], pageConfigs: PageConfi
     pageRoutes: PageRoutes;
     onBeforeRouteHook: null | Hook;
 }>;
+declare function loadPageRoutesSync(pageFilesAll: PageFile[], pageConfigs: PageConfigRuntime[], pageConfigGlobal: PageConfigGlobalRuntime, allPageIds: string[]): {
+    pageRoutes: PageRoutes;
+    onBeforeRouteHook: null | Hook;
+};

package/dist/esm/shared/route/loadPageRoutes.js

@@ -1,4 +1,5 @@
 export { loadPageRoutes };
+export { loadPageRoutesSync };
 import { isErrorPageId } from '../error-page.js';
 import { assert, assertUsage, hasProp, slice } from './utils.js';
 import { deduceRouteStringFromFilesystemPath } from './deduceRouteStringFromFilesystemPath.js';
@@ -10,8 +11,13 @@ import { getHookFromPageConfigGlobal, getHookTimeoutDefault } from '../hooks/get
 async function loadPageRoutes(
 // Remove all arguments and use GlobalContextServerInternal instead?
 pageFilesAll, pageConfigs, pageConfigGlobal, allPageIds) {
-    // TODO/next-major: remove & make this function sync
+    // TO-DO/next-major-release: remove this line, remove this function, rename loadPageRoutesSync() to loadPageRoutes()
     await Promise.all(pageFilesAll.filter((p) => p.fileType === '.page.route').map((p) => p.loadFile?.()));
+    return loadPageRoutesSync(pageFilesAll, pageConfigs, pageConfigGlobal, allPageIds);
+}
+function loadPageRoutesSync(
+// Remove all arguments and use GlobalContextServerInternal instead?
+pageFilesAll, pageConfigs, pageConfigGlobal, allPageIds) {
     const { onBeforeRouteHook, filesystemRoots } = getGlobalHooks(pageFilesAll, pageConfigs, pageConfigGlobal);
     const pageRoutes = getPageRoutes(filesystemRoots, pageFilesAll, pageConfigs, allPageIds);
     return { pageRoutes, onBeforeRouteHook };
@@ -49,7 +55,7 @@ function getPageRoutes(filesystemRoots, pageFilesAll, pageConfigs, allPageIds) {
                         const { filePathToShowToUser } = definedAtData;
                         assert(filePathToShowToUser);
                         assert(isCallable(route));
-                        // TODO/next-major: remove
+                        // TO-DO/next-major-release: remove
                         if (getConfigValueRuntime(pageConfig, 'iKnowThePerformanceRisksOfAsyncRouteFunctions', 'boolean'))
                             warnDeprecatedAllowKey();
                         pageRoute = {
@@ -82,7 +88,7 @@ function getPageRoutes(filesystemRoots, pageFilesAll, pageConfigs, allPageIds) {
         });
     }
     // Old design
-    // TODO/v1-release: remove
+    // TO-DO/next-major-release: remove
     if (pageConfigs.length === 0) {
         assert(filesystemRoots);
         const comesFromV1PageConfig = false;
@@ -149,7 +155,7 @@ function getGlobalHooks(pageFilesAll, pageConfigs, pageConfigGlobal) {
         return { onBeforeRouteHook: hook, filesystemRoots: null };
     }
     // Old design
-    // TODO/v1-release: remove
+    // TO-DO/next-major-release: remove
     let onBeforeRouteHook = null;
     const filesystemRoots = [];
     pageFilesAll

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

@@ -13,7 +13,7 @@ async function resolveRouteFunction(routeFunction, pageContext, routeFunctionFil
         hookName: 'route',
     }, pageContext, preparePageContextForPublicUsage);
     assertSyncRouting(result, `The Route Function ${routeFunctionFilePath}`);
-    // TODO/v1-release: make resolveRouteFunction() and route() sync
+    // TO-DO/next-major-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;
     //*/
@@ -49,11 +49,11 @@ async function resolveRouteFunction(routeFunction, pageContext, routeFunctionFil
         routeParams,
     };
 }
-// TODO/v1-release: remove, and make routing synchronous (enabling Vike to synchronously check whether a link is a Vike link before even calling ev.preventDefault())
+// TO-DO/next-major-release: remove, and make routing synchronous (enabling Vike to synchronously check whether a link is a Vike link before even calling ev.preventDefault())
 function assertSyncRouting(res, errPrefix) {
     assertWarning(!isPromise(res), `${errPrefix} returned a promise, but asynchronous routing is deprecated and will be removed in the next major release, see https://vike.dev/route-function#async`, { onlyOnce: true });
 }
-// TODO/v1-release: remove
+// TO-DO/next-major-release: remove
 function warnDeprecatedAllowKey() {
     const allowKey = pc.cyan('iKnowThePerformanceRisksOfAsyncRouteFunctions');
     assertWarning(false, `${allowKey} is deprecated and will be removed in the next major release`, { onlyOnce: true });

package/dist/esm/shared/route/resolveRouteString.js

@@ -8,7 +8,7 @@ import { assertWarning, isBrowser, escapeRegex } from '../utils.js';
 import { assert, assertUsage } from './utils.js';
 import pc from '@brillout/picocolors';
 const PARAM_TOKEN_NEW = '@';
-// TODO/v1-release: remove
+// TO-DO/next-major-release: remove
 const PARAM_TOKEN_OLD = ':';
 function assertRouteString(routeString, errPrefix = 'Invalid') {
     let errPrefix2 = `${errPrefix} Route String ${highlight(routeString)}`;

package/dist/esm/shared/route/routing.js

@@ -1,4 +1,4 @@
-// TODO/v1-release - move:
+// TO-DO/next-major-release: move
 //   import { resolveRoute } from 'vike/routing'
 // to:
 //   import { resolveRoute } from 'vike'

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

@@ -44,6 +44,7 @@ import type { Vike, VikePackages } from './VikeNamespace.js';
 import type { HooksTimeoutProvidedByUser } from '../shared/hooks/getHook.js';
 import type { GlobalContext, PageContextClient, PageContextServer } from './PageContext.js';
 import type { InlineConfig } from 'vite';
+import type { PassToClient } from '../node/runtime/html/serializeContext.js';
 type HookNameOld = HookName | HookNameOldDesign;
 type HookName = HookNamePage | HookNameGlobal;
 type HookNamePage = 'onHydrationEnd' | 'onBeforePrerenderStart' | 'onBeforeRender' | 'onPageTransitionStart' | 'onPageTransitionEnd' | 'onRenderHtml' | 'onRenderClient' | 'guard' | 'data' | 'onData' | 'route';
@@ -362,7 +363,7 @@ type ConfigBuiltIn = {
      *
      * https://vike.dev/passToClient
      */
-    passToClient?: string[] | ImportString;
+    passToClient?: PassToClient | ImportString;
     /** Hook called when page is rendered on the client-side.
      *
      * https://vike.dev/onRenderClient
@@ -508,6 +509,12 @@ type ConfigBuiltIn = {
      * https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control
      */
     cacheControl?: string;
+    /**
+     * Add HTTP headers to the HTTP response.
+     *
+     * https://vike.dev/headers#response
+     */
+    headersResponse?: HeadersInit;
     /**
      * Make development/preview server available over LAN and public addresses.
      *
@@ -561,6 +568,7 @@ type ConfigBuiltInResolved = {
     redirects?: Record<string, string>[];
     prerender?: Exclude<Config['prerender'], ImportString | undefined>[];
     middleware?: Function[];
+    headersResponse?: HeadersInit[];
 };
 type ConfigMeta = Record<string, ConfigDefinition>;
 type ImportString = `import:${string}`;

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

@@ -81,7 +81,7 @@ type PageContextBuiltInCommon<Data> = {
      */
     urlOriginal: string;
     /**
-     * The HTTP Headers of the incoming HTTP Request.
+     * The HTTP request headers.
      *
      * As a string object normalized by Vike.
      *
@@ -90,7 +90,7 @@ type PageContextBuiltInCommon<Data> = {
      */
     headers: Record<string, string> | null;
     /**
-     * The HTTP Headers of the incoming HTTP Request.
+     * The HTTP request headers.
      *
      * The original object provided by the server.
      *
@@ -98,6 +98,12 @@ type PageContextBuiltInCommon<Data> = {
      * https://vike.dev/pageContext#headersOriginal
      */
     headersOriginal?: unknown;
+    /**
+     * The HTTP response headers.
+     *
+     * https://vike.dev/headers#response
+     */
+    headersResponse: Headers;
     /** If an error occurs, whether the error is a `404 Page Not Found`.
      *
      * https://vike.dev/error-page

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

@@ -1 +1 @@
-export declare const PROJECT_VERSION: "0.4.235";
+export declare const PROJECT_VERSION: "0.4.236";

package/dist/esm/utils/PROJECT_VERSION.js

@@ -1,2 +1,2 @@
 // Automatically updated by @brillout/release-me
-export const PROJECT_VERSION = '0.4.235';
+export const PROJECT_VERSION = '0.4.236';

package/dist/esm/utils/assertSetup.js

@@ -30,7 +30,7 @@ function onSetupRuntime() {
         return;
     assertNodeEnvIsNotUndefinedString();
     if (!setup.viteDevServer && setup.isViteDev === undefined) {
-        // TODO: make it assertUsage() again once https://github.com/vikejs/vike/issues/1528 is implemented.
+        // TO-DO/eventually: make it assertUsage() again once https://github.com/vikejs/vike/issues/1528 is implemented.
         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 });
         assertUsage(!setup.vikeVitePlugin, `Loading Vike's Vite plugin (the ${pc.cyan('vike/plugin')} module) is prohibited in production.`);
         // This assert() one of the main goal of this file: it ensures assertIsNotProductionRuntime()
@@ -38,7 +38,7 @@ function onSetupRuntime() {
     }
     else {
         if (!setup.isPreview && !setup.vitePreviewServer && !setup.isPrerendering) {
-            // TODO: make it assertUsage() again once https://github.com/vikejs/vike/issues/1528 is implemented.
+            // TO-DO/eventually: make it assertUsage() again once https://github.com/vikejs/vike/issues/1528 is implemented.
             assertWarning(isNodeEnvDev(), `The ${getEnvDescription()}, but Vite is loaded which is prohibited in production, see https://vike.dev/NODE_ENV`, { onlyOnce: true });
         }
         assert(setup.vikeVitePlugin);
@@ -108,7 +108,7 @@ function markSetup_isPreview() {
 function assertUsageNodeEnvIsNotDev(operation) {
     if (!isNodeEnvDev())
         return;
-    // TODO: make it assertUsage() again once https://github.com/vikejs/vike/issues/1528 is implemented.
+    // TO-DO/eventually: make it assertUsage() again once https://github.com/vikejs/vike/issues/1528 is implemented.
     assertWarning(false, `The ${getEnvDescription()} which is forbidden upon ${operation}, see https://vike.dev/NODE_ENV`, { onlyOnce: true });
 }
 function getEnvDescription() {

package/dist/esm/utils/debugGlob.js

@@ -1,3 +1,3 @@
 import { createDebugger } from './debug.js';
-// TODO/v1-release: remove (or rename?)
+// TO-DO/next-major-release: remove (or rename?)
 export const debugGlob = createDebugger('vike:glob');

package/dist/esm/utils/parseNpmPackage.js

@@ -52,7 +52,7 @@ function isPathAliasRecommended(alias) {
     //  - In principle, we could allow path aliases that don't start with special character as long as they can be distinguished from npm package names.
     //    - But we still enforce path aliases to start with a special character because it's a much simpler rule to follow.
     if (alias.startsWith('@/'))
-        return true; // Needed by contra.com
+        return true; // Needed by contra.com and https://github.com/vikejs/vike/issues/1567#issuecomment-3076374243
     const firstLetter = alias[0];
     assert(firstLetter);
     if (firstLetter === '@' || /[0-9a-z]/.test(firstLetter.toLowerCase()))

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vike",
-  "version": "0.4.235",
+  "version": "0.4.236",
   "repository": "https://github.com/vikejs/vike",
   "exports": {
     "./server": {
@@ -120,7 +120,7 @@
   },
   "dependencies": {
     "@brillout/import": "^0.2.6",
-    "@brillout/json-serializer": "^0.5.15",
+    "@brillout/json-serializer": "^0.5.16",
     "@brillout/picocolors": "^1.0.26",
     "@brillout/require-shim": "^0.1.2",
     "@brillout/vite-plugin-server-entry": "^0.7.8",
@@ -245,13 +245,10 @@
     "./universal-middleware.js"
   ],
   "devDependencies": {
-    "@biomejs/biome": "^1.9.4",
     "@brillout/release-me": "^0.4.2",
     "@types/estree": "^1.0.5",
-    "@types/jest": "^29.5.11",
     "@types/node": "^20.10.5",
     "@types/picomatch": "^3.0.2",
-    "@types/resolve": "^1.20.6",
     "@types/semver": "^7.5.8",
     "@types/source-map-support": "^0.5.10",
     "react-streaming": "^0.4.2",

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

@@ -1,5 +0,0 @@
-export { getCacheControl };
-import type { PageConfigRuntime } from '../../../../types/PageConfig.js';
-import type { HttpResponse } from '../createHttpResponse.js';
-type StatusCode = HttpResponse['statusCode'];
-declare function getCacheControl(pageId: string | null, pageConfigs: PageConfigRuntime[], statusCode: StatusCode): string;