vike 0.4.212-commit-962127b → 0.4.213

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

@@ -1,5 +1,5 @@
-// Utils needed by Vike's Vite plugin.
-// We assume all runtime entries will load this utils.ts file
+// Utils needed by Vike's Vite plugin
+// We call onLoad() here so that it's called even when only a subset of the plugin is loaded. (Making the assert() calls inside onLoad() a lot stronger.)
 import { onLoad } from './onLoad.js';
 onLoad();
 // We tolerate the fact that we load all of the runtime utils even though some of it isn't needed

package/dist/esm/node/prerender/index.d.ts

@@ -1 +1 @@
-export { runPrerenderFromAPI as prerender } from './runPrerender.js';
+export { prerender } from '../api/prerender.js';

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

@@ -1 +1,5 @@
-export { runPrerenderFromAPI as prerender } from './runPrerender.js';
+// TODO/v1-release: remove this file
+export { prerender } from '../api/prerender.js';
+import { assertWarning } from '../../utils/assert.js';
+import pc from '@brillout/picocolors';
+assertWarning(false, `${pc.cyan("import { prerender } from 'vike/prerender'")} is deprecated in favor of ${pc.cyan("import { prerender } from 'vike/api'")}`, { onlyOnce: true });

package/dist/esm/node/prerender/runPrerender.d.ts

@@ -1,36 +1,15 @@
 export { runPrerenderFromAPI };
-export { runPrerenderFromCLI };
-export { runPrerenderFromAutoFullBuild };
+export { runPrerenderFromCLIPrerenderCommand };
+export { runPrerenderFromAutoRun };
 export { runPrerender_forceExit };
 export type { PrerenderOptions };
 import '../runtime/page-files/setup.js';
 import type { InlineConfig } from 'vite';
