vike 0.4.229-commit-7056ef0 → 0.4.229-commit-5da80bf

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

@@ -11,7 +11,6 @@ if ((0, isBrowser_js_1.isBrowser)()) {
     (0, assertRoutingType_js_1.assertClientRouting)();
 }
 const utils_js_1 = require("./utils.js");
-const getPageContextUrlComputed_js_1 = require("../getPageContextUrlComputed.js");
 const resolvePrecedence_js_1 = require("./resolvePrecedence.js");
 const resolveRouteString_js_1 = require("./resolveRouteString.js");
 const resolveRouteFunction_js_1 = require("./resolveRouteFunction.js");
@@ -20,7 +19,6 @@ const debug_js_1 = require("./debug.js");
 const picocolors_1 = __importDefault(require("@brillout/picocolors"));
 async function route(pageContext, skipOnBeforeRouteHook) {
     (0, debug_js_1.debug)('Pages routes:', pageContext._pageRoutes);
-    (0, getPageContextUrlComputed_js_1.assertPageContextUrl)(pageContext);
     const pageContextFromRoute = {};
     // onBeforeRoute()
     if (!skipOnBeforeRouteHook) {
@@ -74,8 +72,8 @@ async function route(pageContext, skipOnBeforeRouteHook) {
         }
         // Route Function defined in `.page.route.js`
         if (pageRoute.routeType === 'FUNCTION') {
-            const { routeFunction, routeDefinedAtString } = pageRoute;
-            const match = await (0, resolveRouteFunction_js_1.resolveRouteFunction)(routeFunction, pageContext, routeDefinedAtString);
+            const { routeFunction, routeFunctionFilePath } = pageRoute;
+            const match = await (0, resolveRouteFunction_js_1.resolveRouteFunction)(routeFunction, pageContext, routeFunctionFilePath);
             if (match) {
                 const { routeParams, precedence } = match;
                 routeMatches.push({ pageId, precedence, routeParams, routeType });

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

@@ -46,6 +46,10 @@ function getPageRoutes(filesystemRoots, pageFilesAll, pageConfigs, allPageIds) {
                         };
                     }
                     else {
+                        const { definedAtData } = configValue;
+                        (0, utils_js_1.assert)(!(0, utils_js_2.isArray)(definedAtData) && !definedAtData.definedBy);
+                        const { filePathToShowToUser } = definedAtData;
+                        (0, utils_js_1.assert)(filePathToShowToUser);
                         (0, utils_js_1.assert)((0, utils_js_2.isCallable)(route));
                         // TODO/next-major: remove
                         if ((0, getConfigValueRuntime_js_1.getConfigValueRuntime)(pageConfig, 'iKnowThePerformanceRisksOfAsyncRouteFunctions', 'boolean'))
@@ -54,6 +58,7 @@ function getPageRoutes(filesystemRoots, pageFilesAll, pageConfigs, allPageIds) {
                             pageId,
                             comesFromV1PageConfig,
                             routeFunction: route,
+                            routeFunctionFilePath: filePathToShowToUser,
                             routeDefinedAtString: definedAtString,
                             routeType: 'FUNCTION'
                         };
@@ -127,6 +132,7 @@ function getPageRoutes(filesystemRoots, pageFilesAll, pageConfigs, allPageIds) {
                         pageId,
                         comesFromV1PageConfig,
                         routeFunction,
+                        routeFunctionFilePath: filePath,
                         routeDefinedAtString: filePath,
                         routeType: 'FUNCTION'
                     });

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

@@ -7,13 +7,17 @@ exports.resolveRouteFunction = resolveRouteFunction;
 exports.assertRouteParams = assertRouteParams;
 exports.assertSyncRouting = assertSyncRouting;
 exports.warnDeprecatedAllowKey = warnDeprecatedAllowKey;
-const getPageContextUrlComputed_js_1 = require("../getPageContextUrlComputed.js");
+const execHook_js_1 = require("../hooks/execHook.js");
+const preparePageContextForPublicUsage_js_1 = require("../preparePageContextForPublicUsage.js");
 const utils_js_1 = require("./utils.js");
 const picocolors_1 = __importDefault(require("@brillout/picocolors"));
-async function resolveRouteFunction(routeFunction, pageContext, routeDefinedAtString) {
-    (0, getPageContextUrlComputed_js_1.assertPageContextUrl)(pageContext);
-    let result = routeFunction(pageContext);
-    assertSyncRouting(result, `The Route Function ${routeDefinedAtString}`);
+async function resolveRouteFunction(routeFunction, pageContext, routeFunctionFilePath) {
+    let { hookReturn: result } = (0, execHook_js_1.execHookSync)({
+        hookFn: routeFunction,
+        hookFilePath: routeFunctionFilePath,
+        hookName: 'route'
+    }, pageContext, preparePageContextForPublicUsage_js_1.preparePageContextForPublicUsage);
+    assertSyncRouting(result, `The Route Function ${routeFunctionFilePath}`);
     // TODO/v1-release: make resolveRouteFunction() and route() sync
     //* We disallow asynchronous routing, because we need to check whether a link is a Vike link in a synchronous fashion before calling ev.preventDefault() in the 'click' event listener
     result = await result;
@@ -24,11 +28,11 @@ async function resolveRouteFunction(routeFunction, pageContext, routeDefinedAtSt
     if (result === true) {
         result = {};
     }
-    (0, utils_js_1.assertUsage)((0, utils_js_1.isPlainObject)(result), `The Route Function ${routeDefinedAtString} should return a boolean or a plain JavaScript object (but it's ${picocolors_1.default.cyan(`typeof result === ${JSON.stringify(typeof result)}`)} instead)`);
+    (0, utils_js_1.assertUsage)((0, utils_js_1.isPlainObject)(result), `The Route Function ${routeFunctionFilePath} should return a boolean or a plain JavaScript object (but it's ${picocolors_1.default.cyan(`typeof result === ${JSON.stringify(typeof result)}`)} instead)`);
     // AFAICT this return interface is superfluous. Should we soft-deprecate it and remove it?
     if ('match' in result) {
         const { match } = result;
-        (0, utils_js_1.assertUsage)(typeof match === 'boolean', `The ${picocolors_1.default.cyan('match')} value returned by the Route Function ${routeDefinedAtString} should be a boolean.`);
+        (0, utils_js_1.assertUsage)(typeof match === 'boolean', `The ${picocolors_1.default.cyan('match')} value returned by the Route Function ${routeFunctionFilePath} should be a boolean.`);
         if (!match) {
             return null;
         }
@@ -36,14 +40,14 @@ async function resolveRouteFunction(routeFunction, pageContext, routeDefinedAtSt
     let precedence = null;
     if ('precedence' in result) {
         precedence = result.precedence;
-        (0, utils_js_1.assertUsage)(typeof precedence === 'number', `The ${picocolors_1.default.cyan('precedence')} value returned by the Route Function ${routeDefinedAtString} should be a number.`);
+        (0, utils_js_1.assertUsage)(typeof precedence === 'number', `The ${picocolors_1.default.cyan('precedence')} value returned by the Route Function ${routeFunctionFilePath} should be a number.`);
     }
-    assertRouteParams(result, `The ${picocolors_1.default.cyan('routeParams')} object returned by the Route Function ${routeDefinedAtString} should`);
+    assertRouteParams(result, `The ${picocolors_1.default.cyan('routeParams')} object returned by the Route Function ${routeFunctionFilePath} should`);
     const routeParams = result.routeParams || {};
     (0, utils_js_1.assertUsage)(!('pageContext' in result), `Providing ${picocolors_1.default.cyan('pageContext')} in Route Functions is prohibited, see https://vike.dev/route-function#cannot-provide-pagecontext`);
     (0, utils_js_1.assert)((0, utils_js_1.isPlainObject)(routeParams));
     Object.keys(result).forEach((key) => {
-        (0, utils_js_1.assertUsage)(key === 'match' || key === 'routeParams' || key === 'precedence', `The Route Function ${routeDefinedAtString} returned an object with an unknown property ${picocolors_1.default.cyan(key)} (the known properties are ${picocolors_1.default.cyan('match')}, ${picocolors_1.default.cyan('routeParams')}, and ${picocolors_1.default.cyan('precedence')})`);
+        (0, utils_js_1.assertUsage)(key === 'match' || key === 'routeParams' || key === 'precedence', `The Route Function ${routeFunctionFilePath} returned an object with an unknown property ${picocolors_1.default.cyan(key)} (the known properties are ${picocolors_1.default.cyan('match')}, ${picocolors_1.default.cyan('routeParams')}, and ${picocolors_1.default.cyan('precedence')})`);
     });
     return {
         precedence,

package/dist/cjs/shared/utils.js

@@ -43,3 +43,5 @@ __exportStar(require("../utils/changeEnumerable.js"), exports);
 __exportStar(require("../utils/objectDefineProperty.js"), exports);
 __exportStar(require("../utils/isScriptFile.js"), exports);
 __exportStar(require("../utils/objectFilter.js"), exports);
+__exportStar(require("../utils/getPropAccessNotation.js"), exports);
+__exportStar(require("../utils/objectReplace.js"), exports);

package/dist/cjs/utils/PROJECT_VERSION.js

@@ -2,4 +2,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PROJECT_VERSION = void 0;
 // Automatically updated by @brillout/release-me
-exports.PROJECT_VERSION = '0.4.229-commit-7056ef0';
+exports.PROJECT_VERSION = '0.4.229-commit-5da80bf';

package/dist/cjs/utils/objectAssign.js

@@ -5,10 +5,10 @@ const assert_js_1 = require("./assert.js");
 // Same as Object.assign() but:
 //  - With type inference
 //  - Preserves property descriptors, which we need for preserving the getters of getPageContextUrlComputed()
-function objectAssign(obj, objAddendum, objAddendumCanBePageContextObject) {
+function objectAssign(obj, objAddendum, objAddendumCanBeOriginalObject) {
     if (!objAddendum)
         return;
-    if (!objAddendumCanBePageContextObject)
-        (0, assert_js_1.assert)(!('isPageContext' in objAddendum));
+    if (!objAddendumCanBeOriginalObject)
+        (0, assert_js_1.assert)(!objAddendum._isOriginalObject);
     Object.defineProperties(obj, Object.getOwnPropertyDescriptors(objAddendum));
 }

package/dist/cjs/utils/objectDefineProperty.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.objectDefineProperty = objectDefineProperty;
-/** Like Object.defineProperty() but with type inference */
+// Same as Object.defineProperty() but with type inference
 function objectDefineProperty(obj, prop, { get, ...args }) {
     Object.defineProperty(obj, prop, { ...args, get });
 }

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

@@ -1,7 +1,15 @@
 export { createPageContextClientSide };
+export type PageContextCreated = Awaited<ReturnType<typeof createPageContextClientSide>>;
 declare function createPageContextClientSide(urlOriginal: string): Promise<{
-    globalContext: {
+    _isOriginalObject: true;
+    isPageContext: true;
+} & {
+    isClientSide: true;
+    isPrerendering: false;
+    urlOriginal: string;
+    _globalContext: {
         isGlobalContext: true;
+        _isOriginalObject: true;
         _virtualFileExports: unknown;
         _pageFilesAll: import("../../shared/getPageFiles.js").PageFile[];
         _pageConfigs: import("../../__internal/index.js").PageConfig[];
@@ -30,16 +38,11 @@ declare function createPageContextClientSide(urlOriginal: string): Promise<{
     _allPageIds: string[];
     _pageRoutes: import("../../__internal/index.js").PageRoutes;
     _onBeforeRouteHook: import("../../shared/hooks/getHook.js").Hook | null;
-    isClientSide: boolean;
-    isPrerendering: boolean;
-    urlOriginal: string;
     _urlHandler: null;
-    _urlRewrite: null;
+    _urlRewrite: null | string;
     _baseServer: string;
 } & {
     urlParsed: import("./utils.js").UrlPublic;
     urlPathname: string;
     url: string;
-} & {
-    isPageContext: true;
 } & import("../../shared/page-configs/getUserFriendlyConfigs.js").PageConfigUserFriendly>;

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

@@ -1,5 +1,5 @@
 export { createPageContextClientSide };
-import { createPageContextShared } from '../../shared/createPageContextShared.js';
+import { createPageContextObject, createPageContextShared } from '../../shared/createPageContextShared.js';
 import { getPageContextUrlComputed } from '../../shared/getPageContextUrlComputed.js';
 import { getBaseServer } from './getBaseServer.js';
 import { getGlobalContextClientInternal } from './globalContext.js';
@@ -8,24 +8,22 @@ async function createPageContextClientSide(urlOriginal) {
     const globalContext = await getGlobalContextClientInternal();
     const baseServer = getBaseServer();
     assert(isBaseServer(baseServer));
-    const pageContextCreated = {
-        /* Don't spread globalContext for now? Or never spread it as it leads to confusion? The convenience isn't worth the added confusion?
-        ...globalContext, // least precedence
-        */
-        globalContext,
+    const pageContextCreated = createPageContextObject();
+    objectAssign(pageContextCreated, {
+        isClientSide: true,
+        isPrerendering: false,
+        urlOriginal,
+        _globalContext: globalContext,
         _pageFilesAll: globalContext._pageFilesAll,
         _pageConfigs: globalContext._pageConfigs,
         _pageConfigGlobal: globalContext._pageConfigGlobal,
         _allPageIds: globalContext._allPageIds,
         _pageRoutes: globalContext._pageRoutes,
         _onBeforeRouteHook: globalContext._onBeforeRouteHook,
-        isClientSide: true,
-        isPrerendering: false,
-        urlOriginal,
         _urlHandler: null,
         _urlRewrite: null,
         _baseServer: baseServer
-    };
+    });
     const pageContextUrlComputed = getPageContextUrlComputed(pageContextCreated);
     objectAssign(pageContextCreated, pageContextUrlComputed);
     const pageContextAugmented = await createPageContextShared(pageContextCreated, globalContext._pageConfigGlobal, globalContext._userFriendlyConfigsGlobal);