vike 0.4.218 → 0.4.219

package/dist/esm/node/plugin/plugins/{importBuild → buildEntry}/index.js

@@ -1,23 +1,23 @@
-export { importBuild };
+export { buildEntry };
 export { set_ASSETS_MAP };
 import { serverProductionEntryPlugin } from '@brillout/vite-plugin-server-entry/plugin';
+import { virtualFileIdImportUserCodeServer } from '../../../shared/virtual-files/virtualFileImportUserCode.js';
+import { getVikeManifest } from './getVikeManifest.js';
+import { getVikeConfig } from '../importUserCode/v1-design/getVikeConfig.js';
 import { assert, getOutDirs, toPosixPath } from '../../utils.js';
+import fs from 'fs/promises';
 import path from 'path';
 import { createRequire } from 'module';
-import { getVikeManifest } from './getVikeManifest.js';
-import fs from 'fs/promises';
-import { virtualFileIdImportUserCodeServer } from '../../../shared/virtual-files/virtualFileImportUserCode.js';
-import { getVikeConfig } from '../importUserCode/v1-design/getVikeConfig.js';
 // @ts-ignore Shimmed by dist-cjs-fixup.js for CJS build.
 const importMetaUrl = import.meta.url;
 const require_ = createRequire(importMetaUrl);
 const ASSETS_MAP = '__VITE_ASSETS_MAP__';