-type PrerenderOptions = {
+import type { APIOptions } from '../api/APIOptions.js';
+type PrerenderOptions = APIOptions & {
     /** Initial `pageContext` values */
     pageContextInit?: Record<string, unknown>;
-    /**
-     * The Vite config.
-     *
-     * This is optional and, if omitted, then Vite will automatically load your `vite.config.js`.
-     *
-     * We recommend to either omit this option or set it to `prerender({ viteConfig: { root }})`: the `vite.config.js` file living at `root` will be loaded.
-     *
-     * Alternatively you can:
-     *  - Set `prerender({ viteConfig: { configFile: './path/to/vite.config.js' }})`.
-     *  - Not load any `vite.config.js` file and, instead, use `prerender({ viteConfig: { configFile: false, ...myViteConfig }})` to programmatically define the entire Vite config.
-     *
-     * You can also load a `vite.config.js` file while overriding parts of the Vite config.
-     *
-     * See https://vitejs.dev/guide/api-javascript.html#inlineconfig for more information.
-     *
-     * @default { root: process.cwd() }
-     *
-     */
-    viteConfig?: InlineConfig;
-    /**
-     * @internal
-     * Don't use without having talked to a vike maintainer.
-     */
+    /** @experimental Don't use without having talked to a vike maintainer. */
     onPagePrerender?: Function;
     /** @deprecated Define `prerender({ viteConfig: { root }})` instead. */
     root?: string;
@@ -48,6 +27,6 @@ type PrerenderOptions = {
     base?: string;
 };
 declare function runPrerenderFromAPI(options?: PrerenderOptions): Promise<void>;
-declare function runPrerenderFromCLI(options: PrerenderOptions): Promise<void>;
-declare function runPrerenderFromAutoFullBuild(options: PrerenderOptions): Promise<void>;
+declare function runPrerenderFromCLIPrerenderCommand(): Promise<void>;
+declare function runPrerenderFromAutoRun(viteConfig: InlineConfig, forceExit: boolean): Promise<void>;
 declare function runPrerender_forceExit(): void;

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

@@ -1,6 +1,6 @@
 export { runPrerenderFromAPI };
-export { runPrerenderFromCLI };
-export { runPrerenderFromAutoFullBuild };
+export { runPrerenderFromCLIPrerenderCommand };
+export { runPrerenderFromAutoRun };
 export { runPrerender_forceExit };
 import '../runtime/page-files/setup.js';
 import path from 'path';
@@ -28,32 +28,38 @@ import { getVikeConfig } from '../plugin/plugins/importUserCode/v1-design/getVik
 import { logErrorHint } from '../runtime/renderPage/logErrorHint.js';
 import { executeHook, isUserHookError } from '../../shared/hooks/executeHook.js';
 import { getConfigValueBuildTime } from '../../shared/page-configs/getConfigValueBuildTime.js';
+import { enhanceViteConfig } from '../api/enhanceViteConfig.js';
 async function runPrerenderFromAPI(options = {}) {
     await runPrerender(options, 'prerender()');
     // - We purposely propagate the error to the user land, so that the error interrupts the user land. It's also, I guess, a nice-to-have that the user has control over the error.
     // - We don't use logErrorHint() because we don't have control over what happens with the error. For example, if the user land purposely swallows the error then the hint shouldn't be logged. Also, it's best if the hint is shown to the user *after* the error, but we cannot do/guarentee that.
 }
-async function runPrerenderFromCLI(options) {
+async function runPrerenderFromCLIPrerenderCommand() {
     try {
-        await runPrerender(options, '$ vike prerender');
+        const { viteConfigEnhanced } = await enhanceViteConfig(undefined, 'prerender');
+        await runPrerender({ viteConfig: viteConfigEnhanced }, '$ vike prerender');
     }
     catch (err) {
         console.error(err);
+        // Error may come from user-land; we need to use logErrorHint()
         logErrorHint(err);
         process.exit(1);
     }
+    runPrerender_forceExit();
 }
-async function runPrerenderFromAutoFullBuild(options) {
+async function runPrerenderFromAutoRun(viteConfig, forceExit) {
     try {
-        await runPrerender(options, null);
+        await runPrerender({ viteConfig });
     }
     catch (err) {
         console.error(err);
         logErrorHint(err);
         process.exit(1);
     }
+    if (forceExit)
+        runPrerender_forceExit();
 }
-async function runPrerender(options, manuallyTriggered) {
+async function runPrerender(options = {}, standaloneTrigger) {
     checkOutdatedOptions(options);
     setGlobalContext_isPrerendering();
     getHook_setIsPrerenderering();
@@ -70,8 +76,8 @@ async function runPrerender(options, manuallyTriggered) {
     const { root } = viteConfig;
     const prerenderConfig = configVike.prerender;
     if (!prerenderConfig) {
-        assert(manuallyTriggered);
-        assertWarning(prerenderConfig, `You're executing ${pc.cyan(manuallyTriggered)} but the config ${pc.cyan('prerender')} isn't set to true`, {
+        assert(standaloneTrigger);
+        assertWarning(prerenderConfig, `You're executing ${pc.cyan(standaloneTrigger)} but the config ${pc.cyan('prerender')} isn't set to true`, {
             onlyOnce: true
         });
     }

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

@@ -216,7 +216,7 @@ function assertBuildEntries(buildEntries, isPreRendering) {
     const errMsg = [
         `You are tyring to run`,
         isPreRendering ? 'pre-rendering' : 'the server for production',
-        `but your app isn't built yet. Run ${pc.cyan('$ vite build')} before `,
+        `but your app isn't built yet. Run ${pc.cyan('$ vike build')} before `,
         isPreRendering ? 'pre-rendering.' : 'running the server.'
     ].join(' ');
     assertUsage(buildEntries, errMsg);

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

@@ -1,5 +1,6 @@
+// Utils needed by Vike's server runtime
 import '../../utils/trackLogs.js';
-// We assume all runtime entries will load this utils.ts file
+// We call onLoad() here so that it's called even when only a subset of the runtime is loaded. (Making the assert() calls inside onLoad() a lot stronger.)
 import { onLoad } from './onLoad.js';
 onLoad();
 export * from '../../utils/assert.js';

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

@@ -52,7 +52,7 @@ type ConfigVikeUserProvided = {
          */
         partial?: boolean;
         /**
-         * Disable the automatic initiation of the pre-rendering process when running `$ vite build`.
+         * 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.
          *
@@ -62,13 +62,7 @@ type ConfigVikeUserProvided = {
          */
         disableAutoRun?: boolean;
     };
-    /**
-     * Disable the automatic chaining of build steps.
-     *
-     * https://vike.dev/disableAutoFullBuild
-     *
-     * @default false
-     */
+    /** @deprecated See https://vike.dev/disableAutoFullBuild */
     disableAutoFullBuild?: boolean | 'prerender';
     /** The Base URL of your server.
      *

package/dist/esm/shared/page-configs/Config.d.ts

@@ -345,7 +345,7 @@ type ConfigBuiltIn = {
      */
     meta?: ConfigMeta | ImportString;
     /**
-     * @experimental: DON'T USE: the API *will* have breaking changes upon any minor version release.
+     * @experimental DON'T USE: the API *will* have breaking changes upon any minor version release.
      *
      * Prefetch pages/links.
      *

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

@@ -1 +1 @@
-export declare const PROJECT_VERSION: "0.4.212-commit-962127b";
+export declare const PROJECT_VERSION: "0.4.213";

package/dist/esm/utils/PROJECT_VERSION.js

@@ -1,2 +1,2 @@
 // Automatically updated by @brillout/release-me
-export const PROJECT_VERSION = '0.4.212-commit-962127b';
+export const PROJECT_VERSION = '0.4.213';

package/dist/esm/utils/assertNodeEnv.js

@@ -34,7 +34,7 @@ function assertNodeEnv_runtime(isViteDev) {
         return;
     const nodeEnvDesc = getNodeEnvDesc();
     // TODO: make it assertUsage() again once #1528 is implemented.
-    const errMsg = `Running ${isViteDev ? pc.cyan('$ vite dev') : 'app in production'} while the ${nodeEnvDesc} which is contradictory, see https://vike.dev/NODE_ENV`;
+    const errMsg = `Running ${isViteDev ? pc.cyan('$ vike dev') : 'app in production'} while the ${nodeEnvDesc} which is contradictory, see https://vike.dev/NODE_ENV`;
     assertWarning(false, errMsg, { onlyOnce: true });
 }
 function assertNodeEnv_onVikePluginLoad() {

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

@@ -1,4 +1,4 @@
 export declare const projectInfo: {
     projectName: "Vike";
-    projectVersion: "0.4.212-commit-962127b";
+    projectVersion: "0.4.213";
 };

package/dist-cjs-fixup.mjs

@@ -0,0 +1,41 @@
+import fs from 'fs/promises'
+import path from 'path'
+const distCjs = 'dist/cjs'
+
+main()
+
+async function main() {
+  await generatePackageJson()
+  await shimImportMetaUrl()
+}
+
+async function generatePackageJson() {
+  await fs.writeFile(distCjs + '/package.json', '{ "type": "commonjs" }\n', 'utf8')
+  console.log(`✅ ${distCjs}/package.json generated`)
+}
+
+async function shimImportMetaUrl() {
+  const files = await getFiles(distCjs)
+  files.forEach(replaceImportMetaWithFilename)
+  console.log(`✅ ${distCjs}/ shimmed import.meta.url`)
+}
+
+async function replaceImportMetaWithFilename(filePath) {
+  const fileContent = await fs.readFile(filePath, 'utf8')
+  const modifiedContent = fileContent.replaceAll('import.meta.url', '`file://${__filename}`')
+  await fs.writeFile(filePath, modifiedContent, 'utf8')
+}
+
+async function getFiles(directoryPath) {
+  const files = []
+  for (const file of await fs.readdir(directoryPath)) {
+    const filePath = path.join(directoryPath, file)
+    const stats = await fs.stat(filePath)
+    if (stats.isDirectory()) {
+      files.push(...(await getFiles(filePath)))
+    } else if (stats.isFile() && filePath.endsWith('.js')) {
+      files.push(filePath)
+    }
+  }
+  return files
+}

package/getPageContext.js

@@ -0,0 +1,3 @@
+// Some tools still need this as of January 2025
+export * from './dist/esm/shared/getPageContext.js'
+export { default } from './dist/esm/shared/getPageContext.js'

package/modifyUrl.js

@@ -0,0 +1,3 @@
+// Some tools still need this as of January 2025
+export * from './dist/esm/shared/modifyUrl.js'
+export { default } from './dist/esm/shared/modifyUrl.js'

package/node/cli/bin.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+import '../../dist/esm/node/cli/entry.js'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vike",
-  "version": "0.4.212-commit-962127b",
+  "version": "0.4.213",
   "repository": "https://github.com/vikejs/vike",
   "exports": {
     "./server": {
@@ -42,6 +42,12 @@
       "types": "./dist/esm/node/cli/index.d.ts",
       "default": "./dist/esm/node/cli/index.js"
     },
+    "./api": {
+      "require": "./dist/cjs/node/api/index.js",
+      "node": "./dist/esm/node/api/index.js",
+      "types": "./dist/esm/node/api/index.d.ts",
+      "default": "./dist/esm/node/api/index.js"
+    },
     "./prerender": {
       "require": "./dist/cjs/node/prerender/index.js",
       "node": "./dist/esm/node/prerender/index.js",
@@ -131,6 +137,7 @@
     "es-module-lexer": "^1.0.0",
     "esbuild": "^0.19.0 || ^0.20.0 || ^0.21.0 || ^0.22.0 || ^0.23.0 || ^0.24.0",
     "fast-glob": "^3.0.0",
+    "json5": "^2.0.0",
     "semver": "^7.0.0",
     "source-map-support": "^0.5.0"
   },
@@ -176,6 +183,9 @@
       "cli": [
         "./dist/esm/node/cli/index.d.ts"
       ],
+      "api": [
+        "./dist/esm/node/api/index.d.ts"
+      ],
       "prerender": [
         "./dist/esm/node/prerender/index.d.ts"
       ],
@@ -206,21 +216,28 @@
   "types": "./dist/esm/node/runtime/index-deprecated.d.ts",
   "type": "module",
   "bin": {
-    "vike": "./node/cli/bin-entry.js"
+    "vike": "./node/cli/bin.js"
   },
   "files": [
-    "dist/",
-    "cli.js",
-    "client.js",
-    "client/router.js",
-    "plugin.js",
-    "prerender.js",
-    "routing.js",
-    "abort.js",
-    "RenderErrorPage.js",
-    "server.js",
-    "__internal.js",
-    "__internal/setup.js"
+    "./node/cli/bin.js",
+    "./dist/",
+    "./abort.js",
+    "./api.js",
+    "./client.js",
+    "./client/router.js",
+    "./cli.js",
+    "./dist-cjs-fixup.mjs",
+    "./getPageContext.js",
+    "./__internal.js",
+    "./__internal/loadImportBuild.js",
+    "./__internal/setup.js",
+    "./modifyUrl.js",
+    "./plugin.js",
+    "./prerender.js",
+    "./RenderErrorPage.js",
+    "./routing.js",
+    "./server.js",
+    "./types.js"
   ],
   "devDependencies": {
     "@biomejs/biome": "^1.5.3",

package/types.js

@@ -0,0 +1,3 @@
+// Some tools still need this as of January 2025
+export * from './dist/esm/types/index.js'
+export { default } from './dist/esm/types/index.js'

package/dist/cjs/node/cli/bin.js

@@ -1,49 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const cac_1 = require("cac");
-const path_1 = require("path");
-const runPrerender_js_1 = require("../prerender/runPrerender.js");
-const utils_js_1 = require("./utils.js");
-const picocolors_1 = __importDefault(require("@brillout/picocolors"));
-const cli = (0, cac_1.cac)(utils_js_1.projectInfo.projectName);
-cli
-    .command('prerender', 'Pre-render the HTML of your pages', { allowUnknownOptions: true })
-    .option('--configFile <path>', '[string] Path to vite.config.js')
-    .action(async (options) => {
-    assertOptions();
-    const { partial, noExtraDir, base, parallel, outDir, configFile } = options;
-    const root = options.root && (0, path_1.resolve)(options.root);
-    await (0, runPrerender_js_1.runPrerenderFromCLI)({ partial, noExtraDir, base, root, parallel, outDir, configFile });
-    (0, runPrerender_js_1.runPrerender_forceExit)();
-});
-function assertOptions() {
-    // Using process.argv because cac convert names to camelCase
-    const rawOptions = process.argv.slice(3);
-    Object.values(rawOptions).forEach((option) => {
-        (0, utils_js_1.assertUsage)(!option.startsWith('--') ||
-            [
-                '--root',
-                '--partial',
-                '--noExtraDir',
-                '--clientRouter',
-                '--base',
-                '--parallel',
-                '--outDir',
-                '--configFile'
-            ].includes(option), 'Unknown option: ' + option);
-        (0, utils_js_1.assertWarning)(false, `You set ${picocolors_1.default.cyan(option)}, but passing options to ${picocolors_1.default.cyan('$ vike prerender')} is deprecated: use the config file instead. See https://vike.dev/command-prerender.`, { onlyOnce: true });
-    });
-}
-// Listen to unknown commands
-cli.on('command:*', () => {
-    (0, utils_js_1.assertUsage)(false, 'Unknown command: ' + cli.args.join(' '));
-});
-cli.help();
-cli.version(utils_js_1.projectInfo.projectVersion);
-cli.parse(process.argv.length === 2 ? [...process.argv, '--help'] : process.argv);
-process.on('unhandledRejection', (rejectValue) => {
-    throw rejectValue;
-});

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

@@ -1,44 +0,0 @@
-import { cac } from 'cac';
-import { resolve } from 'path';
-import { runPrerenderFromCLI, runPrerender_forceExit } from '../prerender/runPrerender.js';
-import { projectInfo, assertUsage, assertWarning } from './utils.js';
-import pc from '@brillout/picocolors';
-const cli = cac(projectInfo.projectName);
-cli
-    .command('prerender', 'Pre-render the HTML of your pages', { allowUnknownOptions: true })
-    .option('--configFile <path>', '[string] Path to vite.config.js')
-    .action(async (options) => {
-    assertOptions();
-    const { partial, noExtraDir, base, parallel, outDir, configFile } = options;
-    const root = options.root && resolve(options.root);
-    await runPrerenderFromCLI({ partial, noExtraDir, base, root, parallel, outDir, configFile });
-    runPrerender_forceExit();
-});
-function assertOptions() {
-    // Using process.argv because cac convert names to camelCase
-    const rawOptions = process.argv.slice(3);
-    Object.values(rawOptions).forEach((option) => {
-        assertUsage(!option.startsWith('--') ||
-            [
-                '--root',
-                '--partial',
-                '--noExtraDir',
-                '--clientRouter',
-                '--base',
-                '--parallel',
-                '--outDir',
-                '--configFile'
-            ].includes(option), 'Unknown option: ' + option);
-        assertWarning(false, `You set ${pc.cyan(option)}, but passing options to ${pc.cyan('$ vike prerender')} is deprecated: use the config file instead. See https://vike.dev/command-prerender.`, { onlyOnce: true });
-    });
-}
-// Listen to unknown commands
-cli.on('command:*', () => {
-    assertUsage(false, 'Unknown command: ' + cli.args.join(' '));
-});
-cli.help();
-cli.version(projectInfo.projectVersion);
-cli.parse(process.argv.length === 2 ? [...process.argv, '--help'] : process.argv);
-process.on('unhandledRejection', (rejectValue) => {
-    throw rejectValue;
-});

package/node/cli/bin-entry.js

@@ -1,3 +0,0 @@
-#!/usr/bin/env node
-
-import '../../dist/esm/node/cli/bin.js'