vike 0.4.220-commit-af5c91f → 0.4.221-commit-8577456

package/dist/cjs/node/plugin/plugins/importUserCode/v1-design/{assertExtensions.js → getVikeConfig/assertExtensions.js}

@@ -6,51 +6,51 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.assertExtensionsConventions = assertExtensionsConventions;
 exports.assertExtensionsRequire = assertExtensionsRequire;
 const picocolors_1 = __importDefault(require("@brillout/picocolors"));
-const isObjectOfStrings_js_1 = require("../../../../../utils/isObjectOfStrings.js");
-const utils_js_1 = require("../../../utils.js");
-const getVikeConfig_js_1 = require("./getVikeConfig.js");
+const isObjectOfStrings_js_1 = require("../../../../../../utils/isObjectOfStrings.js");
+const utils_js_1 = require("../../../../utils.js");
+const getVikeConfig_js_1 = require("../getVikeConfig.js");
 const path_1 = __importDefault(require("path"));
 const semver_1 = __importDefault(require("semver"));
-function assertExtensionsConventions(interfaceFile) {
-    assertExtensionName(interfaceFile);
-    assertConfigExportPath(interfaceFile);
+function assertExtensionsConventions(plusFile) {
+    assertExtensionName(plusFile);
+    assertConfigExportPath(plusFile);
 }
-function assertConfigExportPath(interfaceFile) {
-    const { importPathAbsolute, filePathAbsoluteFilesystem } = interfaceFile.filePath;
+function assertConfigExportPath(plusFile) {
+    const { importPathAbsolute, filePathAbsoluteFilesystem } = plusFile.filePath;
     // Ejected Vike extension
     if (!importPathAbsolute) {
         const p = filePathAbsoluteFilesystem;
         (0, utils_js_1.assert)(!p.includes('node_modules'));
         return;
     }
-    const name = getNameValue(interfaceFile);
+    const name = getNameValue(plusFile);
     (0, utils_js_1.assert)(name); // already asserted in assertExtensionName()
     const importPathAbsoluteExpected = `${name}/config`;
     (0, utils_js_1.assertWarning)(importPathAbsolute === importPathAbsoluteExpected, `The Vike configuration of ${picocolors_1.default.bold(name)} is exported at ${picocolors_1.default.bold(importPathAbsolute)}, but it should be exported at ${picocolors_1.default.bold(importPathAbsoluteExpected)} instead.`, { onlyOnce: true });
 }
-function assertExtensionName(interfaceFile) {
-    const filePathToShowToUser = getFilePathToShowToUser(interfaceFile);
-    const name = getNameValue(interfaceFile);
+function assertExtensionName(plusFile) {
+    const filePathToShowToUser = getFilePathToShowToUser(plusFile);
+    const name = getNameValue(plusFile);
     (0, utils_js_1.assertUsage)(name, `Vike extension name missing: the config ${filePathToShowToUser} must define the setting ${picocolors_1.default.cyan('name')}`);
 }
 function assertExtensionsRequire(pageConfig) {
-    const interfaceFilesRelevantList = Object.values(pageConfig.interfaceFiles).flat(1);
+    const plusFilesRelevantList = Object.values(pageConfig.plusFiles).flat(1);
     // Collect extensions
     const extensions = {};
-    interfaceFilesRelevantList.forEach((interfaceFile) => {
-        const name = getNameValue(interfaceFile);
+    plusFilesRelevantList.forEach((plusFile) => {
+        const name = getNameValue(plusFile);
         if (name) {
-            const version = getExtensionVersion(name, interfaceFile);
+            const version = getExtensionVersion(name, plusFile);
             extensions[name] = version;
         }
     });
     // Enforce `require`
-    interfaceFilesRelevantList.forEach((interfaceFile) => {
-        const require = getConfigRequireValue(interfaceFile);
+    plusFilesRelevantList.forEach((plusFile) => {
+        const require = getConfigRequireValue(plusFile);
         if (!require)
             return;
-        const name = getNameValue(interfaceFile);
-        const filePathToShowToUser = getFilePathToShowToUser(interfaceFile);
+        const name = getNameValue(plusFile);
+        const filePathToShowToUser = getFilePathToShowToUser(plusFile);
         (0, utils_js_1.assertUsage)(name, `Setting ${picocolors_1.default.bold('name')} is required for being able to use setting ${picocolors_1.default.bold('require')} in ${filePathToShowToUser}.`);
         Object.entries(require).forEach(([reqName, reqVersion]) => {
             const errBase = `${picocolors_1.default.bold(name)} requires ${picocolors_1.default.bold(reqName)}`;
@@ -64,36 +64,36 @@ function assertExtensionsRequire(pageConfig) {
         });
     });
 }
-function getConfigRequireValue(interfaceFile) {
-    const confVal = (0, getVikeConfig_js_1.getConfVal)(interfaceFile, 'require');
+function getConfigRequireValue(plusFile) {
+    const confVal = (0, getVikeConfig_js_1.getConfVal)(plusFile, 'require');
     if (!confVal)
         return null;
     (0, utils_js_1.assert)(confVal.configValueLoaded);
     const require = confVal.configValue;
-    const { filePathToShowToUserResolved } = interfaceFile.filePath;
+    const { filePathToShowToUserResolved } = plusFile.filePath;
     (0, utils_js_1.assert)(filePathToShowToUserResolved);
     (0, utils_js_1.assertUsage)((0, isObjectOfStrings_js_1.isObjectOfStrings)(require), `The setting ${picocolors_1.default.bold('require')} defined at ${filePathToShowToUserResolved} should be an object with string values (${picocolors_1.default.bold('Record<string, string>')}).`);
     return require;
 }
-function getNameValue(interfaceFile) {
-    const confVal = (0, getVikeConfig_js_1.getConfVal)(interfaceFile, 'name');
+function getNameValue(plusFile) {
+    const confVal = (0, getVikeConfig_js_1.getConfVal)(plusFile, 'name');
     if (!confVal)
         return null;
     (0, utils_js_1.assert)(confVal.configValueLoaded);
     const name = confVal.configValue;
-    const filePathToShowToUser = getFilePathToShowToUser(interfaceFile);
+    const filePathToShowToUser = getFilePathToShowToUser(plusFile);
     (0, utils_js_1.assertUsage)(typeof name === 'string', `The setting ${picocolors_1.default.bold('name')} defined at ${filePathToShowToUser} should be a string.`);
     return name;
 }
 // We use a forever cache: users need to restart the dev server anyways when touching node_modules/**/* (I presume Vite doesn't pick up node_modules/**/* changes).
 const extensionsVersion = {};
-function getExtensionVersion(name, interfaceFile) {
+function getExtensionVersion(name, plusFile) {
     if (!extensionsVersion[name]) {
-        const extensionConfigFilePath = interfaceFile.filePath.filePathAbsoluteFilesystem;
+        const extensionConfigFilePath = plusFile.filePath.filePathAbsoluteFilesystem;
         const found = (0, utils_js_1.findPackageJson)(path_1.default.posix.dirname(extensionConfigFilePath));
         (0, utils_js_1.assert)(found);
         const { packageJson, packageJsonPath } = found;
-        const filePathToShowToUser = getFilePathToShowToUser(interfaceFile);
+        const filePathToShowToUser = getFilePathToShowToUser(plusFile);
         const nameExpected = packageJson.name;
         (0, utils_js_1.assertWarning)(name === nameExpected, `The setting ${picocolors_1.default.bold('name')} defined at ${filePathToShowToUser} is ${picocolors_1.default.bold(JSON.stringify(name))}, but it should be equal to ${picocolors_1.default.bold(JSON.stringify(nameExpected))} (the value of ${packageJsonPath}${picocolors_1.default.dim('#')}${picocolors_1.default.bold('name')})`, { onlyOnce: true });
         const { version } = packageJson;
@@ -102,8 +102,8 @@ function getExtensionVersion(name, interfaceFile) {
     }
     return extensionsVersion[name];
 }
-function getFilePathToShowToUser(interfaceFile) {
-    const { filePathToShowToUserResolved } = interfaceFile.filePath;
+function getFilePathToShowToUser(plusFile) {
+    const { filePathToShowToUserResolved } = plusFile.filePath;
     (0, utils_js_1.assert)(filePathToShowToUserResolved);
     return filePathToShowToUserResolved;
 }

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

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.configDefinitionsBuiltInAll = void 0;
+exports.configDefinitionsBuiltIn = void 0;
 const utils_js_1 = require("../../../../utils.js");
 const getConfigDefinedAt_js_1 = require("../../../../../../shared/page-configs/getConfigDefinedAt.js");
-const configDefinitionsBuiltInAll = {
+const configDefinitionsBuiltIn = {
     onRenderHtml: {
         env: { server: true }
     },
@@ -89,11 +89,14 @@ const configDefinitionsBuiltInAll = {
         _computed: (configValueSources) => {
             {
                 const source = getConfigValueSource(configValueSources, 'clientHooks');
-                if (source && source.value !== null) {
-                    const { value } = source;
-                    const definedAt = (0, getConfigDefinedAt_js_1.getConfigDefinedAt)('Config', 'clientHooks', source.definedAtFilePath);
-                    (0, utils_js_1.assertUsage)(typeof value === 'boolean', `${definedAt} should be a boolean`);
-                    return value;
+                if (source) {
+                    (0, utils_js_1.assert)(source.valueIsLoaded);
+                    if (source.value !== null) {
+                        const { value } = source;
+                        const definedAt = (0, getConfigDefinedAt_js_1.getConfigDefinedAt)('Config', 'clientHooks', source.definedAtFilePath);
+                        (0, utils_js_1.assertUsage)(typeof value === 'boolean', `${definedAt} should be a boolean`);
+                        return value;
+                    }
                 }
             }
             return (isConfigSet(configValueSources, 'onRenderClient') &&
@@ -129,8 +132,7 @@ const configDefinitionsBuiltInAll = {
     keepScrollPosition: {
         env: { client: true }
     },
-    // TODO/eventually: define it as a global config.
-    middleware: { env: { server: true }, cumulative: true, eager: true },
+    middleware: { env: { server: true }, cumulative: true, eager: true, global: true },
     onPrerenderStart: {
         env: { server: true, production: true },
         eager: true,
@@ -157,14 +159,44 @@ const configDefinitionsBuiltInAll = {
             'string'
         ]
     },
-    includeAssetsImportedByServer: { env: { config: true }, global: true, type: 'boolean' },
-    baseAssets: { env: { config: true, server: true }, global: true, type: 'string' },
-    baseServer: { env: { config: true, server: true }, global: true, type: 'string' },
-    redirects: { env: { server: true }, global: true, type: 'string{}', cumulative: true },
-    trailingSlash: { env: { server: true }, global: true, type: 'boolean' },
-    disableUrlNormalization: { env: { server: true }, global: true, type: 'boolean' }
+    viteEnvironmentAPI: {
+        env: { config: true },
+        global: true,
+        type: 'boolean'
+    },
+    includeAssetsImportedByServer: {
+        env: { config: true },
+        global: true,
+        type: 'boolean'
+    },
+    baseAssets: {
+        env: { config: true, server: true },
+        global: true,
+        type: 'string'
+    },
+    baseServer: {
+        env: { config: true, server: true },
+        global: true,
+        type: 'string'
+    },
+    redirects: {
+        env: { server: true },
+        global: true,
+        type: 'string{}',
+        cumulative: true
+    },
+    trailingSlash: {
+        env: { server: true },
+        global: true,
+        type: 'boolean'
+    },
+    disableUrlNormalization: {
+        env: { server: true },
+        global: true,
+        type: 'boolean'
+    }
 };
-exports.configDefinitionsBuiltInAll = configDefinitionsBuiltInAll;
+exports.configDefinitionsBuiltIn = configDefinitionsBuiltIn;
 function getConfigEnv(configValueSources, configName) {
     const configValueSource = getConfigValueSource(configValueSources, configName);
     if (!configValueSource)
@@ -178,11 +210,11 @@ function getConfigEnv(configValueSources, configName) {
     return env;
 }
 function isConfigSet(configValueSources, configName) {
-    const configValueSource = getConfigValueSource(configValueSources, configName);
-    // Enable users to suppress global config values by overriding the config's value to null
-    if (configValueSource?.value === null)
-        return false;
-    return !!configValueSource;
+    const source = getConfigValueSource(configValueSources, configName);
+    return (!!source &&
+        !(source.valueIsLoaded &&
+            // Enable users to suppress inherited config by overriding it with `null`
+            source.value === null));
 }
 function getConfigValueSource(configValueSources, configName) {
     const sources = configValueSources[configName];

package/dist/cjs/node/plugin/plugins/importUserCode/v1-design/{getConfigFileExport.js → getVikeConfig/getConfigFileExport.js}

@@ -5,8 +5,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getConfigFileExport = getConfigFileExport;
 const picocolors_1 = __importDefault(require("@brillout/picocolors"));
-const assertPlusFileExport_js_1 = require("../../../../../shared/page-configs/assertPlusFileExport.js");
-const utils_js_1 = require("../../../utils.js");
+const assertPlusFileExport_js_1 = require("../../../../../../shared/page-configs/assertPlusFileExport.js");
+const utils_js_1 = require("../../../../utils.js");
 function getConfigFileExport(fileExports, filePathToShowToUser) {
     (0, assertPlusFileExport_js_1.assertPlusFileExport)(fileExports, filePathToShowToUser, 'config');
     const usesNamedExport = !!fileExports.config;

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

@@ -0,0 +1,159 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPlusFilesAll = getPlusFilesAll;
+exports.getPlusFileValueConfigName = getPlusFileValueConfigName;
+const utils_js_1 = require("../../../../utils.js");
+const configDefinitionsBuiltIn_js_1 = require("./configDefinitionsBuiltIn.js");
+const filesystemRouting_js_1 = require("./filesystemRouting.js");
+const transpileAndExecuteFile_js_1 = require("./transpileAndExecuteFile.js");
+const crawlPlusFiles_js_1 = require("./crawlPlusFiles.js");
+const getConfigFileExport_js_1 = require("./getConfigFileExport.js");
+const loadFileAtConfigTime_js_1 = require("./loadFileAtConfigTime.js");
+const resolvePointerImport_js_1 = require("./resolvePointerImport.js");
+const getFilePath_js_1 = require("../../../../shared/getFilePath.js");
+const assertExtensions_js_1 = require("./assertExtensions.js");
+const node_path_1 = __importDefault(require("node:path"));
+async function getPlusFilesAll(userRootDir, esbuildCache) {
+    const plusFiles = await findPlusFiles(userRootDir, null);
+    const configFiles = [];
+    const valueFiles = [];
+    plusFiles.forEach((f) => {
+        if (getPlusFileValueConfigName(f.filePathAbsoluteFilesystem) === 'config') {
+            configFiles.push(f);
+        }
+        else {
+            valueFiles.push(f);
+        }
+    });
+    let plusFilesAll = {};
+    await Promise.all([
+        // Config files
+        ...configFiles.map(async (filePath) => {
+            const { filePathAbsoluteUserRootDir } = filePath;
+            (0, utils_js_1.assert)(filePathAbsoluteUserRootDir);
+            const { configFile, extendsConfigs } = await (0, loadFileAtConfigTime_js_1.loadConfigFile)(filePath, userRootDir, [], false, esbuildCache);
+            (0, utils_js_1.assert)(filePath.filePathAbsoluteUserRootDir);
+            const locationId = (0, filesystemRouting_js_1.getLocationId)(filePathAbsoluteUserRootDir);
+            const plusFile = getPlusFileFromConfigFile(configFile, false, locationId, userRootDir);
+            plusFilesAll[locationId] = plusFilesAll[locationId] ?? [];
+            plusFilesAll[locationId].push(plusFile);
+            extendsConfigs.forEach((extendsConfig) => {
+                /* We purposely use the same locationId because the Vike extension's config should only apply to where it's being extended from, for example:
+                ```js
+                // /pages/admin/+config.js
+        
+                import vikeVue from 'vike-vue/config'
+                // Should only apply to /pages/admin/**
+                export default { extends: [vikeVue] }
+                ```
+                ```js
+                // /pages/marketing/+config.js
+        
+                import vikeReact from 'vike-react/config'
+                // Should only apply to /pages/marketing/**
+                export default { extends: [vikeReact] }
+                ```
+                */
+                const plusFile = getPlusFileFromConfigFile(extendsConfig, true, locationId, userRootDir);
+                (0, assertExtensions_js_1.assertExtensionsConventions)(plusFile);
+                plusFilesAll[locationId].push(plusFile);
+            });
+        }),
+        // Value files
+        ...valueFiles.map(async (filePath) => {
+            const { filePathAbsoluteUserRootDir } = filePath;
+            (0, utils_js_1.assert)(filePathAbsoluteUserRootDir);
+            const configName = getPlusFileValueConfigName(filePathAbsoluteUserRootDir);
+            (0, utils_js_1.assert)(configName);
+            const locationId = (0, filesystemRouting_js_1.getLocationId)(filePathAbsoluteUserRootDir);
+            const plusFile = {
+                locationId,
+                filePath,
+                isConfigFile: false,
+                isNotLoaded: true,
+                configName
+            };
+            plusFilesAll[locationId] = plusFilesAll[locationId] ?? [];
+            plusFilesAll[locationId].push(plusFile);
+            // We don't have access to the custom config definitions defined by the user yet.
+            //  - If `configDef` is `undefined` => we load the file +{configName}.js later.
+            //  - We already need to load +meta.js here (to get the custom config definitions defined by the user)
+            await (0, loadFileAtConfigTime_js_1.loadValueFile)(plusFile, configDefinitionsBuiltIn_js_1.configDefinitionsBuiltIn, userRootDir, esbuildCache);
+        })
+    ]);
+    // Make lists element order deterministic
+    Object.entries(plusFilesAll).forEach(([_locationId, plusFiles]) => {
+        plusFiles.sort(sortMakeDeterministic);
+    });
+    return plusFilesAll;
+}
+function getPlusFileFromConfigFile(configFile, isExtensionConfig, locationId, userRootDir) {
+    const { fileExports, filePath, extendsFilePaths } = configFile;
+    const fileExportsByConfigName = {};
+    const pointerImportsByConfigName = {};
+    const fileExport = (0, getConfigFileExport_js_1.getConfigFileExport)(fileExports, filePath.filePathToShowToUser);
+    Object.entries(fileExport).forEach(([configName, configValue]) => {
+        fileExportsByConfigName[configName] = configValue;
+        const pointerImport = (0, resolvePointerImport_js_1.resolvePointerImport)(configValue, configFile.filePath, userRootDir, configName);
+        if (pointerImport) {
+            pointerImportsByConfigName[configName] = {
+                ...pointerImport,
+                fileExportValueLoaded: false
+            };
+        }
+    });
+    const plusFile = {
+        locationId,
+        filePath,
+        fileExportsByConfigName,
+        pointerImportsByConfigName,
+        isConfigFile: true,
+        isExtensionConfig,
+        extendsFilePaths
+    };
+    return plusFile;
+}
+// Make order deterministic (no other purpose)
+function sortMakeDeterministic(plusFile1, plusFile2) {
+    return plusFile1.filePath.filePathAbsoluteVite < plusFile2.filePath.filePathAbsoluteVite ? -1 : 1;
+}
+async function findPlusFiles(userRootDir, outDirRoot) {
+    const files = await (0, crawlPlusFiles_js_1.crawlPlusFiles)(userRootDir, outDirRoot);
+    const plusFiles = files.map(({ filePathAbsoluteUserRootDir }) => (0, getFilePath_js_1.getFilePathResolved)({ filePathAbsoluteUserRootDir, userRootDir }));
+    return plusFiles;
+}
+function getPlusFileValueConfigName(filePath) {
+    (0, utils_js_1.assertPosixPath)(filePath);
+    if ((0, transpileAndExecuteFile_js_1.isTemporaryBuildFile)(filePath))
+        return null;
+    const fileName = node_path_1.default.posix.basename(filePath);
+    // assertNoUnexpectedPlusSign(filePath, fileName)
+    const basename = fileName.split('.')[0];
+    if (!basename.startsWith('+')) {
+        return null;
+    }
+    else {
+        const configName = basename.slice(1);
+        (0, utils_js_1.assertUsage)(configName !== '', `${filePath} Invalid filename ${fileName}`);
+        return configName;
+    }
+}
+/* https://github.com/vikejs/vike/issues/1407
+function assertNoUnexpectedPlusSign(filePath: string, fileName: string) {
+  const dirs = path.posix.dirname(filePath).split('/')
+  dirs.forEach((dir, i) => {
+    const dirPath = dirs.slice(0, i + 1).join('/')
+    assertUsage(
+      !dir.includes('+'),
+      `Character '+' is a reserved character: remove '+' from the directory name ${dirPath}/`
+    )
+  })
+  assertUsage(
+    !fileName.slice(1).includes('+'),
+    `Character '+' is only allowed at the beginning of filenames: make sure ${filePath} doesn't contain any '+' in its filename other than its first letter`
+  )
+}
+*/

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

@@ -13,7 +13,7 @@ const getVikeConfig_js_1 = require("../getVikeConfig.js");
 const assertPlusFileExport_js_1 = require("../../../../../../shared/page-configs/assertPlusFileExport.js");
 const picocolors_1 = __importDefault(require("@brillout/picocolors"));
 const transformPointerImports_js_1 = require("./transformPointerImports.js");
-const getConfigFileExport_js_1 = require("../getConfigFileExport.js");
+const getConfigFileExport_js_1 = require("./getConfigFileExport.js");
 const resolvePointerImport_js_1 = require("./resolvePointerImport.js");
 const getConfigDefinedAt_js_1 = require("../../../../../../shared/page-configs/getConfigDefinedAt.js");
 (0, utils_js_1.assertIsNotProductionRuntime)();
@@ -41,8 +41,8 @@ async function loadValueFile(interfaceValueFile, configDefinitions, userRootDir,
     // Only load value files with `env.config===true`
     if (!configDef || !shouldBeLoadableAtBuildTime(configDef))
         return;
-    interfaceValueFile.isValueFileLoaded = true;
-    (0, utils_js_1.assert)(interfaceValueFile.isValueFileLoaded);
+    interfaceValueFile.isNotLoaded = false;
+    (0, utils_js_1.assert)(!interfaceValueFile.isNotLoaded);
     interfaceValueFile.fileExportsByConfigName = {};
     const { fileExports } = await (0, transpileAndExecuteFile_js_1.transpileAndExecuteFile)(interfaceValueFile.filePath, userRootDir, false, esbuildCache);
     const { filePathToShowToUser } = interfaceValueFile.filePath;