vike 0.4.144-commit-6aef8a6 → 0.4.144-commit-7f5e99a

package/dist/esm/shared/route/index.d.ts

@@ -1,5 +1,8 @@
 export { route };
-export type { PageRoutes, PageContextForRoute, RouteMatches };
+export type { PageContextForRoute };
+export type { PageContextFromRoute };
+export type { PageRoutes };
+export type { RouteMatches };
 import type { PageFile } from '../getPageFiles.js';
 import { PageContextUrlComputedPropsInternal, PageContextUrlSources } from '../addUrlComputedProps.js';
 import { type OnBeforeRouteHook } from './executeOnBeforeRouteHook.js';
@@ -13,6 +16,12 @@ type PageContextForRoute = PageContextUrlComputedPropsInternal & {
     _pageRoutes: PageRoutes;
     _onBeforeRouteHook: OnBeforeRouteHook | null;
 } & PageContextUrlSources;
+type PageContextFromRoute = {
+    _pageId: string | null;
+    routeParams: Record<string, string>;
+    _routingProvidedByOnBeforeRouteHook: boolean;
+    _routeMatches: RouteMatches;
+};
 type RouteMatch = {
     pageId: string;
     routeString?: string;
@@ -21,11 +30,4 @@ type RouteMatch = {
     routeParams: Record<string, string>;
 };
 type RouteMatches = 'CUSTOM_ROUTE' | RouteMatch[];
-declare function route(pageContext: PageContextForRoute): Promise<{
-    pageContextAddendum: {
-        _pageId: string | null;
-        routeParams: Record<string, string>;
-        _routingProvidedByOnBeforeRouteHook: boolean;
-        _routeMatches: RouteMatches;
-    } & Record<string, unknown>;
-}>;
+declare function route(pageContext: PageContextForRoute): Promise<PageContextFromRoute>;

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

@@ -33,7 +33,7 @@ async function route(pageContext) {
                     _routingProvidedByOnBeforeRouteHook: true,
                     _routeMatches: 'CUSTOM_ROUTE'
                 });
-                return { pageContextAddendum };
+                return pageContextAddendum;
             }
             // We already assign so that `pageContext.urlOriginal === pageContextAddendum.urlOriginal`; enabling the `onBeforeRoute()` hook to mutate `pageContext.urlOriginal` before routing.
             objectAssign(pageContext, pageContextAddendum);
@@ -99,7 +99,7 @@ async function route(pageContext) {
             _pageId: null,
             routeParams: {}
         });
-        return { pageContextAddendum };
+        return pageContextAddendum;
     }
     {
         const { routeParams } = winner;
@@ -109,5 +109,5 @@ async function route(pageContext) {
             routeParams: winner.routeParams
         });
     }
-    return { pageContextAddendum };
+    return pageContextAddendum;
 }

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

@@ -3,10 +3,10 @@ import { isErrorPageId } from '../error-page.js';
 import { assert, assertUsage, hasProp, slice } from './utils.js';
 import { deduceRouteStringFromFilesystemPath } from './deduceRouteStringFromFilesystemPath.js';
 import { isCallable } from '../utils.js';
