vike 0.4.171-commit-43aef47 → 0.4.171-commit-75e1588

package/dist/cjs/node/plugin/shared/addSsrMiddleware.js

@@ -1,7 +1,12 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.addSsrMiddleware = void 0;
 const renderPage_js_1 = require("../../runtime/renderPage.js");
+const utils_js_1 = require("../utils.js");
+const picocolors_1 = __importDefault(require("@brillout/picocolors"));
 function addSsrMiddleware(middlewares) {
     middlewares.use(async (req, res, next) => {
         if (res.headersSent)
@@ -10,12 +15,21 @@ function addSsrMiddleware(middlewares) {
         if (!url)
             return next();
         const { headers } = req;
-        const userAgent = headers['user-agent'];
         const pageContextInit = {
             urlOriginal: url,
-            userAgent,
-            headers
+            headersOriginal: headers
         };
+        Object.defineProperty(pageContextInit, 'userAgent', {
+            get() {
+                // TODO/next-major-release: assertUsage() instead of assertWarning()
+                (0, utils_js_1.assertWarning)(false, `${picocolors_1.default.cyan('pageContext.userAgent')} is deprecated: use ${picocolors_1.default.cyan("pageContext.headers['user-agent']")} instead.`, {
+                    showStackTrace: true,
+                    onlyOnce: true
+                });
+                return headers['user-agent'];
+            },
+            enumerable: false
+        });
         let pageContext;
         try {
             pageContext = await (0, renderPage_js_1.renderPage)(pageContextInit);

package/dist/cjs/node/runtime/renderPage/renderPageAlreadyRouted.js

@@ -147,7 +147,25 @@ function getPageContextInitEnhanced(pageContextInit, renderContext, { urlCompute
         _urlHandler: urlHandler,
         isClientSideNavigation
     });
+    // pageContext.urlParsed
     (0, addUrlComputedProps_js_1.addUrlComputedProps)(pageContextInitEnhanced, !urlComputedPropsNonEnumerable);
+    // pageContext.headers
+    {
+        let headers;
+        if (pageContextInit.headersOriginal) {
+            headers = (0, utils_js_1.normalizeHeaders)(pageContextInit.headersOriginal);
+            (0, utils_js_1.assertUsage)(!('headers' in pageContextInit), "You're defining pageContextInit.headersOriginal as well as pageContextInit.headers but you should only define pageContextInit.headersOriginal instead, see https://vike.dev/headers");
+        }
+        else if (pageContextInit.headers) {
+            headers = pageContextInit.headers;
+            // TODO/next-major-release: assertUsage() instead of assertWarning()
+            (0, utils_js_1.assertWarning)(false, 'Setting pageContextInit.headers is deprecated: set pageContextInit.headersOriginal instead, see https://vike.dev/headers', { onlyOnce: true });
+        }
+        else {
+            headers = null;
+        }
+        (0, utils_js_1.objectAssign)(pageContextInitEnhanced, { headers });
+    }
     return pageContextInitEnhanced;
 }
 exports.getPageContextInitEnhanced = getPageContextInitEnhanced;

package/dist/cjs/node/runtime/utils.js

@@ -69,3 +69,4 @@ __exportStar(require("../../utils/formatHintLog.js"), exports);
 __exportStar(require("../../utils/joinEnglish.js"), exports);
 __exportStar(require("../../utils/isArrayOfStrings.js"), exports);
 __exportStar(require("../../utils/escapeHtml.js"), exports);
+__exportStar(require("../../utils/normalizeHeaders.js"), exports);

package/dist/cjs/utils/assert.js

@@ -92,7 +92,7 @@ function assertWarning(condition, msg, { onlyOnce, showStackTrace }) {
     }
     globalObject.onBeforeLog?.();
     if (showStackTrace) {
-        const err = new Error(msg);
+        const err = (0, createErrorWithCleanStackTrace_js_1.createErrorWithCleanStackTrace)(msg, numberOfStackTraceLinesToRemove);
         globalObject.showStackTraceList.add(err);
         globalObject.logger(err, 'warn');
     }

package/dist/cjs/utils/assertNodeVersion.js

@@ -8,6 +8,6 @@ function assertNodeVersion() {
     if (!(0, isNodeJS_js_1.isNodeJS)())
         return;
     const version = process.versions.node;
-    (0, assertVersion_js_1.assertVersion)('Node.js', version, '16.0.0');
+    (0, assertVersion_js_1.assertVersion)('Node.js', version, '18.0.0');
 }
 exports.assertNodeVersion = assertNodeVersion;

package/dist/cjs/utils/normalizeHeaders.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeHeaders = void 0;
+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.
+headersOriginal ConstructorParameters<typeof Headers>[0]
+*/
+headersOriginal) {
+    const headersStandard = new Headers(headersOriginal);
+    const headers = Object.fromEntries(headersStandard.entries());
+    return headers;
+}
+exports.normalizeHeaders = normalizeHeaders;

package/dist/cjs/utils/projectInfo.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PROJECT_VERSION = exports.projectInfo = void 0;
-const PROJECT_VERSION = '0.4.171-commit-43aef47';
+const PROJECT_VERSION = '0.4.171-commit-75e1588';
 exports.PROJECT_VERSION = PROJECT_VERSION;
 const projectInfo = {
     projectName: 'Vike',

package/dist/esm/node/plugin/shared/addSsrMiddleware.js

@@ -1,5 +1,7 @@
 export { addSsrMiddleware };
 import { renderPage } from '../../runtime/renderPage.js';
+import { assertWarning } from '../utils.js';
+import pc from '@brillout/picocolors';
 function addSsrMiddleware(middlewares) {
     middlewares.use(async (req, res, next) => {
         if (res.headersSent)
@@ -8,12 +10,21 @@ function addSsrMiddleware(middlewares) {
         if (!url)
             return next();
         const { headers } = req;
-        const userAgent = headers['user-agent'];
         const pageContextInit = {
             urlOriginal: url,
-            userAgent,
-            headers
+            headersOriginal: headers
         };
+        Object.defineProperty(pageContextInit, 'userAgent', {
+            get() {
+                // TODO/next-major-release: assertUsage() instead of assertWarning()
+                assertWarning(false, `${pc.cyan('pageContext.userAgent')} is deprecated: use ${pc.cyan("pageContext.headers['user-agent']")} instead.`, {
+                    showStackTrace: true,
+                    onlyOnce: true
+                });
+                return headers['user-agent'];
+            },
+            enumerable: false
+        });
         let pageContext;
         try {
             pageContext = await renderPage(pageContextInit);

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

@@ -38,6 +38,8 @@ declare function prerenderPage(pageContext: PageContextInitEnhanced & PageFiles
     pageContextSerialized: null;
     pageContext: {
         urlOriginal: string;
+        headersOriginal?: unknown;
+        headers?: unknown;
     } & {
         _objectCreatedByVike: boolean;
         _baseServer: string;
@@ -51,12 +53,16 @@ declare function prerenderPage(pageContext: PageContextInitEnhanced & PageFiles
         _onBeforeRouteHook: Hook | null;
         _pageContextInit: {
             urlOriginal: string;
+            headersOriginal?: unknown;
+            headers?: unknown;
         };
         _urlRewrite: string | null;
         _urlHandler: ((url: string) => string) | null;
         isClientSideNavigation: boolean;
     } & import("../../../shared/addUrlComputedProps.js").PageContextUrlComputedPropsClient & {
         _urlRewrite: string | null;
+    } & {
+        headers: Record<string, string> | null;
     } & {
         Page: unknown;
         _isHtmlOnly: boolean;
@@ -89,6 +95,8 @@ declare function prerenderPage(pageContext: PageContextInitEnhanced & PageFiles
     pageContextSerialized: string;
     pageContext: {
         urlOriginal: string;
+        headersOriginal?: unknown;
+        headers?: unknown;
     } & {
         _objectCreatedByVike: boolean;
         _baseServer: string;
@@ -102,12 +110,16 @@ declare function prerenderPage(pageContext: PageContextInitEnhanced & PageFiles
         _onBeforeRouteHook: Hook | null;
         _pageContextInit: {
             urlOriginal: string;
+            headersOriginal?: unknown;
+            headers?: unknown;
         };
         _urlRewrite: string | null;
         _urlHandler: ((url: string) => string) | null;
         isClientSideNavigation: boolean;
     } & import("../../../shared/addUrlComputedProps.js").PageContextUrlComputedPropsClient & {
         _urlRewrite: string | null;
+    } & {
+        headers: Record<string, string> | null;
     } & {
         Page: unknown;
         _isHtmlOnly: boolean;
@@ -141,6 +153,8 @@ declare function prerender404Page(renderContext: RenderContext, pageContextInit_
     pageContextSerialized: null;
     pageContext: {
         urlOriginal: string;
+        headersOriginal?: unknown;
+        headers?: unknown;
     } & {
         _objectCreatedByVike: boolean;
         _baseServer: string;
@@ -154,12 +168,16 @@ declare function prerender404Page(renderContext: RenderContext, pageContextInit_
         _onBeforeRouteHook: Hook | null;
         _pageContextInit: {
             urlOriginal: string;
+            headersOriginal?: unknown;
+            headers?: unknown;
         };
         _urlRewrite: string | null;
         _urlHandler: ((url: string) => string) | null;
         isClientSideNavigation: boolean;
     } & import("../../../shared/addUrlComputedProps.js").PageContextUrlComputedPropsClient & {
         _urlRewrite: string | null;
+    } & {
+        headers: Record<string, string> | null;
     } & {
         Page: unknown;
         _isHtmlOnly: boolean;
@@ -192,6 +210,8 @@ declare function prerender404Page(renderContext: RenderContext, pageContextInit_
     pageContextSerialized: string;
     pageContext: {
         urlOriginal: string;
+        headersOriginal?: unknown;
+        headers?: unknown;
     } & {
         _objectCreatedByVike: boolean;
         _baseServer: string;
@@ -205,12 +225,16 @@ declare function prerender404Page(renderContext: RenderContext, pageContextInit_
         _onBeforeRouteHook: Hook | null;
         _pageContextInit: {
             urlOriginal: string;
+            headersOriginal?: unknown;
+            headers?: unknown;
         };
         _urlRewrite: string | null;
         _urlHandler: ((url: string) => string) | null;
         isClientSideNavigation: boolean;
     } & import("../../../shared/addUrlComputedProps.js").PageContextUrlComputedPropsClient & {
         _urlRewrite: string | null;
+    } & {
+        headers: Record<string, string> | null;
     } & {
         Page: unknown;
         _isHtmlOnly: boolean;
@@ -242,6 +266,8 @@ declare function prerender404Page(renderContext: RenderContext, pageContextInit_
 type PageContextInitEnhanced = ReturnType<typeof getPageContextInitEnhanced>;
 declare function getPageContextInitEnhanced(pageContextInit: {
     urlOriginal: string;
+    headersOriginal?: unknown;
+    headers?: unknown;
 }, renderContext: RenderContext, { urlComputedPropsNonEnumerable, ssr: { urlRewrite, urlHandler, isClientSideNavigation } }?: {
     urlComputedPropsNonEnumerable?: boolean;
     ssr?: {
@@ -251,6 +277,8 @@ declare function getPageContextInitEnhanced(pageContextInit: {
     };
 }): {
     urlOriginal: string;
+    headersOriginal?: unknown;
+    headers?: unknown;
 } & {
     _objectCreatedByVike: boolean;
     _baseServer: string;
@@ -264,12 +292,16 @@ declare function getPageContextInitEnhanced(pageContextInit: {
     _onBeforeRouteHook: Hook | null;
     _pageContextInit: {
         urlOriginal: string;
+        headersOriginal?: unknown;
+        headers?: unknown;
     };
     _urlRewrite: string | null;
     _urlHandler: ((url: string) => string) | null;
     isClientSideNavigation: boolean;
 } & import("../../../shared/addUrlComputedProps.js").PageContextUrlComputedPropsClient & {
     _urlRewrite: string | null;
+} & {
+    headers: Record<string, string> | null;
 };
 type RenderContext = {
     pageFilesAll: PageFile[];

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

@@ -6,7 +6,7 @@ export { getRenderContext };
 import { getErrorPageId } from '../../../shared/error-page.js';
 import { getHtmlString } from '../html/renderHtml.js';
 import { getPageFilesAll } from '../../../shared/getPageFiles.js';
-import { assert, assertUsage, hasProp, objectAssign } from '../utils.js';
+import { assert, assertUsage, assertWarning, hasProp, normalizeHeaders, objectAssign } from '../utils.js';
 import { serializePageContextClientSide } from '../html/serializePageContextClientSide.js';
 import { addUrlComputedProps } from '../../../shared/addUrlComputedProps.js';
 import { getGlobalContext } from '../globalContext.js';
@@ -143,7 +143,25 @@ function getPageContextInitEnhanced(pageContextInit, renderContext, { urlCompute
         _urlHandler: urlHandler,
         isClientSideNavigation
     });
+    // pageContext.urlParsed
     addUrlComputedProps(pageContextInitEnhanced, !urlComputedPropsNonEnumerable);
+    // pageContext.headers
+    {
+        let headers;
+        if (pageContextInit.headersOriginal) {
+            headers = normalizeHeaders(pageContextInit.headersOriginal);
+            assertUsage(!('headers' in pageContextInit), "You're defining pageContextInit.headersOriginal as well as pageContextInit.headers but you should only define pageContextInit.headersOriginal instead, see https://vike.dev/headers");
+        }
+        else if (pageContextInit.headers) {
+            headers = pageContextInit.headers;
+            // TODO/next-major-release: assertUsage() instead of assertWarning()
+            assertWarning(false, 'Setting pageContextInit.headers is deprecated: set pageContextInit.headersOriginal instead, see https://vike.dev/headers', { onlyOnce: true });
+        }
+        else {
+            headers = null;
+        }
+        objectAssign(pageContextInitEnhanced, { headers });
+    }
     return pageContextInitEnhanced;
 }
 // TODO: remove getRenderContext() in favor of getGlobalObject() + reloadGlobalContext()

package/dist/esm/node/runtime/utils.d.ts

@@ -50,3 +50,4 @@ export * from '../../utils/formatHintLog.js';
 export * from '../../utils/joinEnglish.js';
 export * from '../../utils/isArrayOfStrings.js';
 export * from '../../utils/escapeHtml.js';
+export * from '../../utils/normalizeHeaders.js';

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

@@ -53,3 +53,4 @@ export * from '../../utils/formatHintLog.js';
 export * from '../../utils/joinEnglish.js';
 export * from '../../utils/isArrayOfStrings.js';
 export * from '../../utils/escapeHtml.js';
+export * from '../../utils/normalizeHeaders.js';

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

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

package/dist/esm/utils/assert.js

@@ -92,7 +92,7 @@ function assertWarning(condition, msg, { onlyOnce, showStackTrace }) {
     }
     globalObject.onBeforeLog?.();
     if (showStackTrace) {
-        const err = new Error(msg);
+        const err = createErrorWithCleanStackTrace(msg, numberOfStackTraceLinesToRemove);
         globalObject.showStackTraceList.add(err);
         globalObject.logger(err, 'warn');
     }

package/dist/esm/utils/assertNodeVersion.js

@@ -6,5 +6,5 @@ function assertNodeVersion() {
     if (!isNodeJS())
         return;
     const version = process.versions.node;
-    assertVersion('Node.js', version, '16.0.0');
+    assertVersion('Node.js', version, '18.0.0');
 }

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

@@ -0,0 +1 @@
+export declare function normalizeHeaders(headersOriginal: unknown): Record<string, string>;

package/dist/esm/utils/normalizeHeaders.js

@@ -0,0 +1,9 @@
+export 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.
+headersOriginal ConstructorParameters<typeof Headers>[0]
+*/
+headersOriginal) {
+    const headersStandard = new Headers(headersOriginal);
+    const headers = Object.fromEntries(headersStandard.entries());
+    return headers;
+}

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

@@ -1,7 +1,7 @@
 export { projectInfo };
 export { PROJECT_VERSION };
-declare const PROJECT_VERSION: "0.4.171-commit-43aef47";
+declare const PROJECT_VERSION: "0.4.171-commit-75e1588";
 declare const projectInfo: {
     projectName: "Vike";
-    projectVersion: "0.4.171-commit-43aef47";
+    projectVersion: "0.4.171-commit-75e1588";
 };

package/dist/esm/utils/projectInfo.js

@@ -1,6 +1,6 @@
 export { projectInfo };
 export { PROJECT_VERSION };
-const PROJECT_VERSION = '0.4.171-commit-43aef47';
+const PROJECT_VERSION = '0.4.171-commit-75e1588';
 const projectInfo = {
     projectName: 'Vike',
     projectVersion: PROJECT_VERSION

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vike",
-  "version": "0.4.171-commit-43aef47",
+  "version": "0.4.171-commit-75e1588",
   "scripts": {
     "dev": "tsc --watch",
     "build": "rimraf dist/ && pnpm run build:esm && pnpm run build:cjs",
@@ -216,7 +216,7 @@
     "vite": "npm:@brillout/vite@5.1.0-commit-3dc7abd"
   },
   "engines": {
-    "node": ">=16.0.0"
+    "node": ">=18.0.0"
   },
   "description": "Like Next.js/Nuxt but as do-one-thing-do-it-well Vite plugin.",
   "repository": "https://github.com/vikejs/vike",