vike 0.4.259-commit-aa6fa94 → 0.4.259-commit-f6ecfb2

package/dist/node/vite/shared/resolveVikeConfigInternal/crawlPlusFilePaths.js

@@ -28,6 +28,7 @@ assertIsNotProductionRuntime();
 const globalObject = getGlobalObject('getVikeConfig/crawlPlusFilePaths.ts', {
     gitIsNotUsable: false,
 });
+// TODO/after-PR-merge rename crawlPlusFilePaths crawlPlusFiles
 async function crawlPlusFilePaths(userRootDir) {
     assertPosixPath(userRootDir);
     assertFilePathAbsoluteFilesystem(userRootDir);

package/dist/node/vite/shared/resolveVikeConfigInternal/getPlusFilesByLocationId.d.ts

@@ -1,10 +1,11 @@
 export { getPlusFilesByLocationId };
+export { getPlusFileFromConfigFile };
 export type { PlusFileValue };
 export type { PlusFile };
 export type { PlusFilesByLocationId };
 import { type LocationId } from './filesystemRouting.js';
 import { type EsbuildCache } from './transpileAndExecuteFile.js';
-import { PointerImportLoaded } from './loadFileAtConfigTime.js';
+import { type ConfigFile, PointerImportLoaded } from './loadFileAtConfigTime.js';
 import type { FilePathResolved } from '../../../../types/FilePath.js';
 import '../../assertEnvVite.js';
 type PlusFile = PlusFileConfig | PlusFileValue;
@@ -40,3 +41,4 @@ type PlusFileValue = PlusFileCommon & {
 };
 type PlusFilesByLocationId = Record<LocationId, PlusFile[]>;
 declare function getPlusFilesByLocationId(userRootDir: string, esbuildCache: EsbuildCache): Promise<PlusFilesByLocationId>;
+declare function getPlusFileFromConfigFile(configFile: ConfigFile, isExtensionConfig: boolean, locationId: LocationId, userRootDir: string): PlusFileConfig;

package/dist/node/vite/shared/resolveVikeConfigInternal/getPlusFilesByLocationId.js

@@ -1,4 +1,5 @@
 export { getPlusFilesByLocationId };
+export { getPlusFileFromConfigFile };
 import { assert } from '../../../../utils/assert.js';
 import { metaBuiltIn } from './metaBuiltIn.js';
 import { getLocationId } from './filesystemRouting.js';
@@ -9,6 +10,7 @@ import { resolvePointerImport } from './resolvePointerImport.js';
 import { getFilePathResolved } from '../getFilePath.js';
 import { assertExtensionsConventions, assertExtensionsRequire } from './assertExtensions.js';
 import '../../assertEnvVite.js';
+// TODO/after-PR-merge rename getPlusFilesByLocationId getPlusFiles
 async function getPlusFilesByLocationId(userRootDir, esbuildCache) {
     const plusFilePaths = (await crawlPlusFilePaths(userRootDir)).map(({ filePathAbsoluteUserRootDir }) => getFilePathResolved({ filePathAbsoluteUserRootDir, userRootDir }));
     const plusFilesByLocationId = {};

package/dist/node/vite/shared/resolveVikeConfigInternal/metaBuiltIn.js

@@ -103,6 +103,11 @@ const metaBuiltIn = {
     extends: {
         env: { config: true },
     },
+    pages: {
+        env: { config: true },
+        global: true,
+        cumulative: true,
+    },
     meta: {
         env: { config: true },
     },

package/dist/node/vite/shared/resolveVikeConfigInternal.js

@@ -40,11 +40,13 @@ import pc from '@brillout/picocolors';
 import { getConfigDefinedAt, getDefinedByString, } from '../../../shared-server-client/page-configs/getConfigDefinedAt.js';
 import { loadPointerImport, loadValueFile } from './resolveVikeConfigInternal/loadFileAtConfigTime.js';
 import { resolvePointerImport } from './resolveVikeConfigInternal/resolvePointerImport.js';
+import { parsePointerImportData } from './resolveVikeConfigInternal/pointerImports.js';
 import { getFilePathResolved } from './getFilePath.js';
 import { getConfigValueBuildTime } from '../../../shared-server-client/page-configs/getConfigValueBuildTime.js';
 import { resolveGlobalConfigPublic, } from '../../../shared-server-client/page-configs/resolveVikeConfigPublic.js';
 import { getConfigValuesBase, isJsonValue, } from '../../../shared-server-client/page-configs/serialize/serializeConfigValues.js';
-import { getPlusFilesByLocationId, } from './resolveVikeConfigInternal/getPlusFilesByLocationId.js';
+import { getPlusFilesByLocationId, getPlusFileFromConfigFile, } from './resolveVikeConfigInternal/getPlusFilesByLocationId.js';
+import { assertRouteString } from '../../../shared-server-client/route/resolveRouteString.js';
 import { getExtensionName } from './resolveVikeConfigInternal/assertExtensions.js';
 import { getEnvVarObject } from './getEnvVarObject.js';
 import { getVikeApiOperation } from '../../../shared-server-node/api-context.js';
@@ -322,35 +324,94 @@ function getPageConfigsBuildTime(configDefinitionsResolved, plusFilesByLocationI
     assertPageConfigGlobal(pageConfigGlobal, plusFilesByLocationId);
     const pageConfigs = objectEntries(configDefinitionsResolved.configDefinitionsLocal)
         .filter(([_locationId, { plusFiles }]) => isDefiningPage(plusFiles))
-        .map(([locationId, { configDefinitions, plusFilesRelevant }]) => {
-        const configDefinitionsLocal = configDefinitions;
-        const configValueSources = {};
-        objectEntries(configDefinitionsLocal)
-            .filter(([_configName, configDef]) => configDef.global !== true)
-            .forEach(([configName, configDef]) => {
-            const sources = resolveConfigValueSources(configName, configDef, plusFilesRelevant, userRootDir, false, plusFilesByLocationId);
-            if (sources.length === 0)
-                return;
-            configValueSources[configName] = sources;
-        });
-        const pageConfigRoute = determineRouteFilesystem(locationId, configValueSources);
-        applyEffects(configValueSources, configDefinitionsLocal, plusFilesByLocationId);
-        sortConfigValueSources(configValueSources, locationId);
-        const pageConfig = {
-            pageId: locationId,
-            ...pageConfigRoute,
-            configDefinitions: configDefinitionsLocal,
-            plusFiles: plusFilesRelevant,
-            configValueSources,
-        };
-        const configValuesComputed = getComputed(pageConfig);
-        objectAssign(pageConfig, { configValuesComputed });
-        checkType(pageConfig);
-        return pageConfig;
-    });
+        .map(([locationId, { configDefinitions, plusFilesRelevant }]) => resolvePageConfigBuildTime(locationId, locationId, plusFilesRelevant, configDefinitions, plusFilesByLocationId, userRootDir));
+    // Pages defined programmatically via +pages
+    pageConfigs.push(...getProgrammaticPageConfigs(configDefinitionsResolved, plusFilesByLocationId, userRootDir));
     assertPageConfigs(pageConfigs);
     return { pageConfigs, pageConfigGlobal };
 }
+function resolvePageConfigBuildTime(pageId, locationId, plusFilesRelevant, configDefinitionsLocal, plusFilesByLocationId, userRootDir) {
+    const configValueSources = {};
+    objectEntries(configDefinitionsLocal)
+        .filter(([_configName, configDef]) => configDef.global !== true)
+        .forEach(([configName, configDef]) => {
+        const sources = resolveConfigValueSources(configName, configDef, plusFilesRelevant, userRootDir, false, plusFilesByLocationId);
+        if (sources.length === 0)
+            return;
+        configValueSources[configName] = sources;
+    });
+    const pageConfigRoute = determineRouteFilesystem(locationId, configValueSources);
+    applyEffects(configValueSources, configDefinitionsLocal, plusFilesByLocationId);
+    sortConfigValueSources(configValueSources, locationId);
+    const pageConfig = {
+        pageId,
+        ...pageConfigRoute,
+        configDefinitions: configDefinitionsLocal,
+        plusFiles: plusFilesRelevant,
+        configValueSources,
+    };
+    const configValuesComputed = getComputed(pageConfig);
+    objectAssign(pageConfig, { configValuesComputed });
+    checkType(pageConfig);
+    return pageConfig;
+}
+/**
+ * Get the pages defined programmatically via +pages
+ */
+function getProgrammaticPageConfigs(configDefinitionsResolved, plusFilesByLocationId, userRootDir) {
+    const pageConfigs = [];
+    const entryIndexByLocationId = {};
+    // +pages can be set in a +config.js or +pages.js file — getConfVal() handles both
+    const plusFilesDefiningPages = Object.values(plusFilesByLocationId)
+        .flat()
+        .filter((plusFile) => {
+        const confVal = getConfVal(plusFile, 'pages');
+        return !!confVal && confVal.valueIsLoaded;
+    });
+    plusFilesDefiningPages.forEach((plusFileDefiningPages) => {
+        const locationIdAnchor = plusFileDefiningPages.locationId;
+        const local = configDefinitionsResolved.configDefinitionsLocal[locationIdAnchor];
+        assert(local);
+        const confVal = getConfVal(plusFileDefiningPages, 'pages');
+        assert(confVal?.valueIsLoaded);
+        const pages = confVal.value;
+        const definedAt = plusFileDefiningPages.filePath.filePathToShowToUser;
+        assertUsage(Array.isArray(pages), `${definedAt} sets ${pc.cyan('+pages')} to an invalid value: it should be an array`);
+        pages.forEach((entry, i) => {
+            const definedAtEntry = `${definedAt} > ${pc.cyan(`pages[${i}]`)}`;
+            assertUsage(isObject(entry), `${definedAtEntry} should be an object`);
+            assertUsage('route' in entry, `${definedAtEntry} should set ${pc.cyan('+route')}`);
+            // A Route Function can't be inlined (a function can't be serialized to the runtime): it must be a pointer import
+            assertUsage(!isCallable(entry.route), `${definedAtEntry} sets ${pc.cyan('+route')} to a function, but a Route Function can't be inlined — define the Route Function in a separate file and import it with ${pc.cyan("{ type: 'vike:pointer' }")} instead (so that Vike can load it at runtime)`);
+            assertUsage(typeof entry.route === 'string', `${definedAtEntry} should set ${pc.cyan('+route')} to a Route String or Route Function`);
+            // A Route String is validated now; a Route Function (pointer import) is validated at runtime.
+            if (!parsePointerImportData(entry.route))
+                assertRouteString(entry.route, `${definedAtEntry} sets an invalid`);
+            assertUsage(!('extends' in entry), `${definedAtEntry} sets ${pc.cyan('+extends')} which isn't supported for programmatically defined pages`);
+            const index = entryIndexByLocationId[locationIdAnchor] ?? 0;
+            entryIndexByLocationId[locationIdAnchor] = index + 1;
+            const base = locationIdAnchor === '/' ? '' : locationIdAnchor;
+            // The page's virtual locationId = its inheritance position (a child of the +config.js that defines +pages) so that:
+            // - The page's own values (`entry`) only apply to that page
+            // - The page inherits as usual
+            const locationIdVirtual = `${base}/(+pages)/entry:${index}`;
+            // Hack: treat `entry` as the page's own +config.js — getPlusFileFromConfigFile() makes pointer imports (e.g. +Page) resolve to runtime imports.
+            const plusFileVirtual = getPlusFileFromConfigFile({ fileExports: { default: entry }, filePath: plusFileDefiningPages.filePath, extendsFilePaths: [] }, false, locationIdVirtual, userRootDir);
+            getConfigNamesSetByPlusFile(plusFileVirtual).forEach((configName) => {
+                // Warn on unknown configs
+                isUnknownConfig(configName, local.configNamesKnownLocal, configDefinitionsResolved, locationIdAnchor, true, definedAtEntry);
+                // A global config (e.g. +onBeforeRoute) applies app-wide and can't be set on a single page. (We check `global === true` so conditionally-global configs such as +prerender, whose `global` is a function, are still allowed per-page.)
+                const configDefGlobal = configDefinitionsResolved.configDefinitionsGlobal[configName];
+                assertUsage(configDefGlobal?.global !== true, `${definedAtEntry} sets the global config ${pc.cyan(`+${configName}`)} which can't be set on a single page — set it at a global config file instead`);
+            });
+            // The page's own values (`entry`) first (most-specific), then the inherited configs
+            const plusFilesRelevant = [plusFileVirtual, ...local.plusFilesRelevant];
+            // Perf: resolvePageConfigBuildTime() re-resolves the inherited config per entry — fine for typical +pages array length. But for very large +pages arrays this might be too slow: consider resolving the inherited part once and re-use.
+            pageConfigs.push(resolvePageConfigBuildTime(locationIdVirtual, locationIdVirtual, plusFilesRelevant, local.configDefinitions, plusFilesByLocationId, userRootDir));
+        });
+    });
+    return pageConfigs;
+}
 function assertPageConfigGlobal(pageConfigGlobal, plusFilesByLocationId) {
     Object.entries(pageConfigGlobal.configValueSources).forEach(([configName, sources]) => {
         assertGlobalConfigLocation(configName, sources, plusFilesByLocationId, pageConfigGlobal.configDefinitions);
@@ -397,10 +458,18 @@ function assertGlobalConfigLocation(configName, sources, plusFilesByLocationId,
     });
 }
 function assertPageConfigs(pageConfigs) {
+    assertNoDuplicatePageIds(pageConfigs);
     pageConfigs.forEach((pageConfig) => {
         assertOnBeforeRenderEnv(pageConfig);
     });
 }
+function assertNoDuplicatePageIds(pageConfigs) {
+    const seen = new Set();
+    pageConfigs.forEach(({ pageId }) => {
+        assert(!seen.has(pageId));
+        seen.add(pageId);
+    });
+}
 function assertOnBeforeRenderEnv(pageConfig) {
     const onBeforeRenderConfig = pageConfig.configValueSources.onBeforeRender?.[0];
     if (!onBeforeRenderConfig)
@@ -812,6 +881,9 @@ function isDefiningPage(plusFiles) {
 function isDefiningPageConfig(configName) {
     return ['Page', 'route'].includes(configName);
 }
+function isDefiningProgrammaticPages(plusFiles) {
+    return plusFiles.some((plusFile) => getConfigNamesSetByPlusFile(plusFile).includes('pages'));
+}
 function resolveIsGlobalValue(configDefGlobal, source, plusFilesByLocationId) {
     assert(source.valueIsLoaded);
     let isGlobal;
@@ -1218,7 +1290,9 @@ function resolveConfigEnv(configEnv, filePath) {
 /** Whether configs defined in `locationId` apply to every page */
 function isGlobalLocation(locationId, plusFilesByLocationId) {
     const locationIdsPage = objectEntries(plusFilesByLocationId)
-        .filter(([_locationId, plusFiles]) => isDefiningPage(plusFiles))
+        .filter(([_locationId, plusFiles]) => isDefiningPage(plusFiles) ||
+        // Also add locationId if it defines +pages — programmatic pages are anchored there, so a config that doesn't cover them isn't global.
+        isDefiningProgrammaticPages(plusFiles))
         .map(([locationId]) => locationId);
     return locationIdsPage.every((locId) => isInherited(locationId, locId));
 }

package/dist/types/Config.d.ts

@@ -56,8 +56,8 @@ type HookName = HookNamePage | HookNameGlobal;
 type HookNamePage = 'onHydrationEnd' | 'onBeforePrerenderStart' | 'onBeforeRender' | 'onPageTransitionStart' | 'onPageTransitionEnd' | 'onRenderHtml' | 'onRenderClient' | 'guard' | 'data' | 'onData' | 'route';
 type HookNameGlobal = 'onBeforeRoute' | 'onPrerenderStart' | 'onCreatePageContext' | 'onCreateGlobalContext' | 'onError' | 'onHookCall';
 type HookNameOldDesign = 'render' | 'prerender' | 'onBeforePrerender';
-type ConfigNameBuiltIn = Exclude<keyof ConfigBuiltIn, keyof VikeVitePluginOptions | 'onBeforeRoute' | 'onPrerenderStart' | 'vite' | 'redirects'> | 'prerender' | 'hasServerOnlyHook' | 'isClientRuntimeLoaded' | 'onBeforeRenderEnv' | 'dataEnv' | 'guardEnv' | 'hooksTimeout' | 'clientHooks' | 'middleware' | 'server' | 'vercel';
-type ConfigNameBuiltInGlobal = 'onPrerenderStart' | 'onBeforeRoute' | 'prerender' | 'disableAutoFullBuild' | 'includeAssetsImportedByServer' | 'baseAssets' | 'baseServer' | 'redirects' | 'trailingSlash' | 'disableUrlNormalization' | 'vite';
+type ConfigNameBuiltIn = Exclude<keyof ConfigBuiltIn, keyof VikeVitePluginOptions | 'onBeforeRoute' | 'onPrerenderStart' | 'vite' | 'redirects' | 'pages'> | 'prerender' | 'hasServerOnlyHook' | 'isClientRuntimeLoaded' | 'onBeforeRenderEnv' | 'dataEnv' | 'guardEnv' | 'hooksTimeout' | 'clientHooks' | 'middleware' | 'server' | 'vercel';
+type ConfigNameBuiltInGlobal = 'onPrerenderStart' | 'onBeforeRoute' | 'pages' | 'prerender' | 'disableAutoFullBuild' | 'includeAssetsImportedByServer' | 'baseAssets' | 'baseServer' | 'redirects' | 'trailingSlash' | 'disableUrlNormalization' | 'vite';
 type Config = ConfigBuiltIn & Vike.Config;
 /** @deprecated This type is deprecated, see:
  * - https://vike.dev/migration/hook-types
@@ -255,6 +255,12 @@ type ConfigBuiltIn = {
      *  https://vike.dev/route
      */
     route?: Route | ImportStringList;
+    /**
+     * @experimental
+     *
+     * Programmatically define pages.
+     */
+    pages?: ConfigPageEntry[];
     /** Protect page(s), e.g. forbid unauthorized access.
      *
      *  https://vike.dev/guard
@@ -675,3 +681,10 @@ type ConfigBuiltInResolved = {
     staticReplace?: StaticReplace[][];
 };
 type ConfigMeta = Record<string, ConfigDefinition>;
+type ConfigPageEntry = Omit<Config, 'pages' | 'extends' | 'route'> & {
+    /** The page's URL — a Route String or a Route Function.
+     *
+     *  https://vike.dev/route
+     */
+    route: Route;
+};

package/dist/utils/PROJECT_VERSION.d.ts

@@ -1 +1 @@
-export declare const PROJECT_VERSION: "0.4.259-commit-aa6fa94";
+export declare const PROJECT_VERSION: "0.4.259-commit-f6ecfb2";

package/dist/utils/PROJECT_VERSION.js

@@ -1,2 +1,2 @@
 // Automatically updated by @brillout/release-me
-export const PROJECT_VERSION = '0.4.259-commit-aa6fa94';
+export const PROJECT_VERSION = '0.4.259-commit-f6ecfb2';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vike",
-  "version": "0.4.259-commit-aa6fa94",
+  "version": "0.4.259-commit-f6ecfb2",
   "repository": "https://github.com/vikejs/vike",
   "exports": {
     "./server": {