-import { getConfigValue, getDefinedAtString, getHookFilePathToShowToUser } from '../page-configs/utils.js';
+import { getConfigDefinedAtString, getConfigValue, getDefinedAtString, getHookFilePathToShowToUser } from '../page-configs/helpers.js';
 import { warnDeprecatedAllowKey } from './resolveRouteFunction.js';
 async function loadPageRoutes(
-// TODO: remove all arguments and use GlobalContext instead
+// Remove all arguments and use GlobalContext instead?
 pageFilesAll, pageConfigs, pageConfigGlobal, allPageIds) {
     await Promise.all(pageFilesAll.filter((p) => p.fileType === '.page.route').map((p) => p.loadFile?.()));
     const { onBeforeRouteHook, filesystemRoots } = getGlobalHooks(pageFilesAll, pageConfigs, pageConfigGlobal);
@@ -136,12 +136,13 @@ function getPageRoutes(filesystemRoots, pageFilesAll, pageConfigs, allPageIds) {
 function getGlobalHooks(pageFilesAll, pageConfigs, pageConfigGlobal) {
     // V1 Design
     if (pageConfigs.length > 0) {
-        if (pageConfigGlobal.configValues.onBeforeRoute?.value) {
-            const configValue = pageConfigGlobal.configValues.onBeforeRoute;
+        const hookName = 'onBeforeRoute';
+        if (pageConfigGlobal.configValues[hookName]?.value) {
+            const configValue = pageConfigGlobal.configValues[hookName];
             const { value: hookFn } = configValue;
             const hookFilePath = getHookFilePathToShowToUser(configValue);
-            // TODO: use getConfigDefinedAtString()
-            assertUsage(isCallable(hookFn), `The hook onBeforeRoute() defined by ${hookFilePath} should be a function.`);
+            const hookDefinedAt = getConfigDefinedAtString('Hook', hookName, configValue);
+            assertUsage(isCallable(hookFn), `${hookDefinedAt} should be a function.`);
             const onBeforeRouteHook = {
                 hookFilePath: hookFilePath,
                 onBeforeRoute: hookFn

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

@@ -9,7 +9,7 @@ async function resolveRouteFunction(routeFunction, pageContext, routeDefinedAt)
     assertPageContextUrlComputedProps(pageContext);
     let result = routeFunction(pageContext);
     assertSyncRouting(result, `The Route Function ${routeDefinedAt}`);
-    // TODO/v1-release
+    // 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;
     //*/

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

@@ -15,7 +15,7 @@ export * from '../utils/stringifyStringArray.js';
 export * from '../utils/filesystemPathHandling.js';
 export * from '../utils/cast.js';
 export * from '../utils/projectInfo.js';
-export * from '../utils/hasPropertyGetter.js';
+export * from '../utils/isPropertyGetter.js';
 export * from '../utils/isPromise.js';
 export * from '../utils/checkType.js';
 export * from '../utils/objectEntries.js';

package/dist/esm/shared/utils.js

@@ -19,7 +19,7 @@ export * from '../utils/stringifyStringArray.js';
 export * from '../utils/filesystemPathHandling.js';
 export * from '../utils/cast.js';
 export * from '../utils/projectInfo.js';
-export * from '../utils/hasPropertyGetter.js';
+export * from '../utils/isPropertyGetter.js';
 export * from '../utils/isPromise.js';
 export * from '../utils/checkType.js';
 export * from '../utils/objectEntries.js';

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

@@ -0,0 +1 @@
+export declare function isPropertyGetter(obj: Object, prop: string): boolean;

package/dist/esm/utils/{hasPropertyGetter.js → isPropertyGetter.js}

@@ -1,4 +1,4 @@
-export function hasPropertyGetter(obj, prop) {
+export function isPropertyGetter(obj, prop) {
     const descriptor = Object.getOwnPropertyDescriptor(obj, prop);
     return !!descriptor && !('value' in descriptor) && !!descriptor.get;
 }

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

@@ -5,7 +5,7 @@ type ProjectVersion = typeof projectInfo.projectVersion;
 type ProjectTag = `[${PackageName}]` | `[${PackageName}@${ProjectVersion}]`;
 declare const projectInfo: {
     projectName: "Vike";
-    projectVersion: "0.4.144-commit-6aef8a6";
+    projectVersion: "0.4.144-commit-7f5e99a";
     npmPackageName: "vike";
     githubRepository: "https://github.com/vikejs/vike";
 };

package/dist/esm/utils/projectInfo.js

@@ -1,6 +1,6 @@
 export { projectInfo };
 import { onProjectInfo } from './assertSingleInstance.js';
-const PROJECT_VERSION = '0.4.144-commit-6aef8a6';
+const PROJECT_VERSION = '0.4.144-commit-7f5e99a';
 const projectInfo = {
     projectName: 'Vike',
     projectVersion: PROJECT_VERSION,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vike",
-  "version": "0.4.144-commit-6aef8a6",
+  "version": "0.4.144-commit-7f5e99a",
   "scripts": {
     "dev": "tsc --watch",
     "build": "rimraf dist/ && pnpm run build:esm && pnpm run build:cjs",
@@ -13,7 +13,7 @@
   },
   "dependencies": {
     "@brillout/import": "0.2.3",
-    "@brillout/json-serializer": "^0.5.6",
+    "@brillout/json-serializer": "^0.5.8",
     "@brillout/picocolors": "^1.0.9",
     "@brillout/require-shim": "^0.1.2",
     "@brillout/vite-plugin-import-build": "^0.2.20",

package/dist/cjs/shared/page-configs/utils.js

@@ -1,96 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getHookFilePathToShowToUser = exports.getConfigValueFilePathToShowToUser = exports.getDefinedAtString = exports.getConfigDefinedAtString = exports.getPageConfig = exports.getConfigValue = void 0;
-const utils_js_1 = require("../utils.js");
-const picocolors_1 = __importDefault(require("@brillout/picocolors"));
-const getExportPath_js_1 = require("./getExportPath.js");
-// prettier-ignore
-function getConfigValue(pageConfig, configName, type) {
-    const configValue = getConfigValueEntry(pageConfig, configName);
-    if (configValue === null)
-        return null;
-    const { value, definedAt } = configValue;
-    if (type)
-        assertConfigValueType(value, type, configName, definedAt);
-    return configValue;
-}
-exports.getConfigValue = getConfigValue;
-function assertConfigValueType(value, type, configName, definedAt) {
-    (0, utils_js_1.assert)(value !== null);
-    const typeActual = typeof value;
-    if (typeActual === type)
-        return;
-    const valuePrintable = (0, utils_js_1.getValuePrintable)(value);
-    const problem = valuePrintable !== null ? `value ${picocolors_1.default.cyan(valuePrintable)}` : `type ${picocolors_1.default.cyan(typeActual)}`;
-    const configDefinedAt = getConfigDefinedAtString(configName, { definedAt }, true);
-    (0, utils_js_1.assertUsage)(false, `${configDefinedAt} has an invalid ${problem}: it should be a ${picocolors_1.default.cyan(type)} instead`);
-}
-function getConfigValueEntry(pageConfig, configName) {
-    const configValue = pageConfig.configValues[configName];
-    if (!configValue)
-        return null;
-    // Enable users to suppress global config values by setting the local config value to null
-    if (configValue.value === null)
-        return null;
-    return configValue;
-}
-function getPageConfig(pageId, pageConfigs) {
-    const pageConfig = pageConfigs.find((p) => p.pageId === pageId);
-    (0, utils_js_1.assert)(pageConfigs.length > 0);
-    (0, utils_js_1.assert)(pageConfig);
-    return pageConfig;
-}
-exports.getPageConfig = getPageConfig;
-function getConfigDefinedAtString(configName, { definedAt }, sentenceBegin) {
-    const definedAtString = getDefinedAtString(definedAt, configName);
-    const definedAtStr = definedAtString === 'internally' ? definedAtString : `at ${definedAtString}`;
-    const configDefinedAt = `${sentenceBegin ? `Config` : `config`} ${picocolors_1.default.cyan(configName)} defined ${definedAtStr}`;
-    return configDefinedAt;
-}
-exports.getConfigDefinedAtString = getConfigDefinedAtString;
-function getDefinedAtString(definedAt, configName) {
-    if (definedAt.isComputed) {
-        return 'internally';
-    }
-    let files;
-    if (definedAt.isCumulative) {
-        files = definedAt.files;
-    }
-    else {
-        files = [definedAt.file];
-    }
-    (0, utils_js_1.assert)(files.length >= 1);
-    const definedAtString = files
-        .map((source) => {
-        const { filePathToShowToUser, fileExportPathToShowToUser } = source;
-        let s = filePathToShowToUser;
-        const exportPath = (0, getExportPath_js_1.getExportPath)(fileExportPathToShowToUser, configName);
-        if (exportPath) {
-            s = `${s} > ${picocolors_1.default.cyan(exportPath)}`;
-        }
-        return s;
-    })
-        .join(' / ');
-    return definedAtString;
-}
-exports.getDefinedAtString = getDefinedAtString;
-function getConfigValueFilePathToShowToUser({ definedAt }) {
-    // A unique file path only exists if the config value isn't cumulative nor computed:
-    //  - cumulative config values have multiple file paths
-    //  - computed values don't have any file path
-    if (definedAt.isComputed || definedAt.isCumulative)
-        return null;
-    const { filePathToShowToUser } = definedAt.file;
-    (0, utils_js_1.assert)(filePathToShowToUser);
-    return filePathToShowToUser;
-}
-exports.getConfigValueFilePathToShowToUser = getConfigValueFilePathToShowToUser;
-function getHookFilePathToShowToUser({ definedAt }) {
-    const filePathToShowToUser = getConfigValueFilePathToShowToUser({ definedAt });
-    (0, utils_js_1.assert)(filePathToShowToUser);
-    return filePathToShowToUser;
-}
-exports.getHookFilePathToShowToUser = getHookFilePathToShowToUser;

package/dist/esm/client/client-routing-runtime/skipLink/isClientSideRoutable.d.ts

@@ -1,2 +0,0 @@
-export { isClientSideRoutable };
-declare function isClientSideRoutable(url: string): Promise<boolean>;

package/dist/esm/client/client-routing-runtime/skipLink/isClientSideRoutable.js

@@ -1,15 +0,0 @@
-export { isClientSideRoutable };
-import { getPageId } from '../getPageId.js';
-import { analyzePageClientSideInit } from '../../../shared/getPageFiles/analyzePageClientSide.js';
-import { findPageConfig } from '../../../shared/page-configs/findPageConfig.js';
-import { analyzeClientSide } from '../../../shared/getPageFiles/analyzeClientSide.js';
-async function isClientSideRoutable(url) {
-    const { pageId, pageFilesAll, pageConfigs } = await getPageId(url);
-    if (!pageId) {
-        return false;
-    }
-    await analyzePageClientSideInit(pageFilesAll, pageId, { sharedPageFilesAlreadyLoaded: false });
-    const pageConfig = findPageConfig(pageConfigs, pageId);
-    const { isClientSideRenderable, isClientRouting } = analyzeClientSide(pageConfig, pageFilesAll, pageId);
-    return isClientSideRenderable && isClientRouting;
-}

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

@@ -1,6 +0,0 @@
-export { useClientRouter };
-export { disableClientRouting };
-export { isDisableAutomaticLinkInterception };
-declare function disableClientRouting(err: unknown, log: boolean): void;
-declare function useClientRouter(): void;
-declare function isDisableAutomaticLinkInterception(): boolean;

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

@@ -1,35 +0,0 @@
-export { getConfigValue };
-export { getPageConfig };
-export { getConfigDefinedAtString };
-export { getDefinedAtString };
-export { getConfigValueFilePathToShowToUser };
-export { getHookFilePathToShowToUser };
-import type { PageConfigRuntime, PageConfigBuildTime, ConfigValue, DefinedAt } from './PageConfig.js';
-import type { ConfigNameBuiltIn } from './Config.js';
-type PageConfigCommon = PageConfigRuntime | PageConfigBuildTime;
-type ConfigName = ConfigNameBuiltIn;
-declare function getConfigValue(pageConfig: PageConfigCommon, configName: ConfigName, type: 'string'): null | ConfigValue & {
-    value: string;
-};
-declare function getConfigValue(pageConfig: PageConfigCommon, configName: ConfigName, type: 'boolean'): null | ConfigValue & {
-    value: boolean;
-};
-declare function getConfigValue(pageConfig: PageConfigCommon, configName: ConfigName): null | ConfigValue & {
-    value: unknown;
-};
-declare function getPageConfig(pageId: string, pageConfigs: PageConfigRuntime[]): PageConfigRuntime;
-type ConfigDefinedAtUppercase<ConfigName extends string> = `Config ${ConfigName} defined ${'internally' | `at ${string}`}`;
-type ConfigDefinedAtLowercase<ConfigName extends string> = `config ${ConfigName} defined ${'internally' | `at ${string}`}`;
-declare function getConfigDefinedAtString<ConfigName extends string>(configName: ConfigName, { definedAt }: {
-    definedAt: DefinedAt;
-}, sentenceBegin: true): ConfigDefinedAtUppercase<ConfigName>;
-declare function getConfigDefinedAtString<ConfigName extends string>(configName: ConfigName, { definedAt }: {
-    definedAt: DefinedAt;
-}, sentenceBegin: false): ConfigDefinedAtLowercase<ConfigName>;
-declare function getDefinedAtString(definedAt: DefinedAt, configName: string): string;
-declare function getConfigValueFilePathToShowToUser({ definedAt }: {
-    definedAt: DefinedAt;
-}): null | string;
-declare function getHookFilePathToShowToUser({ definedAt }: {
-    definedAt: DefinedAt;
-}): string;

package/dist/esm/shared/page-configs/utils.js

@@ -1,90 +0,0 @@
-export { getConfigValue };
-export { getPageConfig };
-export { getConfigDefinedAtString };
-export { getDefinedAtString };
-export { getConfigValueFilePathToShowToUser };
-export { getHookFilePathToShowToUser };
-import { assert, assertUsage, getValuePrintable } from '../utils.js';
-import pc from '@brillout/picocolors';
-import { getExportPath } from './getExportPath.js';
-// prettier-ignore
-function getConfigValue(pageConfig, configName, type) {
-    const configValue = getConfigValueEntry(pageConfig, configName);
-    if (configValue === null)
-        return null;
-    const { value, definedAt } = configValue;
-    if (type)
-        assertConfigValueType(value, type, configName, definedAt);
-    return configValue;
-}
-function assertConfigValueType(value, type, configName, definedAt) {
-    assert(value !== null);
-    const typeActual = typeof value;
-    if (typeActual === type)
-        return;
-    const valuePrintable = getValuePrintable(value);
-    const problem = valuePrintable !== null ? `value ${pc.cyan(valuePrintable)}` : `type ${pc.cyan(typeActual)}`;
-    const configDefinedAt = getConfigDefinedAtString(configName, { definedAt }, true);
-    assertUsage(false, `${configDefinedAt} has an invalid ${problem}: it should be a ${pc.cyan(type)} instead`);
-}
-function getConfigValueEntry(pageConfig, configName) {
-    const configValue = pageConfig.configValues[configName];
-    if (!configValue)
-        return null;
-    // Enable users to suppress global config values by setting the local config value to null
-    if (configValue.value === null)
-        return null;
-    return configValue;
-}
-function getPageConfig(pageId, pageConfigs) {
-    const pageConfig = pageConfigs.find((p) => p.pageId === pageId);
-    assert(pageConfigs.length > 0);
-    assert(pageConfig);
-    return pageConfig;
-}
-function getConfigDefinedAtString(configName, { definedAt }, sentenceBegin) {
-    const definedAtString = getDefinedAtString(definedAt, configName);
-    const definedAtStr = definedAtString === 'internally' ? definedAtString : `at ${definedAtString}`;
-    const configDefinedAt = `${sentenceBegin ? `Config` : `config`} ${pc.cyan(configName)} defined ${definedAtStr}`;
-    return configDefinedAt;
-}
-function getDefinedAtString(definedAt, configName) {
-    if (definedAt.isComputed) {
-        return 'internally';
-    }
-    let files;
-    if (definedAt.isCumulative) {
-        files = definedAt.files;
-    }
-    else {
-        files = [definedAt.file];
-    }
-    assert(files.length >= 1);
-    const definedAtString = files
-        .map((source) => {
-        const { filePathToShowToUser, fileExportPathToShowToUser } = source;
-        let s = filePathToShowToUser;
-        const exportPath = getExportPath(fileExportPathToShowToUser, configName);
-        if (exportPath) {
-            s = `${s} > ${pc.cyan(exportPath)}`;
-        }
-        return s;
-    })
-        .join(' / ');
-    return definedAtString;
-}
-function getConfigValueFilePathToShowToUser({ definedAt }) {
-    // A unique file path only exists if the config value isn't cumulative nor computed:
-    //  - cumulative config values have multiple file paths
-    //  - computed values don't have any file path
-    if (definedAt.isComputed || definedAt.isCumulative)
-        return null;
-    const { filePathToShowToUser } = definedAt.file;
-    assert(filePathToShowToUser);
-    return filePathToShowToUser;
-}
-function getHookFilePathToShowToUser({ definedAt }) {
-    const filePathToShowToUser = getConfigValueFilePathToShowToUser({ definedAt });
-    assert(filePathToShowToUser);
-    return filePathToShowToUser;
-}

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

@@ -1 +0,0 @@
-export declare function hasPropertyGetter(obj: Object, prop: string): boolean;