vike 0.4.180 → 0.4.181-commit-ee50efa

package/dist/cjs/node/plugin/plugins/envVars.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.applyEnvVar = exports.envVarsPlugin = void 0;
+exports.envVarsPlugin = void 0;
 const vite_1 = require("vite");
 const utils_js_1 = require("../utils.js");
 const rollupSourceMap_js_1 = require("../shared/rollupSourceMap.js");
@@ -43,12 +43,13 @@ function envVarsPlugin() {
                 return !envPrefix.some((prefix) => key.startsWith(prefix));
             })
                 .forEach(([envName, envVal]) => {
+                const envStatement = `import.meta.env.${envName}`;
+                const envStatementRegEx = new RegExp((0, utils_js_1.escapeRegex)(envStatement) + '\\b', 'g');
                 // Security check
                 {
-                    const envStatement = getEnvStatement(envName);
                     const isPrivate = !envName.startsWith(PUBLIC_ENV_PREFIX) && !PUBLIC_ENV_WHITELIST.includes(envName);
                     if (isPrivate && isClientSide) {
-                        if (!code.includes(envStatement))
+                        if (!envStatementRegEx.test(code))
                             return;
                         const modulePath = (0, getFilePath_js_1.getModuleFilePath)(id, config);
                         const errMsgAddendum = isBuild ? '' : ' (Vike will prevent your app from building for production)';
@@ -67,7 +68,7 @@ function envVarsPlugin() {
                     (0, utils_js_1.assert)(!(isPrivate && isClientSide) || !isBuild);
                 }
                 // Apply
-                code = applyEnvVar(envName, envVal, code);
+                code = applyEnvVar(envStatementRegEx, envVal, code);
             });
             // Line numbers didn't change.
             //  - We only break the column number of a couple of lines, wich is acceptable.
@@ -78,14 +79,8 @@ function envVarsPlugin() {
     };
 }
 exports.envVarsPlugin = envVarsPlugin;
-function applyEnvVar(envName, envVal, code) {
-    const envStatement = getEnvStatement(envName);
-    const regex = new RegExp((0, utils_js_1.escapeRegex)(envStatement) + '\\b', 'g');
-    return code.replace(regex, JSON.stringify(envVal));
-}
-exports.applyEnvVar = applyEnvVar;
-function getEnvStatement(envName) {
-    return `import.meta.env.${envName}`;
+function applyEnvVar(envStatementRegEx, envVal, code) {
+    return code.replace(envStatementRegEx, JSON.stringify(envVal));
 }
 function getIsClientSide(config, options) {
     const isBuild = config.command === 'build';

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

@@ -159,6 +159,9 @@ async function fastGlob(userRootDir, outDirRelativeFromUserRootDir) {
         cwd: userRootDir,
         dot: false
     });
+    // Make build deterministic, in order to get a stable generated hash for dist/client/assets/entries/entry-client-routing.${hash}.js
+    // https://github.com/vikejs/vike/pull/1750
+    files.sort();
     return files;
 }
 // Same as getIgnoreAsFilterFn() but as glob pattern

package/dist/cjs/node/runtime/renderPage/createHttpResponseObject/assertNoInfiniteHttpRedirect.js

@@ -10,7 +10,7 @@ const globalObject = (0, utils_js_1.getGlobalObject)('assertNoInfiniteHttpRedire
     redirectGraph: {}
 });
 function assertNoInfiniteHttpRedirect(urlRedirectTarget, urlLogical) {
-    if ((0, utils_js_1.isUriWithProtocol)(urlRedirectTarget)) {
+    if (!urlRedirectTarget.startsWith('/')) {
         // We assume that urlRedirectTarget points to an origin that is external (not the same origin), and we can therefore assume that the app doesn't define an infinite loop (in itself).
         //  - There isn't a reliable way to check whether the redirect points to an external origin or the same origin. For same origins, we assume/hope the user to pass the URL without origin.
         //    ```js
@@ -19,7 +19,6 @@ function assertNoInfiniteHttpRedirect(urlRedirectTarget, urlLogical) {
         //    ```
         return;
     }
-    (0, utils_js_1.assert)(urlRedirectTarget.startsWith('/'));
     (0, utils_js_1.assert)(urlLogical.startsWith('/'));
     const graph = copy(globalObject.redirectGraph);
     graph[urlRedirectTarget] ?? (graph[urlRedirectTarget] = new Set());

package/dist/cjs/{shared/route → node/runtime/renderPage}/resolveRedirects.js

@@ -4,13 +4,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.resolveRouteStringRedirect = exports.resolveRedirects = void 0;
-const assertIsNotBrowser_js_1 = require("../../utils/assertIsNotBrowser.js");
-const utils_js_1 = require("../utils.js");
-const resolveUrlPathname_js_1 = require("./resolveUrlPathname.js");
-const resolveRouteString_js_1 = require("./resolveRouteString.js");
+const assertIsNotBrowser_js_1 = require("../../../utils/assertIsNotBrowser.js");
+const utils_js_1 = require("../../../shared/utils.js");
+const resolveUrlPathname_js_1 = require("../../../shared/route/resolveUrlPathname.js");
+const resolveRouteString_js_1 = require("../../../shared/route/resolveRouteString.js");
 const picocolors_1 = __importDefault(require("@brillout/picocolors"));
 (0, assertIsNotBrowser_js_1.assertIsNotBrowser)(); // Don't bloat the client
-// TODO/v1-release: update
+// TODO/next-major-release: update
 const configSrc = '[vite.config.js > vike({ redirects })]';
 function resolveRedirects(redirects, urlPathname) {
     for (const [urlSource, urlTarget] of Object.entries(redirects)) {
@@ -23,10 +23,8 @@ function resolveRedirects(redirects, urlPathname) {
 exports.resolveRedirects = resolveRedirects;
 function resolveRouteStringRedirect(urlSource, urlTarget, urlPathname) {
     (0, resolveRouteString_js_1.assertRouteString)(urlSource, `${configSrc} Invalid`);
-    (0, utils_js_1.assertUsage)(urlTarget.startsWith('/') ||
-        // Is allowing any protocol a safety issue? https://github.com/vikejs/vike/pull/1292#issuecomment-1828043917
-        (0, utils_js_1.isUriWithProtocol)(urlTarget) ||
-        urlTarget === '*', `${configSrc} Invalid redirection target URL ${picocolors_1.default.cyan(urlTarget)}: the target URL should start with ${picocolors_1.default.cyan('/')}, a valid protocol (${picocolors_1.default.cyan('https:')}, ${picocolors_1.default.cyan('http:')}, ${picocolors_1.default.cyan('mailto:')}, ${picocolors_1.default.cyan('ipfs:')}, ${picocolors_1.default.cyan('magnet:')}, ...), or be ${picocolors_1.default.cyan('*')}`);
+    // Is allowing any protocol a safety issue? https://github.com/vikejs/vike/pull/1292#issuecomment-1828043917
+    (0, utils_js_1.assertUsageUrlRedirectTarget)(urlTarget, `${configSrc} The URL redirection target`, true);
     assertParams(urlSource, urlTarget);
     const match = (0, resolveRouteString_js_1.resolveRouteString)(urlSource, urlPathname);
     if (!match)
@@ -34,7 +32,7 @@ function resolveRouteStringRedirect(urlSource, urlTarget, urlPathname) {
     const urlResolved = (0, resolveUrlPathname_js_1.resolveUrlPathname)(urlTarget, match.routeParams);
     if (urlResolved === urlPathname)
         return null;
-    (0, utils_js_1.assert)(urlResolved.startsWith('/') || (0, utils_js_1.isUriWithProtocol)(urlResolved));
+    (0, utils_js_1.assert)((0, utils_js_1.isUrlRedirectTarget)(urlResolved));
     return urlResolved;
 }
 exports.resolveRouteStringRedirect = resolveRouteStringRedirect;
@@ -43,7 +41,7 @@ function assertParams(urlSource, urlTarget) {
     routeSegments.forEach((routeSegment) => {
         if (routeSegment.startsWith('@') || routeSegment.startsWith('*')) {
             const segments = urlSource.split('/');
-            (0, utils_js_1.assertUsage)(segments.includes(routeSegment), `${configSrc} The redirection source URL ${picocolors_1.default.cyan(urlSource)} is missing the URL parameter ${picocolors_1.default.cyan(routeSegment)} used by the redirection target URL ${picocolors_1.default.cyan(urlTarget)}`);
+            (0, utils_js_1.assertUsage)(segments.includes(routeSegment), `${configSrc} The redirection source URL ${picocolors_1.default.string(urlSource)} is missing the URL parameter ${picocolors_1.default.string(routeSegment)} used by the redirection target URL ${picocolors_1.default.string(urlTarget)}`);
         }
     });
 }

package/dist/cjs/node/runtime/renderPage.js

@@ -21,7 +21,7 @@ const serializePageContextClientSide_js_1 = require("./html/serializePageContext
 const error_page_js_1 = require("../../shared/error-page.js");
 const handleErrorWithoutErrorPage_js_1 = require("./renderPage/handleErrorWithoutErrorPage.js");
 const loadUserFilesServerSide_js_1 = require("./renderPage/loadUserFilesServerSide.js");
-const resolveRedirects_js_1 = require("../../shared/route/resolveRedirects.js");
+const resolveRedirects_js_1 = require("./renderPage/resolveRedirects.js");
 const globalObject = (0, utils_js_1.getGlobalObject)('runtime/renderPage.ts', {
     httpRequestsCount: 0,
     pendingRequestsCount: 0
@@ -332,12 +332,9 @@ function getRequestId() {
     return httpRequestId;
 }
 function isIgnoredUrl(urlOriginal) {
-    const isViteClientRequest = urlOriginal.endsWith('/@vite/client') || urlOriginal.startsWith('/@fs/');
-    (0, utils_js_1.assertWarning)(!isViteClientRequest, `The vike middleware renderPage() was called with the URL ${urlOriginal} which is unexpected because the HTTP request should have already been handled by Vite's development middleware. Make sure to 1. install Vite's development middleware and 2. add Vite's middleware *before* Vike's middleware, see https://vike.dev/renderPage`, { onlyOnce: true });
-    return (urlOriginal.endsWith('/__vite_ping') ||
-        urlOriginal.endsWith('/favicon.ico') ||
-        !(0, utils_js_1.isParsable)(urlOriginal) ||
-        isViteClientRequest);
+    const isViteRequest = urlOriginal.endsWith('/@vite/client') || urlOriginal.startsWith('/@fs/');
+    (0, utils_js_1.assertWarning)(!isViteRequest, `The vike middleware renderPage() was called with the URL ${urlOriginal} which is unexpected because the HTTP request should have already been handled by Vite's development middleware. Make sure to 1. install Vite's development middleware and 2. add Vite's middleware *before* Vike's middleware, see https://vike.dev/renderPage`, { onlyOnce: true });
+    return (urlOriginal.endsWith('/__vite_ping') || urlOriginal.endsWith('/favicon.ico') || !(0, utils_js_1.isUrl)(urlOriginal) || isViteRequest);
 }
 function normalizeUrl(pageContextInit, httpRequestId) {
     const { trailingSlash, disableUrlNormalization, baseServer } = (0, globalContext_js_1.getGlobalContext)();
@@ -365,9 +362,9 @@ function getPermanentRedirect(pageContextInit, httpRequestId) {
         const urlTarget = (0, resolveRedirects_js_1.resolveRedirects)(redirects, urlPathname);
         if (urlTarget === null)
             return null;
-        if (!(0, utils_js_1.isParsable)(urlTarget)) {
+        if (!(0, utils_js_1.isUrl)(urlTarget)) {
             // E.g. `urlTarget === 'mailto:some@example.com'`
-            (0, utils_js_1.assert)((0, utils_js_1.isUriWithProtocol)(urlTarget) && !urlTarget.startsWith('http'));
+            (0, utils_js_1.assert)((0, utils_js_1.isUri)(urlTarget));
             urlTargetExternal = urlTarget;
             return null;
         }

package/dist/cjs/shared/getPageContextUrlComputed.js

@@ -30,11 +30,6 @@ function getPageContextUrlComputed(pageContext) {
 }
 exports.getPageContextUrlComputed = getPageContextUrlComputed;
 function getUrlParsed(pageContext) {
-    // We need a url handler function because the onBeforeRoute() hook may set pageContext.urlLogical (typically for i18n)
-    let urlHandler = pageContext._urlHandler;
-    if (!urlHandler) {
-        urlHandler = (url) => url;
-    }
     // Example of i18n app using `throw render()`:
     //  1. User goes to '/fr-FR/admin'.
     //  2. The first onBeforeRoute() call accesses pageContext.urlPathname (its value is '/fr-FR/admin': the pathname of pageContext.urlOriginal, since both pageContext.urlLogical and pageContext._urlRewrite are undefined) and sets pageContext.urlLogical to '/admin'.
@@ -43,23 +38,36 @@ function getUrlParsed(pageContext) {
     //  5. The second onBeforeRoute() call accesses pageContext.urlPathname (its value is '/fr-FR/login': the pathname of pageContext._urlRewrite, since pageContext.urlLogical is undefined) and sets pageContext.urlLogical to '/login'.
     //  6. The value of pageContext.urlPathname is now '/login': the pathname of `pageContext.urlLogical`. (While pageContext.urlOriginal is still '/fr-FR/admin'.)
     // Reproduction: https://github.com/vikejs/vike/discussions/1436#discussioncomment-8142023
-    let urlResolved = 
-    // Set by onBeforeRoute()
-    pageContext.urlLogical ??
+    // Determine logical URL
+    let urlResolved;
+    let baseToBeRemoved;
+    if (pageContext.urlLogical) {
+        // Set by onBeforeRoute()
+        urlResolved = pageContext.urlLogical;
+        baseToBeRemoved = false;
+    }
+    else if (pageContext._urlRewrite) {
         // Set by `throw render()`
-        pageContext._urlRewrite ??
+        urlResolved = pageContext._urlRewrite;
+        baseToBeRemoved = false;
+    }
+    else {
         // Set by renderPage()
-        pageContext.urlOriginal;
-    urlResolved = urlHandler(urlResolved);
-    /*
-    console.log('pageContext.urlLogical', pageContext.urlLogical)
-    console.log('pageContext._urlRewrite', pageContext._urlRewrite)
-    console.log('pageContext.urlOriginal', pageContext.urlOriginal)
-    console.log()
-    //*/
-    const baseServer = pageContext._baseServer;
+        urlResolved = pageContext.urlOriginal;
+        baseToBeRemoved = true;
+    }
     (0, utils_js_1.assert)(urlResolved && typeof urlResolved === 'string');
-    (0, utils_js_1.assert)(baseServer.startsWith('/'));
+    // Remove .pageContext.json
+    let urlHandler = pageContext._urlHandler;
+    if (!urlHandler)
+        urlHandler = (url) => url;
+    urlResolved = urlHandler(urlResolved);
+    // Remove Base URL.
+    // - We assume there isn't any Base URL to the URLs set by the user at `throw render()` and onBeforeRoute()
+    //   - This makes sense because the Base URL is merely a setting: ideally the user should write code that doesn't know anything about it (so that the user can remove/add/change Base URL without having to modify any code).
+    // - pageContext.urlOriginal is the URL of the HTTP request and thus contains the Base URL.
+    const baseServer = !baseToBeRemoved ? '/' : pageContext._baseServer;
+    // Parse URL
     return (0, utils_js_1.parseUrl)(urlResolved, baseServer);
 }
 function urlPathnameGetter() {
@@ -74,47 +82,45 @@ function urlGetter() {
     return urlPathnameGetter.call(this);
 }
 function urlParsedGetter() {
-    const urlParsedOriginal = getUrlParsed(this);
-    const { origin, pathname, pathnameOriginal, search, searchAll, searchOriginal, hash, hashOriginal } = urlParsedOriginal;
+    const { 
+    // remove hasBaseServer as it isn't part of UrlPublic
+    hasBaseServer: _, ...urlParsed } = getUrlParsed(this);
     const hashIsAvailable = (0, utils_js_1.isBrowser)();
     const warnHashNotAvailable = (prop) => {
         (0, utils_js_1.assertWarning)(hashIsAvailable, `pageContext.urlParsed.${prop} isn't available on the server-side (HTTP requests don't include the URL hash)`, { onlyOnce: true, showStackTrace: true });
     };
-    const urlParsed = {
-        origin,
-        pathname,
-        pathnameOriginal,
-        search,
-        searchAll,
-        searchOriginal,
+    const urlParsedEnhanced = {
+        ...urlParsed,
         get hash() {
             warnHashNotAvailable('hash');
-            return hash;
+            return urlParsed.hash;
         },
         get hashOriginal() {
             warnHashNotAvailable('hashOriginal');
-            return hashOriginal;
+            return urlParsed.hashOriginal;
         },
+        // TODO/next-major-release: remove
         get hashString() {
             (0, utils_js_1.assertWarning)(false, 'pageContext.urlParsed.hashString has been renamed to pageContext.urlParsed.hashOriginal', {
                 onlyOnce: true,
                 showStackTrace: true
             });
             warnHashNotAvailable('hashString');
-            return hashOriginal;
+            return urlParsed.hashOriginal;
         },
+        // TODO/next-major-release: remove
         get searchString() {
             (0, utils_js_1.assertWarning)(false, 'pageContext.urlParsed.searchString has been renamed to pageContext.urlParsed.searchOriginal', { onlyOnce: true, showStackTrace: true });
-            return searchOriginal;
+            return urlParsed.searchOriginal;
         }
     };
-    (0, utils_js_1.changeEnumerable)(urlParsed, 'hashString', false);
-    (0, utils_js_1.changeEnumerable)(urlParsed, 'searchString', false);
+    (0, utils_js_1.changeEnumerable)(urlParsedEnhanced, 'hashString', false);
+    (0, utils_js_1.changeEnumerable)(urlParsedEnhanced, 'searchString', false);
     if (!hashIsAvailable) {
-        (0, utils_js_1.changeEnumerable)(urlParsed, 'hash', false);
-        (0, utils_js_1.changeEnumerable)(urlParsed, 'hashOriginal', false);
+        (0, utils_js_1.changeEnumerable)(urlParsedEnhanced, 'hash', false);
+        (0, utils_js_1.changeEnumerable)(urlParsedEnhanced, 'hashOriginal', false);
     }
-    return urlParsed;
+    return urlParsedEnhanced;
 }
 function assertPageContextUrl(pageContext) {
     (0, utils_js_1.assert)(typeof pageContext.urlOriginal === 'string');

package/dist/cjs/shared/modifyUrl.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.modifyUrl = void 0;
+const utils_js_1 = require("./utils.js");
+/**
+ * Modify a URL.
+ *
+ * Example: changing the URL pathname for internationalization.
+ *
+ * https://vike.dev/modifyUrl
+ */
+function modifyUrl(url, modify) {
+    const urlParsed = (0, utils_js_1.parseUrl)(url, '/');
+    // Pathname
+    const pathname = modify.pathname ?? urlParsed.pathname;
+    // Origin
+    const originParts = [
+        modify.protocol ?? urlParsed.protocol ?? '',
+        modify.hostname ?? urlParsed.hostname ?? ''
+    ];
+    const port = modify.port ?? urlParsed.port;
+    if (port || port === 0) {
+        originParts.push(`:${port}`);
+    }
+    const origin = originParts.join('');
+    const urlModified = (0, utils_js_1.createUrlFromComponents)(origin, pathname, 
+    // Should we also support modifying search and hash?
+    urlParsed.searchOriginal, urlParsed.hashOriginal);
+    return urlModified;
+}
+exports.modifyUrl = modifyUrl;

package/dist/cjs/shared/route/abort.js

@@ -17,7 +17,7 @@ const picocolors_1 = __importDefault(require("@brillout/picocolors"));
  */
 function redirect(url, statusCode) {
     const abortCaller = 'throw redirect()';
-    assertUrl(url, abortCaller, true);
+    (0, utils_js_1.assertUsageUrlRedirectTarget)(url, getErrPrefix(abortCaller));
     const args = [JSON.stringify(url)];
     if (!statusCode) {
         statusCode = 302;
@@ -59,7 +59,7 @@ function render_(urlOrStatusCode, abortReason, abortCall, abortCaller, pageConte
     }
     if (typeof urlOrStatusCode === 'string') {
         const url = urlOrStatusCode;
-        assertUrl(url, abortCaller);
+        (0, utils_js_1.assertUsageUrlPathnameAbsolute)(url, getErrPrefix(abortCaller));
         (0, utils_js_1.objectAssign)(pageContextAbort, {
             _urlRewrite: url
         });
@@ -174,12 +174,6 @@ function assertNoInfiniteAbortLoop(rewriteCount, redirectCount) {
     (0, utils_js_1.assertUsage)(rewriteCount + redirectCount <= 7, `Maximum chain length of 7 ${abortCalls} exceeded. Did you define an infinite loop of ${abortCalls}?`);
 }
 exports.assertNoInfiniteAbortLoop = assertNoInfiniteAbortLoop;
-function assertUrl(url, abortCaller, allowAbsoluteUrl) {
-    (0, utils_js_1.assertUsage)(url.startsWith('/') || (allowAbsoluteUrl && (0, utils_js_1.isUriWithProtocol)(url)), [
-        `Invalid URL ${picocolors_1.default.cyan(url)} passed to ${picocolors_1.default.cyan(abortCaller)}:`,
-        `the URL should start with ${picocolors_1.default.cyan('/')}`,
-        allowAbsoluteUrl && `or a valid protocol (${picocolors_1.default.cyan('https:')}, ${picocolors_1.default.cyan('ipfs:')}, ...)`
-    ]
-        .filter(Boolean)
-        .join(' '));
+function getErrPrefix(abortCaller) {
+    return `URL passed to ${picocolors_1.default.code(abortCaller)}`;
 }

package/dist/cjs/shared/route/executeOnBeforeRouteHook.js

@@ -71,7 +71,9 @@ async function getPageContextFromHook(onBeforeRouteHook, pageContext) {
         delete hookReturn.pageContext.urlOriginal;
     }
     if ((0, utils_js_1.hasProp)(hookReturn.pageContext, 'urlLogical')) {
-        (0, utils_js_1.assertUsageUrl)(hookReturn.pageContext.urlLogical, `${errPrefix} returned ${picocolors_1.default.cyan('{ pageContext: { urlLogical } }')} but ${picocolors_1.default.cyan('urlLogical')}`);
+        (0, utils_js_1.assertUsageUrlPathnameAbsolute)(
+        // We type-cast to string instead of assertUsage() in order to save client-side KBs
+        hookReturn.pageContext.urlLogical, `${errPrefix} returned ${picocolors_1.default.cyan('{ pageContext: { urlLogical } }')} but ${picocolors_1.default.cyan('urlLogical')}`);
     }
     (0, assertPageContextProvidedByUser_js_1.assertPageContextProvidedByUser)(hookReturn.pageContext, {
         hookFilePath: onBeforeRouteHook.hookFilePath,