vike 0.4.171-commit-2e4e1ce → 0.4.171-commit-42245b5

package/dist/cjs/node/plugin/plugins/importUserCode/v1-design/getVikeConfig/loadFileAtConfigTime.js

@@ -13,7 +13,7 @@ const transformFileImports_js_1 = require("./transformFileImports.js");
 const getConfigFileExport_js_1 = require("../getConfigFileExport.js");
 const resolvePointerImport_js_1 = require("./resolvePointerImport.js");
 (0, utils_js_1.assertIsNotProductionRuntime)();
-// Load fake import
+// Load pointer import
 async function loadImportedFile(import_, userRootDir, importedFilesLoaded) {
     const f = import_.filePathAbsoluteFilesystem;
     if (!importedFilesLoaded[f]) {
@@ -35,7 +35,7 @@ async function loadValueFile(interfaceValueFile, configName, userRootDir) {
     });
 }
 exports.loadValueFile = loadValueFile;
-// Load +config.js, including all its extends fake imports
+// Load +config.js, including all its extends pointer imports
 async function loadConfigFile(configFilePath, userRootDir, visited, isExtensionConfig) {
     const { filePathAbsoluteFilesystem } = configFilePath;
     assertNoInfiniteLoop(visited, filePathAbsoluteFilesystem);

package/dist/cjs/node/plugin/plugins/importUserCode/v1-design/getVikeConfig/resolvePointerImport.js

@@ -11,11 +11,19 @@ const path_1 = __importDefault(require("path"));
 const getFilePath_js_1 = require("../../../../shared/getFilePath.js");
 const filesEnvMap = new Map();
 function resolvePointerImportOfConfig(configValue, importerFilePath, userRootDir, configEnv, configName) {
-    if (typeof configValue !== 'string')
-        return null;
-    const pointerImportData = (0, transformFileImports_js_1.parsePointerImportData)(configValue);
-    if (!pointerImportData)
+    const pointerImportData = typeof configValue === 'string' && (0, transformFileImports_js_1.parsePointerImportData)(configValue);
+    if (!pointerImportData) {
+        // Temporary workaround to support document.title config.
+        // - We'll be able to remove that workaround once Vike supports custom nested configs (being able to define document.title and document.description as two different configs).
+        replaceStringValues(configValue, (str) => {
+            const pointerImportData = (0, transformFileImports_js_1.parsePointerImportData)(str);
+            if (pointerImportData) {
+                const filePath = resolvePointerImport(pointerImportData, importerFilePath, userRootDir);
+                return filePath.filePathAbsoluteVite;
+            }
+        });
         return null;
+    }
     const { importPath, exportName } = pointerImportData;
     const filePath = resolvePointerImport(pointerImportData, importerFilePath, userRootDir);
     const fileExportPathToShowToUser = exportName === 'default' || exportName === configName ? [] : [exportName];
@@ -127,3 +135,29 @@ function clearFilesEnvMap() {
     filesEnvMap.clear();
 }
 exports.clearFilesEnvMap = clearFilesEnvMap;
+function replaceStringValues(obj, replacer) {
+    const visited = new WeakSet();
+    return traverse(obj, replacer);
+    function traverse(obj, replacer) {
+        // Check if the input is an object
+        if ((0, utils_js_1.isObject)(obj)) {
+            if (visited.has(obj))
+                return;
+            visited.add(obj);
+            for (const key in obj) {
+                if (!obj.hasOwnProperty(key))
+                    continue;
+                const val = obj[key];
+                if (typeof val !== 'string') {
+                    traverse(val, replacer);
+                }
+                else {
+                    const replacement = replacer(val);
+                    if (replacement) {
+                        obj[key] = replacement;
+                    }
+                }
+            }
+        }
+    }
+}

package/dist/cjs/node/plugin/plugins/importUserCode/v1-design/getVikeConfig.js

@@ -552,7 +552,7 @@ async function getConfigValueSource(configName, interfaceFile, configDef, userRo
                 valueIsDefinedByValueFile: false,
                 definedAtFilePath: pointerImport
             };
-            // Load fake import
+            // Load pointer import
             if (isConfigEnv(configDef, configName) &&
                 // The value of `extends` was already loaded and already used: we don't need the value of `extends` anymore
                 configName !== 'extends') {

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

@@ -2,7 +2,6 @@
 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");
 function addSsrMiddleware(middlewares) {
     middlewares.use(async (req, res, next) => {
         if (res.headersSent)
@@ -11,15 +10,10 @@ function addSsrMiddleware(middlewares) {
         if (!url)
             return next();
         const { headers } = req;
+        const userAgent = headers['user-agent'];
         const pageContextInit = {
             urlOriginal: url,
-            get userAgent() {
-                (0, utils_js_1.assertWarning)(false, "pageContext.userAgent is deprecated in favor of pageContext.headers['user-agent']", {
-                    showStackTrace: true,
-                    onlyOnce: true
-                });
-                return headers['user-agent'];
-            },
+            userAgent,
             headers
         };
         let pageContext;

package/dist/cjs/node/runtime/html/renderHtml.js

@@ -170,31 +170,40 @@ async function renderTemplate(templateContent, pageContext) {
             setStream(templateVar);
             continue;
         }
-        const getErrMsg = (typeText, end) => {
+        const getErrMsg = (msg) => {
             const { hookName, hookFilePath } = pageContext._renderHook;
             const nth = (i === 0 && '1st') || (i === 1 && '2nd') || (i === 2 && '3rd') || `${i}-th`;
-            return [`The ${nth} HTML variable is ${typeText}, see ${hookName}() hook defined by ${hookFilePath}.`, end]
+            return [
+                `The ${nth} HTML variable is ${msg}`,
+                `The HTML was provided by the ${hookName}() hook at ${hookFilePath}.`
+            ]
                 .filter(Boolean)
                 .join(' ');
         };
-        (0, utils_js_1.assertUsage)(!(0, utils_js_1.isPromise)(templateVar), getErrMsg('a promise', `Did you forget to ${picocolors_1.default.cyan('await')} the promise?`));
+        (0, utils_js_1.assertUsage)(!(0, utils_js_1.isPromise)(templateVar), getErrMsg(`a promise, did you forget to ${picocolors_1.default.cyan('await')} the promise?`));
         if (templateVar === undefined || templateVar === null) {
-            (0, utils_js_1.assertWarning)(false, getErrMsg(`${picocolors_1.default.cyan(String(templateVar))} which will be converted to an empty string`, `Pass the empty string ${picocolors_1.default.cyan("''")} instead of ${picocolors_1.default.cyan(String(templateVar))} to remove this warning.`), { onlyOnce: false });
+            const msgVal = picocolors_1.default.cyan(String(templateVar));
+            const msgEmptyString = picocolors_1.default.cyan("''");
+            const msg = `${msgVal} which will be converted to an empty string. Pass the empty string ${msgEmptyString} instead of ${msgVal} to remove this warning.`;
+            (0, utils_js_1.assertWarning)(false, getErrMsg(msg), { onlyOnce: false });
             templateVar = '';
         }
         {
             const varType = typeof templateVar;
-            const streamNote = ['boolean', 'number', 'bigint', 'symbol'].includes(varType)
-                ? null
-                : '(See https://vike.dev/streaming for HTML streaming.)';
-            (0, utils_js_1.assertUsage)(varType === 'string', getErrMsg(picocolors_1.default.cyan(`typeof htmlVar === "${varType}"`), streamNote));
+            if (varType !== 'string') {
+                const msgType = picocolors_1.default.cyan(`typeof htmlVariable === "${varType}"`);
+                const msg = `${msgType} but a string or stream (https://vike.dev/streaming) is expected instead.`;
+                (0, utils_js_1.assertUsage)(false, getErrMsg(msg));
+            }
         }
         {
             const { isProduction } = (0, globalContext_js_1.getGlobalContext)();
             if ((0, utils_js_1.isHtml)(templateVar) &&
                 // We don't show this warning in production because it's expected that some users may (un)willingly do some XSS injection: we avoid flooding the production logs.
                 !isProduction) {
-                (0, utils_js_1.assertWarning)(false, getErrMsg(`${picocolors_1.default.cyan(templateVar)} which seems to be HTML code`, 'Did you forget to wrap the value with dangerouslySkipEscape()?'), { onlyOnce: false });
+                const msgVal = picocolors_1.default.cyan(String(templateVar));
+                const msg = `${msgVal} which seems to be HTML code. Did you forget to wrap the value with dangerouslySkipEscape()?`;
+                (0, utils_js_1.assertWarning)(false, getErrMsg(msg), { onlyOnce: false });
             }
         }
         // Escape untrusted template variable

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-2e4e1ce';
+const PROJECT_VERSION = '0.4.171-commit-42245b5';
 exports.PROJECT_VERSION = PROJECT_VERSION;
 const projectInfo = {
     projectName: 'Vike',

package/dist/esm/node/plugin/plugins/importUserCode/v1-design/getVikeConfig/loadFileAtConfigTime.js

@@ -10,7 +10,7 @@ import { parsePointerImportData } from './transformFileImports.js';
 import { getConfigFileExport } from '../getConfigFileExport.js';
 import { resolvePointerImport } from './resolvePointerImport.js';
 assertIsNotProductionRuntime();
-// Load fake import
+// Load pointer import
 async function loadImportedFile(import_, userRootDir, importedFilesLoaded) {
     const f = import_.filePathAbsoluteFilesystem;
     if (!importedFilesLoaded[f]) {
@@ -30,7 +30,7 @@ async function loadValueFile(interfaceValueFile, configName, userRootDir) {
         interfaceValueFile.fileExportsByConfigName[configName_] = { configValue };
     });
 }
-// Load +config.js, including all its extends fake imports
+// Load +config.js, including all its extends pointer imports
 async function loadConfigFile(configFilePath, userRootDir, visited, isExtensionConfig) {
     const { filePathAbsoluteFilesystem } = configFilePath;
     assertNoInfiniteLoop(visited, filePathAbsoluteFilesystem);

package/dist/esm/node/plugin/plugins/importUserCode/v1-design/getVikeConfig/resolvePointerImport.js

@@ -2,17 +2,25 @@ export { resolvePointerImportOfConfig };
 export { resolvePointerImport };
 export { clearFilesEnvMap };
 import pc from '@brillout/picocolors';
-import { assert, assertIsNpmPackageImport, assertPosixPath, assertUsage, deepEqual, isPathFilesystemAbsolute, requireResolve } from '../../../../utils.js';
+import { assert, assertIsNpmPackageImport, assertPosixPath, assertUsage, deepEqual, isObject, isPathFilesystemAbsolute, requireResolve } from '../../../../utils.js';
 import { parsePointerImportData } from './transformFileImports.js';
 import path from 'path';
 import { getFilePathAbsoluteUserRootDir, getFilePathResolved, getFilePathUnresolved } from '../../../../shared/getFilePath.js';
 const filesEnvMap = new Map();
 function resolvePointerImportOfConfig(configValue, importerFilePath, userRootDir, configEnv, configName) {
-    if (typeof configValue !== 'string')
-        return null;
-    const pointerImportData = parsePointerImportData(configValue);
-    if (!pointerImportData)
+    const pointerImportData = typeof configValue === 'string' && parsePointerImportData(configValue);
+    if (!pointerImportData) {
+        // Temporary workaround to support document.title config.
+        // - We'll be able to remove that workaround once Vike supports custom nested configs (being able to define document.title and document.description as two different configs).
+        replaceStringValues(configValue, (str) => {
+            const pointerImportData = parsePointerImportData(str);
+            if (pointerImportData) {
+                const filePath = resolvePointerImport(pointerImportData, importerFilePath, userRootDir);
+                return filePath.filePathAbsoluteVite;
+            }
+        });
         return null;
+    }
     const { importPath, exportName } = pointerImportData;
     const filePath = resolvePointerImport(pointerImportData, importerFilePath, userRootDir);
     const fileExportPathToShowToUser = exportName === 'default' || exportName === configName ? [] : [exportName];
@@ -121,3 +129,29 @@ function assertFileEnv(filePathAbsoluteFilesystem, importPath, configEnv, config
 function clearFilesEnvMap() {
     filesEnvMap.clear();
 }
+function replaceStringValues(obj, replacer) {
+    const visited = new WeakSet();
+    return traverse(obj, replacer);
+    function traverse(obj, replacer) {
+        // Check if the input is an object
+        if (isObject(obj)) {
+            if (visited.has(obj))
+                return;
+            visited.add(obj);
+            for (const key in obj) {
+                if (!obj.hasOwnProperty(key))
+                    continue;
+                const val = obj[key];
+                if (typeof val !== 'string') {
+                    traverse(val, replacer);
+                }
+                else {
+                    const replacement = replacer(val);
+                    if (replacement) {
+                        obj[key] = replacement;
+                    }
+                }
+            }
+        }
+    }
+}

package/dist/esm/node/plugin/plugins/importUserCode/v1-design/getVikeConfig.js

@@ -547,7 +547,7 @@ async function getConfigValueSource(configName, interfaceFile, configDef, userRo
                 valueIsDefinedByValueFile: false,
                 definedAtFilePath: pointerImport
             };
-            // Load fake import
+            // Load pointer import
             if (isConfigEnv(configDef, configName) &&
                 // The value of `extends` was already loaded and already used: we don't need the value of `extends` anymore
                 configName !== 'extends') {

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

@@ -1,6 +1,5 @@
 export { addSsrMiddleware };
 import { renderPage } from '../../runtime/renderPage.js';
-import { assertWarning } from '../utils.js';
 function addSsrMiddleware(middlewares) {
     middlewares.use(async (req, res, next) => {
         if (res.headersSent)
@@ -9,15 +8,10 @@ function addSsrMiddleware(middlewares) {
         if (!url)
             return next();
         const { headers } = req;
+        const userAgent = headers['user-agent'];
         const pageContextInit = {
             urlOriginal: url,
-            get userAgent() {
-                assertWarning(false, "pageContext.userAgent is deprecated in favor of pageContext.headers['user-agent']", {
-                    showStackTrace: true,
-                    onlyOnce: true
-                });
-                return headers['user-agent'];
-            },
+            userAgent,
             headers
         };
         let pageContext;

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

@@ -165,31 +165,40 @@ async function renderTemplate(templateContent, pageContext) {
             setStream(templateVar);
             continue;
         }
-        const getErrMsg = (typeText, end) => {
+        const getErrMsg = (msg) => {
             const { hookName, hookFilePath } = pageContext._renderHook;
             const nth = (i === 0 && '1st') || (i === 1 && '2nd') || (i === 2 && '3rd') || `${i}-th`;
-            return [`The ${nth} HTML variable is ${typeText}, see ${hookName}() hook defined by ${hookFilePath}.`, end]
+            return [
+                `The ${nth} HTML variable is ${msg}`,
+                `The HTML was provided by the ${hookName}() hook at ${hookFilePath}.`
+            ]
                 .filter(Boolean)
                 .join(' ');
         };
-        assertUsage(!isPromise(templateVar), getErrMsg('a promise', `Did you forget to ${pc.cyan('await')} the promise?`));
+        assertUsage(!isPromise(templateVar), getErrMsg(`a promise, did you forget to ${pc.cyan('await')} the promise?`));
         if (templateVar === undefined || templateVar === null) {
-            assertWarning(false, getErrMsg(`${pc.cyan(String(templateVar))} which will be converted to an empty string`, `Pass the empty string ${pc.cyan("''")} instead of ${pc.cyan(String(templateVar))} to remove this warning.`), { onlyOnce: false });
+            const msgVal = pc.cyan(String(templateVar));
+            const msgEmptyString = pc.cyan("''");
+            const msg = `${msgVal} which will be converted to an empty string. Pass the empty string ${msgEmptyString} instead of ${msgVal} to remove this warning.`;
+            assertWarning(false, getErrMsg(msg), { onlyOnce: false });
             templateVar = '';
         }
         {
             const varType = typeof templateVar;
-            const streamNote = ['boolean', 'number', 'bigint', 'symbol'].includes(varType)
-                ? null
-                : '(See https://vike.dev/streaming for HTML streaming.)';
-            assertUsage(varType === 'string', getErrMsg(pc.cyan(`typeof htmlVar === "${varType}"`), streamNote));
+            if (varType !== 'string') {
+                const msgType = pc.cyan(`typeof htmlVariable === "${varType}"`);
+                const msg = `${msgType} but a string or stream (https://vike.dev/streaming) is expected instead.`;
+                assertUsage(false, getErrMsg(msg));
+            }
         }
         {
             const { isProduction } = getGlobalContext();
             if (isHtml(templateVar) &&
                 // We don't show this warning in production because it's expected that some users may (un)willingly do some XSS injection: we avoid flooding the production logs.
                 !isProduction) {
-                assertWarning(false, getErrMsg(`${pc.cyan(templateVar)} which seems to be HTML code`, 'Did you forget to wrap the value with dangerouslySkipEscape()?'), { onlyOnce: false });
+                const msgVal = pc.cyan(String(templateVar));
+                const msg = `${msgVal} which seems to be HTML code. Did you forget to wrap the value with dangerouslySkipEscape()?`;
+                assertWarning(false, getErrMsg(msg), { onlyOnce: false });
             }
         }
         // Escape untrusted template variable

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

@@ -1,7 +1,7 @@
 export { projectInfo };
 export { PROJECT_VERSION };
-declare const PROJECT_VERSION: "0.4.171-commit-2e4e1ce";
+declare const PROJECT_VERSION: "0.4.171-commit-42245b5";
 declare const projectInfo: {
     projectName: "Vike";
-    projectVersion: "0.4.171-commit-2e4e1ce";
+    projectVersion: "0.4.171-commit-42245b5";
 };

package/dist/esm/utils/projectInfo.js

@@ -1,6 +1,6 @@
 export { projectInfo };
 export { PROJECT_VERSION };
-const PROJECT_VERSION = '0.4.171-commit-2e4e1ce';
+const PROJECT_VERSION = '0.4.171-commit-42245b5';
 const projectInfo = {
     projectName: 'Vike',
     projectVersion: PROJECT_VERSION

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vike",
-  "version": "0.4.171-commit-2e4e1ce",
+  "version": "0.4.171-commit-42245b5",
   "scripts": {
     "dev": "tsc --watch",
     "build": "rimraf dist/ && pnpm run build:esm && pnpm run build:cjs",