vike 0.4.224 → 0.4.225

package/dist/cjs/utils/assertSingleInstance.js

@@ -6,15 +6,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.assertSingleInstance_onClientEntryServerRouting = assertSingleInstance_onClientEntryServerRouting;
 exports.assertSingleInstance_onClientEntryClientRouting = assertSingleInstance_onClientEntryClientRouting;
 exports.assertSingleInstance_onAssertModuleLoad = assertSingleInstance_onAssertModuleLoad;
-//  - Throw error if there are two different versions of vike loaded
+//  - Show warning if there are two different Vike versions loaded
 //  - Show warning if entry of Client Routing and entry of Server Routing are both loaded
-//  - Show warning if vike is loaded twice
+//  - Show warning if Vike is loaded twice
 const unique_js_1 = require("./unique.js");
 const getGlobalObject_js_1 = require("./getGlobalObject.js");
-const projectInfo_js_1 = require("./projectInfo.js");
 const picocolors_1 = __importDefault(require("@brillout/picocolors"));
-/* Use original assertUsage() & assertWarning() after all CJS is removed from node_modules/vike/dist/
-import { assertUsage, assertWarning } from './assert.js'
+const PROJECT_VERSION_js_1 = require("./PROJECT_VERSION.js");
+/* Use original assertWarning() after all CJS is removed from node_modules/vike/dist/
+import { assertWarning } from './assert.js'
 */
 const globalObject = (0, getGlobalObject_js_1.getGlobalObject)('utils/assertSingleInstance.ts', {
     instances: [],
@@ -25,9 +25,10 @@ const clientNotSingleInstance = 'Client runtime loaded twice https://vike.dev/cl
 function assertSingleInstance() {
     {
         const versions = (0, unique_js_1.unique)(globalObject.instances);
-        assertUsage(versions.length <= 1, 
-        // DO *NOT* patch vike to remove this error: because of multiple conflicting versions, you *will* eventually encounter insidious issues that hard to debug and potentially a security hazard, see for example https://github.com/vikejs/vike/issues/1108
-        `vike@${picocolors_1.default.bold(versions[0])} and vike@${picocolors_1.default.bold(versions[1])} loaded but it's forbidden to load different versions`);
+        assertWarning(versions.length <= 1, 
+        // Do *NOT* patch Vike to remove this warning: you *will* eventually encounter the issues listed at https://vike.dev/warning/version-mismatch
+        // - This happened before: https://github.com/vikejs/vike/issues/1108#issuecomment-1719061509
+        `vike@${picocolors_1.default.bold(versions[0])} and vike@${picocolors_1.default.bold(versions[1])} loaded which is highly discouraged, see ${picocolors_1.default.underline('https://vike.dev/warning/version-mismatch')}`, { onlyOnce: true, showStackTrace: false });
     }
     if (globalObject.checkSingleInstance && globalObject.instances.length > 1) {
         /*/ Not sure whether circular dependency can cause problems? In principle not since client-side code is ESM.
@@ -67,21 +68,14 @@ function assertSingleInstance_onClientEntryClientRouting(isProduction) {
 }
 // Called by utils/assert.ts which is (most certainly) loaded by all entries. That way we don't have to call a callback for every entry. (There are a lot of entries: `client/router/`, `client/`, `node/runtime/`, `node/plugin/`, `node/cli`.)
 function assertSingleInstance_onAssertModuleLoad() {
-    globalObject.instances.push(projectInfo_js_1.projectInfo.projectVersion);
+    globalObject.instances.push(PROJECT_VERSION_js_1.PROJECT_VERSION);
     assertSingleInstance();
 }
-function assertUsage(condition, errorMessage) {
-    if (condition) {
-        return;
-    }
-    const errMsg = `[vike][Wrong Usage] ${errorMessage}`;
-    throw new Error(errMsg);
-}
 function assertWarning(condition, errorMessage, { onlyOnce, showStackTrace }) {
     if (condition) {
         return;
     }
-    const msg = `[vike][Warning] ${errorMessage}`;
+    const msg = `[Vike][Warning] ${errorMessage}`;
     if (onlyOnce) {
         const { alreadyLogged } = globalObject;
         const key = onlyOnce === true ? msg : onlyOnce;

package/dist/cjs/utils/debug.js

@@ -16,6 +16,8 @@ const isArray_js_1 = require("./isArray.js");
 // Avoid this to be loaded in the browser. For isomorphic code: instead of `import { createDebugger } from './utils.js'`, use `globalThis.createDebugger()`.
 (0, assert_js_1.assert)(!(0, isBrowser_js_1.isBrowser)());
 globalThis.__brillout_debug_createDebugger = createDebugger;
+// We purposely read process.env.DEBUG early, in order to avoid users from the temptation to set process.env.DEBUG with JavaScript, since reading & writing process.env.DEBUG dynamically leads to inconsistencies: for example https://github.com/vikejs/vike/issues/2239
+const DEBUG = getDEBUG() ?? '';
 const flags = [
     'vike:crawl',
     'vike:error',
@@ -150,7 +152,6 @@ function assertFlagsActivated() {
     });
 }
 function getFlagsActivated() {
-    const DEBUG = getDEBUG() ?? '';
     const flagsActivated = DEBUG.match(flagRegex) ?? [];
     const all = DEBUG.includes('vike:*');
     return { flagsActivated, all };

package/dist/cjs/utils/parseUrl-extras.js

@@ -94,6 +94,7 @@ function modifyUrlPathname(url, modifier) {
 function removeUrlOrigin(url) {
     const { origin, pathnameOriginal, searchOriginal, hashOriginal } = (0, parseUrl_js_1.parseUrl)(url, '/');
     const urlModified = (0, parseUrl_js_1.createUrlFromComponents)(null, pathnameOriginal, searchOriginal, hashOriginal);
+    (0, assert_js_1.assert)(urlModified.startsWith('/'));
     return { urlModified, origin };
 }
 function setUrlOrigin(url, origin) {

package/dist/esm/node/api/build.js

@@ -11,7 +11,7 @@ import { assertVersion } from './utils.js';
  * https://vike.dev/api#build
  */
 async function build(options = {}) {
-    const { viteConfigEnhanced, vikeConfig } = await prepareViteApiCall(options.viteConfig, 'build');
+    const { viteConfigEnhanced, vikeConfig } = await prepareViteApiCall(options, 'build');
     // Pass it to pluginAutoFullBuild()
     if (viteConfigEnhanced)
         viteConfigEnhanced._viteConfigEnhanced = viteConfigEnhanced;

package/dist/esm/node/api/context.d.ts

@@ -1,7 +1,13 @@
 export { isVikeCliOrApi };
 export { setContextApiOperation };
 export { clearContextApiOperation };
-import type { Operation } from './types.js';
+export { getApiOperation };
+import type { APIOptions, Operation } from './types.js';
+type ApiOperation = {
+    operation: Operation;
+    options: APIOptions;
+};
+declare function getApiOperation(): ApiOperation | null;
 declare function isVikeCliOrApi(): boolean;
-declare function setContextApiOperation(operation: Operation): void;
+declare function setContextApiOperation(operation: Operation, options: APIOptions): void;
 declare function clearContextApiOperation(): void;

package/dist/esm/node/api/context.js

@@ -1,19 +1,19 @@
 export { isVikeCliOrApi };
 export { setContextApiOperation };
 export { clearContextApiOperation };
+export { getApiOperation };
 import { assert, getGlobalObject } from './utils.js';
 const globalObject = getGlobalObject('api/context.ts', {});
 function getApiOperation() {
-    assert(globalObject.apiOperation);
-    return globalObject.apiOperation;
+    return globalObject.apiOperation ?? null;
 }
 function isVikeCliOrApi() {
     // The CLI uses the API
     return !!globalObject.apiOperation;
 }
-function setContextApiOperation(operation) {
+function setContextApiOperation(operation, options) {
     assert(!globalObject.apiOperation);
-    globalObject.apiOperation = operation;
+    globalObject.apiOperation = { operation, options };
 }
 function clearContextApiOperation() {
     globalObject.apiOperation = undefined;

package/dist/esm/node/api/dev.js

@@ -7,7 +7,7 @@ import { createServer } from 'vite';
  * https://vike.dev/api#dev
  */
 async function dev(options = {}) {
-    const { viteConfigEnhanced } = await prepareViteApiCall(options.viteConfig, 'dev');
+    const { viteConfigEnhanced } = await prepareViteApiCall(options, 'dev');
     const server = await createServer(viteConfigEnhanced);
     return {
         viteServer: server,

package/dist/esm/node/api/prepareViteApiCall.d.ts

@@ -3,9 +3,9 @@ export { getViteRoot };
 export { assertViteRoot };
 export { normalizeViteRoot };
 import type { InlineConfig, ResolvedConfig } from 'vite';
-import type { Operation } from './types.js';
+import type { APIOptions, Operation } from './types.js';
 import { type VikeConfigObject } from '../plugin/plugins/importUserCode/v1-design/getVikeConfig.js';
-declare function prepareViteApiCall(viteConfigFromOptions: InlineConfig | undefined, operation: Operation): Promise<{
+declare function prepareViteApiCall(options: APIOptions, operation: Operation): Promise<{
     vikeConfig: VikeConfigObject;
     viteConfigEnhanced: InlineConfig | undefined;
 }>;

package/dist/esm/node/api/prepareViteApiCall.js

@@ -10,9 +10,10 @@ import { assert, assertUsage, getGlobalObject, isObject, toPosixPath } from './u
 import pc from '@brillout/picocolors';
 import { clearGlobalContext } from '../runtime/globalContext.js';
 const globalObject = getGlobalObject('api/prepareViteApiCall.ts', {});
-async function prepareViteApiCall(viteConfigFromOptions, operation) {
+async function prepareViteApiCall(options, operation) {
     clear();
-    setContextApiOperation(operation);
+    setContextApiOperation(operation, options);
+    const viteConfigFromOptions = options.viteConfig;
     return enhanceViteConfig(viteConfigFromOptions, operation);
 }
 // For subsequent API calls, e.g. calling prerender() after build()

package/dist/esm/node/api/prerender.js

@@ -8,7 +8,7 @@ import { prepareViteApiCall } from './prepareViteApiCall.js';
  * https://vike.dev/api#prerender
  */
 async function prerender(options = {}) {
-    const { viteConfigEnhanced } = await prepareViteApiCall(options.viteConfig, 'prerender');
+    const { viteConfigEnhanced } = await prepareViteApiCall(options, 'prerender');
     options.viteConfig = viteConfigEnhanced;
     const { viteConfig } = await runPrerenderFromAPI(options);
     return {

package/dist/esm/node/api/preview.js

@@ -7,7 +7,7 @@ import { preview as previewVite } from 'vite';
  * https://vike.dev/api#preview
  */
 async function preview(options = {}) {
-    const { viteConfigEnhanced } = await prepareViteApiCall(options.viteConfig, 'preview');
+    const { viteConfigEnhanced } = await prepareViteApiCall(options, 'preview');
     const server = await previewVite(viteConfigEnhanced);
     return {
         viteServer: server,

package/dist/esm/node/api/types.d.ts

@@ -1,6 +1,7 @@
 export type { APIOptions };
 export type { Operation };
 import type { InlineConfig } from 'vite';
+import type { Config } from '../../shared/page-configs/Config.js';
 type APIOptions = {
     /**
      * Vite config.
@@ -8,5 +9,11 @@ type APIOptions = {
      * https://vike.dev/api
      */
     viteConfig?: InlineConfig;
+    /**
+     * Vike config.
+     *
+     * https://vike.dev/api
+     */
+    vikeConfig?: Config;
 };
 type Operation = 'build' | 'dev' | 'preview' | 'prerender';

package/dist/esm/node/cli/context.d.ts

@@ -1,5 +1,7 @@
 export { isVikeCli };
 export { setContextCliCommand };
-import type { Command } from './parseCli.js';
+export { getCliOptions };
+import type { CliOptions, Command } from './parseCli.js';
+declare function getCliOptions(): CliOptions | null;
 declare function isVikeCli(): boolean;
-declare function setContextCliCommand(command: Command): void;
+declare function setContextCliCommand(command: Command, cliOptions: CliOptions): void;

package/dist/esm/node/cli/context.js

@@ -1,14 +1,15 @@
 export { isVikeCli };
 export { setContextCliCommand };
+export { getCliOptions };
 import { assert, getGlobalObject } from './utils.js';
 const globalObject = getGlobalObject('cli/context.ts', {});
-function getCliCommand() {
-    return globalObject.cliCommand;
+function getCliOptions() {
+    return globalObject.cliCommand?.cliOptions ?? null;
 }
 function isVikeCli() {
     return !!globalObject.cliCommand;
 }
-function setContextCliCommand(command) {
+function setContextCliCommand(command, cliOptions) {
     assert(!globalObject.cliCommand);
-    globalObject.cliCommand = command;
+    globalObject.cliCommand = { command, cliOptions };
 }

package/dist/esm/node/cli/entry.js

@@ -1,12 +1,12 @@
-import { projectInfo } from './utils.js';
+import { PROJECT_VERSION } from './utils.js';
 import { dev, build, preview } from '../api/index.js';
 import pc from '@brillout/picocolors';
 import { parseCli } from './parseCli.js';
 import { setContextCliCommand } from './context.js';
 cli();
 async function cli() {
-    const { command } = parseCli();
-    setContextCliCommand(command);
+    const { command, cliOptions } = parseCli();
+    setContextCliCommand(command, cliOptions);
     if (command === 'dev') {
         await cmdDev();
     }
@@ -28,7 +28,7 @@ async function cmdDev() {
         const info = viteServer.config.logger.info;
         const startupDurationString = pc.dim(`ready in ${pc.reset(pc.bold(String(Math.ceil(performance.now() - startTime))))} ms`);
         const hasExistingLogs = process.stdout.bytesWritten > 0 || process.stderr.bytesWritten > 0;
-        info(`  ${pc.yellow(`${pc.bold(projectInfo.projectName)} v${projectInfo.projectVersion}`)}  ${startupDurationString}\n`, {
+        info(`  ${pc.yellow(`${pc.bold('Vike')} v${PROJECT_VERSION}`)}  ${startupDurationString}\n`, {
             clear: !hasExistingLogs
         });
         viteServer.printUrls();

package/dist/esm/node/cli/parseCli.d.ts

@@ -1,6 +1,9 @@
 export { parseCli };
 export type { Command };
+export type { CliOptions };
+type CliOptions = Record<string, unknown>;
 type Command = 'dev' | 'build' | 'preview' | 'prerender';
 declare function parseCli(): {
     command: Command;
+    cliOptions: CliOptions;
 };

package/dist/esm/node/cli/parseCli.js

@@ -1,6 +1,7 @@
 export { parseCli };
 import pc from '@brillout/picocolors';
-import { projectInfo, includes } from './utils.js';
+import { assert, includes, PROJECT_VERSION } from './utils.js';
+import { parseJson5 } from '../plugin/shared/getEnvVarObject.js';
 const commands = [
     { name: 'dev', desc: 'Start development server' },
     { name: 'build', desc: 'Build for production' },
@@ -8,32 +9,59 @@ const commands = [
     { name: 'prerender', desc: 'Pre-render pages (only needed when partial.disableAutoRun is true)' }
 ];
 function parseCli() {
-    const command = (() => {
-        const firstArg = process.argv[2];
-        if (!firstArg) {
-            showHelp();
-        }
-        showHelpOrVersion(firstArg);
-        if (includes(commands.map((c) => c.name), firstArg))
-            return firstArg;
-        wrongUsage(`Unknown command ${pc.bold(firstArg)}`);
-    })();
+    const command = getCommand();
+    const cliOptions = getCliOptions();
+    return { command, cliOptions };
+}
+function getCommand() {
+    const firstArg = process.argv[2];
+    if (includes(commands.map((c) => c.name), firstArg)) {
+        return firstArg;
+    }
+    if (!firstArg)
+        showHelp();
+    showHelpOrVersion(firstArg);
+    wrongUsage(`Unknown command ${pc.bold(firstArg)}`);
+}
+function getCliOptions() {
+    let cliOptions = {};
+    let configNameCurrent;
+    const commitIfDefinedWithoutValue = () => {
+        if (configNameCurrent)
+            commit(true);
+    };
+    const commit = (val) => {
+        assert(configNameCurrent);
+        cliOptions[configNameCurrent] = val;
+        configNameCurrent = undefined;
+    };
     for (const arg of process.argv.slice(3)) {
         showHelpOrVersion(arg);
-        wrongUsage(`Unknown option ${pc.bold(arg)}`);
+        if (arg.startsWith('--')) {
+            commitIfDefinedWithoutValue();
+            configNameCurrent = arg.slice('--'.length);
+        }
+        else {
+            if (!configNameCurrent)
+                wrongUsage(`Unknown option ${pc.bold(arg)}`);
+            commit(parseJson5(arg, `CLI option --${configNameCurrent}`));
+        }
     }
-    return { command };
+    commitIfDefinedWithoutValue();
+    return cliOptions;
 }
 function showHelp() {
     const TAB = ' '.repeat(3);
     const nameMaxLength = Math.max(...commands.map((c) => c.name.length));
     console.log([
-        `vike@${projectInfo.projectVersion}`,
+        `vike@${PROJECT_VERSION}`,
         '',
         'Usage:',
         ...[...commands, { name: '-v', desc: "Print Vike's installed version" }].map((c) => `  ${pc.dim('$')} ${pc.bold(`vike ${c.name}`)}${' '.repeat(nameMaxLength - c.name.length)}${TAB}${pc.dim(`# ${c.desc}`)}`),
         '',
-        `More infos at ${pc.underline('https://vike.dev/cli')}`
+        `Vike settings can be passed over the ${pc.cyan('VIKE_CONFIG')} environment variable or as ${pc.cyan('CLI options')} such as --host.`,
+        `Vite settings can be passed over the ${pc.cyan('VITE_CONFIG')} environment variable.`,
+        `See ${pc.underline('https://vike.dev/cli')} for more information.`
     ].join('\n'));
     process.exit(1);
 }
@@ -46,7 +74,7 @@ function showHelpOrVersion(arg) {
     }
 }
 function showVersion() {
-    console.log(projectInfo.projectVersion);
+    console.log(PROJECT_VERSION);
     process.exit(1);
 }
 function wrongUsage(msg) {

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

@@ -1,4 +1,4 @@
 export * from '../../utils/assert.js';
-export * from '../../utils/projectInfo.js';
+export * from '../../utils/PROJECT_VERSION.js';
 export * from '../../utils/includes.js';
 export * from '../../utils/getGlobalObject.js';

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

@@ -3,6 +3,6 @@
 import { onLoad } from './onLoad.js';
 onLoad();
 export * from '../../utils/assert.js';
-export * from '../../utils/projectInfo.js';
+export * from '../../utils/PROJECT_VERSION.js';
 export * from '../../utils/includes.js';
 export * from '../../utils/getGlobalObject.js';

package/dist/esm/node/plugin/plugins/build/pluginBuildEntry.js

@@ -2,7 +2,7 @@ export { pluginBuildEntry };
 export { set_macro_ASSETS_MANIFEST };
 import { serverProductionEntryPlugin } from '@brillout/vite-plugin-server-entry/plugin';
 import { virtualFileIdImportUserCodeServer } from '../../../shared/virtual-files/virtualFileImportUserCode.js';
-import { assert, projectInfo, toPosixPath } from '../../utils.js';
+import { assert, PROJECT_VERSION, toPosixPath } from '../../utils.js';
 import fs from 'fs/promises';
 import path from 'path';
 import { createRequire } from 'module';
@@ -35,7 +35,7 @@ function pluginBuildEntry() {
 function getServerProductionEntryCode(config) {
     const importPath = getImportPath(config);
     const buildInfo = {
-        versionAtBuildTime: projectInfo.projectVersion,
+        versionAtBuildTime: PROJECT_VERSION,
         usesClientRouter: isUsingClientRouter(), // TODO/v1-release: remove
         viteConfigRuntime: getViteConfigRuntime(config)
     };

package/dist/esm/node/plugin/plugins/commonConfig.d.ts

@@ -1,5 +1,6 @@
 export { commonConfig };
 export { getVikeConfigPublic };
+export type { VikeConfigPublic };
 import { type InlineConfig, type Plugin, type ResolvedConfig, type UserConfig } from 'vite';
 import { type VikeConfigObject } from './importUserCode/v1-design/getVikeConfig.js';
 import type { PrerenderContextPublic } from '../../prerender/runPrerender.js';

package/dist/esm/node/plugin/plugins/commonConfig.js

@@ -39,7 +39,7 @@ function commonConfig(vikeVitePluginOptions) {
                         },
                         // TODO/v1-release: remove https://github.com/vikejs/vike/issues/2122
                         configVikePromise: Promise.resolve({
-                            prerender: resolvePrerenderConfigGlobal(vikeConfig).isEnabled
+                            prerender: resolvePrerenderConfigGlobal(vikeConfig).isPrerenderingEnabled
                         })
                     };
                 }
@@ -73,11 +73,22 @@ function commonConfig(vikeVitePluginOptions) {
             config: {
                 order: 'post',
                 handler(configFromUser) {
-                    // Change default port
                     let configFromVike = { server: {}, preview: {} };
-                    setDefault('port', 3000, configFromUser, configFromVike);
-                    // Set `--host` for Docker/Podman
-                    if (isDocker()) {
+                    const vike = getVikeConfigPublic(configFromUser);
+                    if (vike.config.port !== undefined) {
+                        // https://vike.dev/port
+                        setDefault('port', vike.config.port, configFromUser, configFromVike);
+                    }
+                    else {
+                        // Change Vite's default port
+                        setDefault('port', 3000, configFromUser, configFromVike);
+                    }
+                    if (vike.config.host) {
+                        // https://vike.dev/host
+                        setDefault('host', vike.config.host, configFromUser, configFromVike);
+                    }
+                    else if (isDocker()) {
+                        // Set `--host` for Docker/Podman
                         setDefault('host', true, configFromUser, configFromVike);
                     }
                     // VITE_CONFIG

package/dist/esm/node/plugin/plugins/devConfig/determineOptimizeDeps.js

@@ -53,6 +53,8 @@ async function getPageDeps(config, pageConfigs) {
                     const { definedAtFilePath, configEnv } = configValueSource;
                     if (!configEnv.client)
                         return;
+                    if (definedAtFilePath.definedBy)
+                        return;
                     if (definedAtFilePath.filePathAbsoluteUserRootDir !== null) {
                         // Vite expects entries to be filesystem absolute paths (surprisingly so).
                         addEntry(definedAtFilePath.filePathAbsoluteFilesystem);

package/dist/esm/node/plugin/plugins/devConfig/index.js

@@ -79,7 +79,7 @@ function devConfig() {
                     if (config.server.middlewareMode || hasHonoViteDevServer)
                         return;
                     return () => {
-                        addSsrMiddleware(server.middlewares, config, false);
+                        addSsrMiddleware(server.middlewares, config, false, null);
                     };
                 }
             },

package/dist/esm/node/plugin/plugins/importUserCode/v1-design/getVikeConfig/configDefinitionsBuiltIn.d.ts

@@ -44,7 +44,9 @@ type ConfigDefinition = {
      *
      * https://vike.dev/extends#inheritance
      */
-    global?: boolean | ((value: unknown) => boolean);
+    global?: boolean | ((value: unknown, moreInfo: {
+        isGlobalLocation: boolean;
+    }) => boolean);
     type?: string | string[];
 };
 /**

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

@@ -123,6 +123,14 @@ const configDefinitionsBuiltIn = {
     cacheControl: {
         env: { server: true }
     },
+    host: {
+        env: { config: true },
+        global: true
+    },
+    port: {
+        env: { config: true },
+        global: true
+    },
     injectScriptsAt: {
         env: { server: true }
     },
@@ -148,7 +156,7 @@ const configDefinitionsBuiltIn = {
     },
     prerender: {
         env: { config: true },
-        global: (value) => typeof value === 'object',
+        global: (value, { isGlobalLocation }) => typeof value === 'object' || isGlobalLocation,
         type: ['boolean', 'object'],
         cumulative: true
     },