-function importBuild() {
+function buildEntry() {
     let config;
     let vikeConfigGlobal;
     return [
         {
-            name: 'vike:importBuild:config',
+            name: 'vike:buildEntry',
             enforce: 'post',
             async configResolved(config_) {
                 config = config_;
@@ -38,17 +38,16 @@ function getServerProductionEntryCode(config, vikeConfigGlobal) {
     const vikeManifest = getVikeManifest(vikeConfigGlobal, config);
     // Let's eventually simplify and move everything to a single virtual module
     const importerCode = [
-        `  import { setImportBuildGetters } from '${importPath}';`,
+        `  import { setGlobalContext_buildEntry } from '${importPath}';`,
         `  import * as pageFiles from '${virtualFileIdImportUserCodeServer}';`,
         `  {`,
         // We first set the values to a variable because of a Rollup bug, and this workaround doesn't work: https://github.com/vikejs/vike/commit/d5f3a4f7aae5a8bc44192e6cbb2bcb9007be188d
         `    const assetsManifest = ${ASSETS_MAP};`,
         `    const pluginManifest = ${JSON.stringify(vikeManifest, null, 2)};`,
-        '    setImportBuildGetters({',
-        `      pageFiles: () => pageFiles,`,
-        `      getAssetsManifest: () => assetsManifest,`,
-        // TODO: rename pluginManifest -> vikeManifest
-        `      pluginManifest: () => pluginManifest,`,
+        '    setGlobalContext_buildEntry({',
+        `      pageFiles,`,
+        `      assetsManifest,`,
+        `      pluginManifest,`,
         '    });',
         `  }`,
         ''
@@ -85,12 +84,12 @@ function find_ASSETS_MAP(bundle) {
 function getImportPath(config) {
     // We resolve filePathAbsolute even if we don't use it: we use require.resolve() as an assertion that the relative path is correct
     const filePathAbsolute = toPosixPath(
-    // [RELATIVE_PATH_FROM_DIST] Current file: node_modules/vike/dist/esm/node/plugin/plugins/importBuild/index.js
-    require_.resolve(`../../../../../../dist/esm/node/runtime/globalContext/loadImportBuild.js`));
+    // [RELATIVE_PATH_FROM_DIST] Current file: node_modules/vike/dist/esm/node/plugin/plugins/buildEntry/index.js
+    require_.resolve(`../../../../../../dist/esm/__internal/index.js`));
     if (
-    // Let's implement a new config if a user needs the import to be a relative path instead of 'vike/__internal/loadImportBuild' (AFAIK a relative path is needed only if a framework has npm package 'vike' as direct dependency instead of a peer dependency and if the user of that framework uses pnpm)
+    // Let's implement a new config if a user needs the import to be a relative path instead of 'vike/__internal' (AFAIK a relative path is needed only if a framework has npm package 'vike' as direct dependency instead of a peer dependency and if the user of that framework uses pnpm)
     true) {
-        return 'vike/__internal/loadImportBuild';
+        return 'vike/__internal';
     }
     else {
         const { outDirServer } = getOutDirs(config);

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

@@ -1,9 +1,12 @@
 export { commonConfig };
 import { type Plugin } from 'vite';
+import { type VikeConfigObject } from './importUserCode/v1-design/getVikeConfig.js';
 declare module 'vite' {
     interface UserConfig {
         _isDev?: boolean;
         _vikeVitePluginOptions?: unknown;
+        _root?: string;
+        vike?: VikeConfigObject;
     }
 }
 declare function commonConfig(vikeVitePluginOptions: unknown): Plugin[];

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

@@ -1,6 +1,6 @@
 export { commonConfig };
 import { mergeConfig } from 'vite';
-import { assert, assertUsage, assertWarning, findPackageJson, isDevCheck, isDocker } from '../utils.js';
+import { assert, assertUsage, assertWarning, findPackageJson, hasProp, isDevCheck, isDocker, isObject } from '../utils.js';
 import { assertRollupInput } from './buildConfig.js';
 import { installRequireShim_setUserRootDir } from '@brillout/require-shim';
 import pc from '@brillout/picocolors';
@@ -9,6 +9,9 @@ import { assertResolveAlias } from './commonConfig/assertResolveAlias.js';
 import { getEnvVarObject } from '../shared/getEnvVarObject.js';
 import { isViteCliCall } from '../shared/isViteCliCall.js';
 import { isVikeCliOrApi } from '../../api/context.js';
+import { getVikeConfig2 } from './importUserCode/v1-design/getVikeConfig.js';
+import { assertViteRoot, getViteRoot, normalizeViteRoot } from '../../api/prepareViteApiCall.js';
+import { temp_disablePrerenderAutoRun } from '../../prerender/isPrerenderAutoRunEnabled.js';
 const pluginName = 'vike:commonConfig';
 function commonConfig(vikeVitePluginOptions) {
     return [
@@ -17,10 +20,19 @@ function commonConfig(vikeVitePluginOptions) {
             enforce: 'pre',
             config: {
                 order: 'pre',
-                handler(_config, env) {
+                async handler(configFromUser, env) {
+                    const isDev = isDevCheck(env);
+                    const operation = env.command === 'build' ? 'build' : env.isPreview ? 'preview' : 'dev';
+                    const root = configFromUser.root ? normalizeViteRoot(configFromUser.root) : await getViteRoot(operation);
+                    assert(root);
+                    const vikeConfig = await getVikeConfig2(root, isDev, vikeVitePluginOptions);
                     return {
-                        _isDev: isDevCheck(env),
-                        _vikeVitePluginOptions: vikeVitePluginOptions
+                        _isDev: isDev,
+                        _root: root,
+                        _vikeVitePluginOptions: vikeVitePluginOptions,
+                        vike: vikeConfig,
+                        // TODO/v1-release: remove
+                        configVikePromise: Promise.resolve(vikeConfig.vikeConfigGlobal)
                     };
                 }
             }
@@ -28,6 +40,7 @@ function commonConfig(vikeVitePluginOptions) {
         {
             name: pluginName,
             configResolved(config) {
+                assertViteRoot(config._root, config);
                 assertSingleInstance(config);
                 installRequireShim_setUserRootDir(config.root);
             }
@@ -46,6 +59,7 @@ function commonConfig(vikeVitePluginOptions) {
                     assertResolveAlias(config);
                     assertEsm(config.root);
                     assertVikeCliOrApi(config);
+                    temp_supportOldInterface(config);
                 }
             },
             config: {
@@ -128,3 +142,24 @@ function assertVikeCliOrApi(config) {
         onlyOnce: true
     });
 }
+// TODO/v1-release: remove
+function temp_supportOldInterface(config) {
+    if (!('vitePluginSsr' in config))
+        return;
+    assert(isObject(config.vitePluginSsr));
+    if (hasProp(config.vitePluginSsr, 'prerender', 'object')) {
+        assert(hasProp(config.vitePluginSsr.prerender, 'disableAutoRun', 'boolean'));
+        if (config.vitePluginSsr.prerender.disableAutoRun) {
+            temp_disablePrerenderAutoRun();
+        }
+        return;
+    }
+    if (hasProp(config.vitePluginSsr, 'disableAutoFullBuild')) {
+        if (config.vitePluginSsr.disableAutoFullBuild) {
+            assert(config.vitePluginSsr.disableAutoFullBuild === 'prerender');
+            temp_disablePrerenderAutoRun();
+        }
+        return;
+    }
+    assert(false);
+}

package/dist/esm/node/plugin/plugins/importUserCode/getVirtualFileImportUserCode.d.ts

@@ -1,6 +1,6 @@
 export { getVirtualFileImportUserCode };
 import type { ResolvedConfig } from 'vite';
-import type { VikeConfigGlobal } from './v1-design/getVikeConfig/resolveVikeConfigGlobal.js';
+import type { VikeConfigGlobal } from './v1-design/getVikeConfig.js';
 declare function getVirtualFileImportUserCode(id: string, options: {
     ssr?: boolean;
 } | undefined, vikeConfigGlobal: VikeConfigGlobal, config: ResolvedConfig, isDev: boolean): Promise<string>;

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

@@ -1,12 +1,10 @@
-export { configDefinitionsBuiltIn };
-export { configDefinitionsBuiltInGlobal };
+export { configDefinitionsBuiltInAll };
 export type { ConfigDefinition };
 export type { ConfigDefinitions };
 export type { ConfigDefinitionInternal };
-export type { ConfigNameGlobal };
 export type { ConfigEffect };
 import type { ConfigEnvInternal, ConfigEnv, ConfigValueSources, DefinedAtFilePath } from '../../../../../../shared/page-configs/PageConfig.js';
-import type { Config, ConfigNameBuiltIn } from '../../../../../../shared/page-configs/Config.js';
+import type { Config, ConfigNameBuiltIn, ConfigNameGlobal } from '../../../../../../shared/page-configs/Config.js';
 import { type ConfigDefinedAt } from '../../../../../../shared/page-configs/getConfigDefinedAt.js';
 /** The meta definition of a config.
  *
@@ -46,7 +44,8 @@ type ConfigDefinition = {
      *
      * https://vike.dev/extends#inheritance
      */
-    global?: boolean;
+    global?: boolean | ((value: unknown) => boolean);
+    type?: string | string[];
 };
 /**
  * Function called when the config value is defined.
@@ -74,7 +73,5 @@ type ConfigDefinitionInternal = Omit<ConfigDefinition, 'env'> & {
 };
 type ConfigDefinitions = Record<string, // configName
 ConfigDefinitionInternal>;
-type ConfigDefinitionsBuiltIn = Record<ConfigNameBuiltIn, ConfigDefinitionInternal>;
-declare const configDefinitionsBuiltIn: ConfigDefinitionsBuiltIn;
-type ConfigNameGlobal = 'onPrerenderStart' | 'onBeforeRoute' | 'prerender' | 'disableAutoFullBuild' | 'includeAssetsImportedByServer' | 'baseAssets' | 'baseServer' | 'redirects' | 'trailingSlash' | 'disableUrlNormalization';
-declare const configDefinitionsBuiltInGlobal: Record<ConfigNameGlobal, ConfigDefinitionInternal>;
+type ConfigDefinitionsBuiltIn = Record<ConfigNameBuiltIn | ConfigNameGlobal, ConfigDefinitionInternal>;
+declare const configDefinitionsBuiltInAll: ConfigDefinitionsBuiltIn;

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

@@ -1,8 +1,7 @@
-export { configDefinitionsBuiltIn };
-export { configDefinitionsBuiltInGlobal };
+export { configDefinitionsBuiltInAll };
 import { assert, assertUsage } from '../../../../utils.js';
 import { getConfigDefinedAt } from '../../../../../../shared/page-configs/getConfigDefinedAt.js';
-const configDefinitionsBuiltIn = {
+const configDefinitionsBuiltInAll = {
     onRenderHtml: {
         env: { server: true }
     },
@@ -61,9 +60,6 @@ const configDefinitionsBuiltIn = {
     clientHooks: {
         env: { config: true }
     },
-    prerender: {
-        env: { config: true }
-    },
     hydrationCanBeAborted: {
         env: { client: true }
     },
@@ -132,27 +128,34 @@ const configDefinitionsBuiltIn = {
         env: { client: true }
     },
     // TODO/eventually: define it as a global config.
-    middleware: { env: { server: true }, cumulative: true, eager: true }
-};
-const configDefinitionsBuiltInGlobal = {
+    middleware: { env: { server: true }, cumulative: true, eager: true },
     onPrerenderStart: {
         env: { server: true, production: true },
-        eager: true
+        eager: true,
+        global: true
     },
     onBeforeRoute: {
         env: { server: true, client: 'if-client-routing' },
-        eager: true
-    },
-    prerender: {
-        env: { config: true }
-    },
-    disableAutoFullBuild: { env: { config: true } },
-    includeAssetsImportedByServer: { env: { config: true } },
-    baseAssets: { env: { config: true } },
-    baseServer: { env: { config: true } },
-    redirects: { env: { server: true } },
-    trailingSlash: { env: { server: true } },
-    disableUrlNormalization: { env: { server: true } }
+        eager: true,
+        global: true
+    },
+    prerender: { env: { config: true }, global: (value) => typeof value !== 'object', type: ['boolean', 'object'] },
+    vite: { env: { config: true }, global: true, cumulative: true, type: 'object' },
+    disableAutoFullBuild: {
+        env: { config: true },
+        global: true,
+        type: [
+            'boolean',
+            // Can be 'prerender'
+            'string'
+        ]
+    },
+    includeAssetsImportedByServer: { env: { config: true }, global: true, type: 'boolean' },
+    baseAssets: { env: { config: true }, global: true, type: 'string' },
+    baseServer: { env: { config: 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' }
 };
 function getConfigEnv(configValueSources, configName) {
     const configValueSource = getConfigValueSource(configValueSources, configName);

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

@@ -8,11 +8,13 @@ export { getConfigValueInterfaceFile };
 export type { VikeConfigObject };
 export type { InterfaceValueFile };
 export type { InterfaceFile };
+export type { VikeConfigGlobal };
+export type { VikeVitePluginOptions };
 import type { PageConfigGlobalBuildTime, PageConfigBuildTime } from '../../../../../shared/page-configs/PageConfig.js';
 import { type LocationId } from './getVikeConfig/filesystemRouting.js';
 import type { ResolvedConfig } from 'vite';
 import type { FilePathResolved } from '../../../../../shared/page-configs/FilePath.js';
-import type { VikeConfigGlobal } from './getVikeConfig/resolveVikeConfigGlobal.js';
+import { getPageConfigUserFriendlyNew } from '../../../../../shared/page-configs/getPageConfigUserFriendly.js';
 type InterfaceFile = InterfaceConfigFile | InterfaceValueFile;
 type InterfaceFileCommons = {
     locationId: LocationId;
@@ -37,6 +39,7 @@ type VikeConfigObject = {
     pageConfigs: PageConfigBuildTime[];
     pageConfigGlobal: PageConfigGlobalBuildTime;
     vikeConfigGlobal: VikeConfigGlobal;
+    global: ReturnType<typeof getPageConfigUserFriendlyNew>;
 };
 declare const vikeConfigDependencies: Set<string>;
 declare function reloadVikeConfig(config: ResolvedConfig): void;
@@ -47,3 +50,95 @@ declare function getVikeConfig2(userRootDir: string, isDev: boolean, vikeVitePlu
 declare function isV1Design(config: ResolvedConfig): Promise<boolean>;
 declare function isVikeConfigFile(filePath: string): boolean;
 declare function getConfigValueInterfaceFile(interfaceFile: InterfaceFile, configName: string): unknown;
+type VikeConfigGlobal = {
+    prerender: false | {
+        noExtraDir: boolean;
+        parallel: boolean | number;
+        partial: boolean;
+        disableAutoRun: boolean;
+    };
+    disableAutoFullBuild: boolean | 'prerender' | null;
+    includeAssetsImportedByServer: boolean;
+    baseAssets: string | null;
+    baseServer: string | null;
+    trailingSlash: boolean;
+    disableUrlNormalization: boolean;
+};
+type VikeVitePluginOptions = {
+    /**
+     * Enable pre-rendering.
+     *
+     * https://vike.dev/pre-rendering
+     *
+     * @default false
+     */
+    prerender?: boolean | {
+        /**
+         * Don't create a new directory for each HTML file.
+         *
+         * For example, generate `dist/client/about.html` instead of `dist/client/about/index.html`.
+         *
+         * @default false
+         */
+        noExtraDir?: boolean;
+        /**
+         * Number of concurrent pre-render jobs.
+         *
+         * Set to `false` to disable concurrency.
+         *
+         * @default os.cpus().length
+         */
+        parallel?: boolean | number;
+        /**
+     * Allow only some of your pages to be pre-rendered.
+     *
+     * This setting doesn't affect the pre-rendering process: it merely suppresses the warnings when some of your pages cannot be pre-rendered.
+ 
+     * @default false
+     */
+        partial?: boolean;
+        /**
+         * Disable the automatic initiation of the pre-rendering process when running `$ vike build`.
+         *
+         * Use this if you want to programmatically initiate the pre-rendering process instead.
+         *
+         * https://vike.dev/api#prerender
+         *
+         * @default false
+         */
+        disableAutoRun?: boolean;
+    };
+    /** @deprecated See https://vike.dev/disableAutoFullBuild */
+    disableAutoFullBuild?: boolean | 'prerender';
+    /** The Base URL of your server.
+     *
+     * https://vike.dev/base-url
+     */
+    baseServer?: string;
+    /** The Base URL of your static assets.
+     *
+     * https://vike.dev/base-url
+     */
+    baseAssets?: string;
+    /** @deprecated It's now `true` by default. You can remove this option. */
+    includeAssetsImportedByServer?: boolean;
+    /** Permanent redirections (HTTP status code 301)
+     *
+     * https://vike.dev/redirects
+     */
+    redirects?: Record<string, string>;
+    /** Whether URLs should end with a trailing slash.
+     *
+     * https://vike.dev/url-normalization
+     *
+     * @default false
+     */
+    trailingSlash?: boolean;
+    /** Disable automatic URL normalization.
+     *
+     * https://vike.dev/url-normalization
+     *
+     * @default false
+     */
+    disableUrlNormalization?: boolean;
+};