vike 0.4.167 → 0.4.168-commit-7678a7d

package/dist/cjs/utils/isDev.js

@@ -1,10 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isDev2 = exports.isDev1_onConfigureServer = exports.isDev1 = void 0;
-// There isn't any reliable way to test whether Vite is ran as dev/build/preview/optimizeDep
-//  - Failed attempt to make a PR: https://github.com/brillout/vite/tree/fix/config-operation
+exports.isDev3 = exports.isDev2 = exports.isDev1_onConfigureServer = exports.isDev1 = void 0;
+function isDev3(configEnv) {
+    const { isPreview, command } = configEnv;
+    if (command !== 'serve')
+        return false;
+    if (typeof isPreview === 'boolean')
+        return !isPreview;
+    // isPreview is undefined in older Vite versions, see https://github.com/vitejs/vite/commit/93fce55
+    return null;
+}
+exports.isDev3 = isDev3;
 // ********
-// Method 1 - most reliable
+// Method 1 - reliable
 // ********
 const assert_js_1 = require("./assert.js");
 const getGlobalObject_js_1 = require("./getGlobalObject.js");

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.167';
+const PROJECT_VERSION = '0.4.168-commit-7678a7d';
 exports.PROJECT_VERSION = PROJECT_VERSION;
 const projectInfo = {
     projectName: 'Vike',

package/dist/esm/client/client-routing-runtime/history.d.ts

@@ -3,6 +3,7 @@ type HistoryState = {
     timestamp?: number;
     scrollPosition?: null | ScrollPosition;
     triggeredBy?: 'user' | 'vike' | 'browser';
+    _isVikeEnhanced: true;
 };
 type ScrollPosition = {
     x: number;

package/dist/esm/client/client-routing-runtime/history.js

@@ -1,6 +1,5 @@
 export { initHistoryState, getHistoryState, pushHistory, saveScrollPosition, monkeyPatchHistoryPushState };
-import { assert, assertUsage, getGlobalObject, hasProp, isObject } from './utils.js';
-const globalObject = getGlobalObject('history.ts', {});
+import { assert, assertUsage, hasProp, isObject } from './utils.js';
 // Fill missing state information:
 //  - `history.state` can uninitialized (i.e. `null`):
 //    - The very first render
@@ -8,9 +7,10 @@ const globalObject = getGlobalObject('history.ts', {});
 //    - The user clicks on an anchor link `<a href="#section">Section</a>` (Vike's `onLinkClick()` handler skips hash links).
 //  - State information may be incomplete if `history.state` is set by an old Vike version. (E.g. `state.timestamp` was introduced for `pageContext.isBackwardNavigation` in `0.4.19`.)
 function initHistoryState() {
+    // No way found to add TypeScript types to `window.history.state`: https://github.com/microsoft/TypeScript/issues/36178
     let state = window.history.state;
     if (!state) {
-        state = {};
+        state = { _isVikeEnhanced: true };
     }
     let hasModifications = false;
     if (!('timestamp' in state)) {
@@ -49,7 +49,7 @@ function saveScrollPosition() {
 function pushHistory(url, overwriteLastHistoryEntry) {
     if (!overwriteLastHistoryEntry) {
         const timestamp = getTimestamp();
-        pushHistoryState({ timestamp, scrollPosition: null, triggeredBy: 'vike' }, url);
+        pushHistoryState({ timestamp, scrollPosition: null, triggeredBy: 'vike', _isVikeEnhanced: true }, url);
     }
     else {
         replaceHistoryState(getHistoryState(), url);
@@ -69,25 +69,29 @@ function assertState(state) {
     }
 }
 function replaceHistoryState(state, url) {
-    window.history.replaceState(state, '', url ?? /* Passing `undefined` chokes older Edge versions */ null);
+    const url_ = url ?? null; // Passing `undefined` chokes older Edge versions.
+    window.history.replaceState(state, '', url_);
 }
 function pushHistoryState(state, url) {
-    pushStateOriginal(state, '', url);
+    // Vike should call window.history.pushState() (and not the orignal `pushStateOriginal()`) so that other tools (e.g. user tracking) can listen to Vike's pushState() calls, see https://github.com/vikejs/vike/issues/1582.
+    window.history.pushState(state, '', url);
 }
 function monkeyPatchHistoryPushState() {
-    globalObject.pushStateOriginal = globalObject.pushStateOriginal ?? window.history.pushState;
-    window.history.pushState = (stateFromUser = {}, ...rest) => {
-        assertUsage(null === stateFromUser || undefined === stateFromUser || isObject(stateFromUser), 'history.pushState(state) argument state must be an object');
-        const state = {
-            scrollPosition: getScrollPosition(),
-            timestamp: getTimestamp(),
-            ...stateFromUser,
-            // Don't allow user to overwrite triggeredBy as it would break Vike's handling of the 'popstate' event
-            triggeredBy: 'user'
-        };
-        return pushStateOriginal(state, ...rest);
+    const pushStateOriginal = window.history.pushState.bind(window.history);
+    window.history.pushState = (stateOriginal = {}, ...rest) => {
+        assertUsage(stateOriginal === undefined || stateOriginal === null || isObject(stateOriginal), 'history.pushState(state) argument state must be an object');
+        const stateEnhanced = isVikeEnhanced(stateOriginal)
+            ? stateOriginal
+            : {
+                _isVikeEnhanced: true,
+                scrollPosition: getScrollPosition(),
+                timestamp: getTimestamp(),
+                triggeredBy: 'user',
+                ...stateOriginal
+            };
+        return pushStateOriginal(stateEnhanced, ...rest);
     };
 }
-function pushStateOriginal(...args) {
-    globalObject.pushStateOriginal.apply(history, args);
+function isVikeEnhanced(state) {
+    return isObject(state) && '_isVikeEnhanced' in state;
 }

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

@@ -227,7 +227,15 @@ function getEntryFromPageConfig(pageConfig, isForClientSide) {
     let { pageId } = pageConfig;
     const entryTarget = getVirtualFileIdPageConfigValuesAll(pageId, isForClientSide);
     let entryName = pageId;
+    // Avoid:
+    // ```
+    // dist/client/assets/entries/.Dp9wM6PK.js
+    // dist/server/entries/.mjs
+    // ```
+    if (entryName === '/')
+        entryName = 'root';
     entryName = prependEntriesDir(entryName);
+    assert(!entryName.endsWith('/'));
     return { entryName, entryTarget };
 }
 function resolve(filePath) {

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

@@ -110,6 +110,12 @@ function clean(name, removePathSep, fixGlob) {
     }
     name = removeLeadingUnderscoreInFilename(name);
     name = removeUnderscoreDoublets(name);
+    // Avoid:
+    // ```
+    // dist/client/assets/entries/.Dp9wM6PK.js
+    // dist/server/entries/.mjs
+    // ```
+    assert(!name.endsWith('/'));
     return name;
 }
 function fixExtractAssetsQuery(name) {

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

@@ -187,7 +187,7 @@ function analyzeImport(importStatement) {
     if (rawRE.test(moduleName)) {
         return { moduleName, skip: true };
     }
-    /* We should not do this because of aliased imports
+    /* We shouldn't do this because of aliased imports
     if (!moduleName.startsWith('.')) {
       return { moduleName, skip: true }
     }

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

@@ -3,7 +3,7 @@ import { normalizePath } from 'vite';
 import { getConfigVike } from '../../../shared/getConfigVike.js';
 import { getVirtualFilePageConfigValuesAll } from './v1-design/getVirtualFilePageConfigValuesAll.js';
 import { getVirtualFileImportUserCode } from './getVirtualFileImportUserCode.js';
-import { assert, assertPosixPath, getOutDirs, getVirtualFileId, isDev1, isDev1_onConfigureServer, isVirtualFileId, resolveVirtualFileId } from '../../utils.js';
+import { assert, assertPosixPath, getOutDirs, getVirtualFileId, isDev1, isDev1_onConfigureServer, isDev3, isVirtualFileId, resolveVirtualFileId } from '../../utils.js';
 import { isVirtualFileIdPageConfigValuesAll } from '../../../shared/virtual-files/virtualFilePageConfigValuesAll.js';
 import { isVirtualFileIdImportUserCode } from '../../../shared/virtual-files/virtualFileImportUserCode.js';
 import { vikeConfigDependencies, reloadVikeConfig, isVikeConfigFile } from './v1-design/getVikeConfig.js';
@@ -13,9 +13,11 @@ import { getFilePathResolved } from '../../shared/getFilePath.js';
 function importUserCode() {
     let config;
     let configVike;
+    let isDev_;
     return {
         name: 'vike:importUserCode',
-        config() {
+        config(_, env) {
+            isDev_ = isDev3(env);
             return {
                 experimental: {
                     // TODO/v1-release: remove
@@ -43,7 +45,7 @@ function importUserCode() {
             }
         },
         async load(id, options) {
-            const isDev = isDev1();
+            const isDev = isDev_ !== null ? isDev_ : isDev1();
             if (!isVirtualFileId(id))
                 return undefined;
             id = getVirtualFileId(id);
@@ -57,7 +59,8 @@ function importUserCode() {
             }
         },
         configureServer(server) {
-            isDev1_onConfigureServer();
+            if (isDev_ === null)
+                isDev1_onConfigureServer();
             handleFileAddRemove(server, config);
         }
     };

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

@@ -5,6 +5,7 @@ import glob from 'fast-glob';
 import { exec } from 'child_process';
 import { promisify } from 'util';
 import pc from '@brillout/picocolors';
+import { isTemporaryBuildFile } from './transpileAndExecuteFile.js';
 const execA = promisify(exec);
 assertIsNotProductionRuntime();
 assertIsSingleModuleInstance('crawlPlusFiles.ts');
@@ -17,7 +18,13 @@ async function crawlPlusFiles(userRootDir, outDirAbsoluteFilesystem, isDev) {
         // config.outDir is outside of config.root => it's going to be ignored anyways
         outDirRelativeFromUserRootDir = null;
     }
-    assert(outDirRelativeFromUserRootDir === null || !outDirRelativeFromUserRootDir.startsWith('.'));
+    assert(outDirRelativeFromUserRootDir === null ||
+        /* Not true if outDirRelativeFromUserRootDir starts with a hidden directory (i.e. a directory with a name that starts with `.`)
+        !outDirRelativeFromUserRootDir.startsWith('.') &&
+        */
+        (!outDirRelativeFromUserRootDir.startsWith('./') &&
+            //
+            !outDirRelativeFromUserRootDir.startsWith('../')));
     const timeBefore = new Date().getTime();
     let files = [];
     const res = await gitLsFiles(userRootDir, outDirRelativeFromUserRootDir);
@@ -29,6 +36,7 @@ async function crawlPlusFiles(userRootDir, outDirAbsoluteFilesystem, isDev) {
     else {
         files = await fastGlob(userRootDir, outDirRelativeFromUserRootDir);
     }
+    files = files.filter((file) => !isTemporaryBuildFile(file));
     {
         const timeAfter = new Date().getTime();
         const timeSpent = timeAfter - timeBefore;

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

@@ -2,7 +2,7 @@
 export { loadImportedFile };
 export { loadValueFile };
 export { loadConfigFile };
-import { assert, assertUsage, assertWarning, hasProp, assertIsNotProductionRuntime, isNpmPackageImport } from '../../../../utils.js';
+import { assert, assertUsage, hasProp, assertIsNotProductionRuntime } from '../../../../utils.js';
 import { transpileAndExecuteFile } from './transpileAndExecuteFile.js';
 import { assertPlusFileExport } from '../../../../../../shared/page-configs/assertPlusFileExport.js';
 import pc from '@brillout/picocolors';
@@ -62,7 +62,6 @@ async function loadExtendsConfigs(configFileExports, configFilePath, userRootDir
         const { importPath: importPathAbsolute } = importData;
         const filePathAbsoluteFilesystem = resolveImportPath(importData, configFilePath);
         assertImportPath(filePathAbsoluteFilesystem, importData, configFilePath);
-        warnUserLandExtension(importPathAbsolute, configFilePath);
         const filePath = getFilePathResolved({ filePathAbsoluteFilesystem, userRootDir, importPathAbsolute });
         extendsConfigFiles.push(filePath);
     });
@@ -75,13 +74,6 @@ async function loadExtendsConfigs(configFileExports, configFilePath, userRootDir
     const extendsFilePaths = extendsConfigFiles.map((f) => f.filePathAbsoluteFilesystem);
     return { extendsConfigs, extendsFilePaths };
 }
-function warnUserLandExtension(importPath, configFilePath) {
-    // We preserve this feature because we may need it for eject
-    assertWarning(isNpmPackageImport(importPath, {
-        // Vike config files don't support path aliases. (If they do one day, then Vike will/should be able to resolve path aliases.)
-        cannotBePathAlias: true
-    }) || importPath.includes('/node_modules/'), `${configFilePath.filePathToShowToUser} uses ${pc.cyan('extends')} to inherit from ${pc.cyan(importPath)} which is a user-land file: this is experimental and may be remove at any time. Reach out to a maintainer if you need this.`, { onlyOnce: true });
-}
 function getExtendsImportData(configFileExports, configFilePath) {
     const { filePathToShowToUser } = configFilePath;
     const configFileExport = getConfigFileExport(configFileExports, filePathToShowToUser);

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

@@ -20,13 +20,22 @@ function resolveImport(configValue, importerFilePath, userRootDir, configEnv, co
     const fileExportPathToShowToUser = exportName === 'default' || exportName === configName ? [] : [exportName];
     let filePath;
     if (importPath.startsWith('.')) {
-        // We need to resolve relative paths into absolute paths. Because the import paths are included in virtual files:
+        assert(importPath.startsWith('./') || importPath.startsWith('../'));
+        assertImportPath(filePathAbsoluteFilesystem, importData, importerFilePath);
+        filePath = getFilePathResolved({ filePathAbsoluteFilesystem, userRootDir });
+        // Imports are included in virtual files, thus the relative path of imports need to resolved.
         // ```
         // [vite] Internal server error: Failed to resolve import "./onPageTransitionHooks" from "virtual:vike:pageConfigValuesAll:client:/pages/index". Does the file exist?
         // ```
-        assertImportPath(filePathAbsoluteFilesystem, importData, importerFilePath);
-        const filePathAbsoluteUserRootDir = resolveImportPath_absoluteUserRootDir(filePathAbsoluteFilesystem, importData, importerFilePath, userRootDir);
-        filePath = getFilePathResolved({ filePathAbsoluteUserRootDir, userRootDir });
+        assertUsage(filePath.filePathAbsoluteUserRootDir, `${importerFilePath.filePathToShowToUser} imports a relative path ${pc.cyan(importPath)} resolving outside of ${userRootDir} which is forbidden: import from a relative path inside ${userRootDir}, or import from a dependency's package.json#exports entry instead`);
+        // Alternativey, we can try one of the following but last time we tried none of the following worked.
+        // /*
+        // assert(filePathAbsoluteFilesystem.startsWith('/'))
+        // filePath = `/@fs${filePathAbsoluteFilesystem}`
+        // /*/
+        // assert(filePathAbsoluteUserRootDir.startsWith('../'))
+        // filePathAbsoluteUserRootDir = '/' + filePathAbsoluteUserRootDir
+        // //*/
     }
     else {
         // importPath can be:
@@ -51,28 +60,6 @@ function resolveImport(configValue, importerFilePath, userRootDir, configEnv, co
         fileExportPathToShowToUser
     };
 }
-function resolveImportPath_absoluteUserRootDir(filePathAbsoluteFilesystem, importData, configFilePath, userRootDir) {
-    assertPosixPath(userRootDir);
-    let filePathAbsoluteUserRootDir;
-    if (filePathAbsoluteFilesystem.startsWith(userRootDir)) {
-        filePathAbsoluteUserRootDir = getVitePathFromAbsolutePath(filePathAbsoluteFilesystem, userRootDir);
-    }
-    else {
-        assertUsage(false, `${configFilePath.filePathToShowToUser} imports from a relative path ${pc.cyan(importData.importPath)} outside of ${userRootDir} which is forbidden: import from a relative path inside ${userRootDir}, or import from a dependency's package.json#exports entry instead`);
-        // None of the following works. Seems to be a Vite bug?
-        // /*
-        // assert(filePathAbsoluteFilesystem.startsWith('/'))
-        // filePath = `/@fs${filePathAbsoluteFilesystem}`
-        // /*/
-        // filePathAbsoluteUserRootDir = path.posix.relative(userRootDir, filePathAbsoluteFilesystem)
-        // assert(filePathAbsoluteUserRootDir.startsWith('../'))
-        // filePathAbsoluteUserRootDir = '/' + filePathAbsoluteUserRootDir
-        // //*/
-    }
-    assertPosixPath(filePathAbsoluteUserRootDir);
-    assert(filePathAbsoluteUserRootDir.startsWith('/'));
-    return filePathAbsoluteUserRootDir;
-}
 function resolveImportPath(importData, importerFilePath) {
     const importerFilePathAbsolute = importerFilePath.filePathAbsoluteFilesystem;
     assertPosixPath(importerFilePathAbsolute);
@@ -93,6 +80,7 @@ function assertImportPath(filePathAbsoluteFilesystem, importData, importerFilePa
             : `The import ${pc.cyan(importString)} defined in ${filePathToShowToUser}`;
         const errIntro2 = `${errIntro} couldn't be resolved: does ${importPathString}`;
         if (importPath.startsWith('.')) {
+            assert(importPath.startsWith('./') || importPath.startsWith('../'));
             assertUsage(false, `${errIntro2} point to an existing file?`);
         }
         else {
@@ -119,12 +107,3 @@ function assertFileEnv(filePathForEnvCheck, configEnv, configName) {
 function clearFilesEnvMap() {
     filesEnvMap.clear();
 }
-function getVitePathFromAbsolutePath(filePathAbsoluteFilesystem, root) {
-    assertPosixPath(filePathAbsoluteFilesystem);
-    assertPosixPath(root);
-    assert(filePathAbsoluteFilesystem.startsWith(root));
-    let vitePath = path.posix.relative(root, filePathAbsoluteFilesystem);
-    assert(!vitePath.startsWith('/') && !vitePath.startsWith('.'));
-    vitePath = '/' + vitePath;
-    return vitePath;
-}

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

@@ -2,7 +2,7 @@ export { transformFileImports };
 export { parseImportData };
 export { isImportData };
 export type { ImportData };
-declare function transformFileImports(code: string, filePathToShowToUser2: string, pointerImports: 'all' | Record<string, boolean>, skipWarnings?: true): string | null;
+declare function transformFileImports(code: string, filePathToShowToUser2: string, pointerImports: Record<string, boolean> | 'all', skipWarnings?: true): string | null;
 /**
  * Data Structure holding info about import statement:
  *   `import { someExport as someImport } from './some-file'`

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

@@ -1,7 +1,7 @@
 export { transpileAndExecuteFile };
 export { getConfigBuildErrorFormatted };
 export { getConfigExecutionErrorIntroMsg };
-export { isTmpFile };
+export { isTemporaryBuildFile };
 import 'source-map-support/register.js';
 import type { FilePathResolved } from '../../../../../../shared/page-configs/FilePath.js';
 declare function transpileAndExecuteFile(filePath: FilePathResolved, userRootDir: string, isConfigFile: boolean | 'is-extension-config'): Promise<{
@@ -9,4 +9,4 @@ declare function transpileAndExecuteFile(filePath: FilePathResolved, userRootDir
 }>;
 declare function getConfigBuildErrorFormatted(err: unknown): null | string;
 declare function getConfigExecutionErrorIntroMsg(err: unknown): string | null;
-declare function isTmpFile(filePath: string): boolean;
+declare function isTemporaryBuildFile(filePath: string): boolean;