vike 0.4.143 → 0.4.144-commit-68c730d

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

@@ -1,98 +1,105 @@
-export type { PageConfig };
-export type { PageConfigLoaded };
+export type { PageConfigRuntime };
+export type { PageConfigRuntimeLoaded };
 export type { PageConfigBuildTime };
-export type { PageConfigCommon };
-export type { ConfigEnvInternal };
 export type { ConfigEnv };
-export type { PageConfigGlobal };
-export type { PageConfigGlobalData };
-export type { ConfigSource };
+export type { ConfigEnvInternal };
+export type { PageConfigGlobalRuntime };
+export type { PageConfigGlobalBuildTime };
 export type { ConfigValue };
 export type { ConfigValues };
 export type { ConfigValueSource };
 export type { ConfigValueSources };
-export type { DefinedAtInfo };
-export type { DefinedAtInfoFull };
-type ConfigEnv = 'client-only' | 'server-only' | 'server-and-client' | 'config-only';
-type ConfigEnvInternal = ConfigEnv | '_routing-eager' | '_routing-lazy';
-type PageConfigBuildTime = PageConfigCommon & {
-    configValueSources: ConfigValueSources;
-};
-type PageConfigCommon = {
+export type { ConfigValueComputed };
+export type { ConfigValuesComputed };
+export type { DefinedAt };
+export type { DefinedAtFile };
+export type { DefinedAtFileInfo };
+import type { ConfigValueImported } from './serialize/PageConfigSerialized.js';
+type PageConfigBase = {
     pageId: string;
-    isErrorPage: boolean;
-    routeFilesystem: null | {
+    isErrorPage?: true;
+    routeFilesystem?: {
         routeString: string;
         definedBy: string;
     };
+};
+/** Page config data structure available and used at runtime */
+type PageConfigRuntime = PageConfigBase & {
+    /** Loaded config values */
     configValues: ConfigValues;
+    /** Load config values that are lazily loaded such as config.Page */
+    loadConfigValuesAll: () => Promise<ConfigValueImported[]>;
+};
+/** Same as PageConfigRuntime but also contains all lazily loaded config values such as config.Page */
+type PageConfigRuntimeLoaded = PageConfigRuntime & {
+    /** Whether loadConfigValuesAll() was called */
+    isLoaded: true;
 };
+/** Page config data structure available and used at build-time */
+type PageConfigBuildTime = PageConfigBase & {
+    configValues: ConfigValues;
+    configValueSources: ConfigValueSources;
+    configValuesComputed: ConfigValuesComputed;
+};
+/** Page config that applies to all pages */
+type PageConfigGlobalRuntime = {
+    configValues: ConfigValues;
+};
+type PageConfigGlobalBuildTime = {
+    configValueSources: ConfigValueSources;
+};
+type ConfigEnv = 'client-only' | 'server-only' | 'server-and-client' | 'config-only';
+/** For Vike internal use */
+type ConfigEnvInternal = ConfigEnv | '_routing-eager' | '_routing-lazy';
 type ConfigValueSource = {
-    configEnv: ConfigEnvInternal;
-    valueSerialized?: string;
     value?: unknown;
+    configEnv: ConfigEnvInternal;
+    definedAtInfo: DefinedAtFileInfo;
+    /** Wether the config value is loaded at run-time, for example config.Page or config.onBeforeRender */
     valueIsImportedAtRuntime: boolean;
+    /** Whether the config value is a file path, for example config.client */
     valueIsFilePath?: true;
-} & ({
-    isComputed: false;
-    definedAtInfo: DefinedAtInfo;
-} | {
-    isComputed: true;
-    definedAtInfo: null;
-    valueIsImportedAtRuntime: false;
-});
+};
+type ConfigValueComputed = {
+    configEnv: ConfigEnvInternal;
+    value: unknown;
+};
+type ConfigValuesComputed = Record<string, ConfigValueComputed>;
 type ConfigValueSources = Record<string, ConfigValueSource[]>;
 type ConfigValue = {
     value: unknown;
-    valueSerialized?: string;
-    definedAtInfo: null | DefinedAtInfo;
+    definedAt: DefinedAt;
 };
 type ConfigValues = Record<string, ConfigValue>;
-type DefinedAtInfo = {
-    filePath: string;
-    fileExportPath: string[];
-};
-type DefinedAtInfoFull = {
-    filePathRelativeToUserRootDir?: string;
-    filePathAbsolute: string;
-    fileExportPath: string[];
-};
-type ConfigSource = {
-    configSourceFile: string;
-} & ({
-    configSourceFileExportName: string;
-    configSourceFileDefaultExportKey?: undefined;
+type DefinedAt = {
+    file: DefinedAtFile;
+    isEffect?: true;
+    isComputed?: undefined;
+    isCumulative?: undefined;
 } | {
-    configSourceFileDefaultExportKey: string;
-    configSourceFileExportName?: undefined;
-});
-type PageConfig = PageConfigCommon & {
-    loadConfigValuesAll: LoadConfigValuesAll;
-    isLoaded?: true;
-};
-type PageConfigLoaded = PageConfig & {
-    isLoaded: true;
-};
-type PageConfigGlobalData = {
-    onPrerenderStart: null | ConfigValueSource;
-    onBeforeRoute: null | ConfigValueSource;
+    isCumulative: true;
+    files: DefinedAtFile[];
+    isEffect?: undefined;
+    isComputed?: undefined;
+} | {
+    isComputed: true;
+    isEffect?: undefined;
+    isCumulative?: undefined;
 };
-type PageConfigGlobal = {
-    onPrerenderStart: null | (ConfigValueSource & {
-        value: unknown;
-    });
-    onBeforeRoute: null | (ConfigValueSource & {
-        value: unknown;
-    });
+type DefinedAtFile = {
+    filePathToShowToUser: string;
+    fileExportPath: null | string[];
 };
-type LoadConfigValuesAll = () => Promise<({
-    configName: string;
-    importFilePath: string;
-} & ({
-    isPlusFile: true;
-    importFileExports: Record<string, unknown>;
+type DefinedAtFileInfo = // TODO: replace filePathRelativeToUserRootDir and importPathAbsolute with following?
+({
+    filePathRelativeToUserRootDir: string;
+    filePathAbsoluteFilesystem: string;
+    importPathAbsolute: null;
 } | {
-    isPlusFile: false;
-    importFileExportName: string;
-    importFileExportValue: unknown;
-}))[]>;
+    filePathRelativeToUserRootDir: null;
+    filePathAbsoluteFilesystem: string | null;
+    importPathAbsolute: string;
+}) & {
+    exportName?: string;
+    fileExportPath: null | string[];
+};

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

@@ -0,0 +1,6 @@
+export { assertExportsOfValueFile };
+export { assertExportsOfConfigFile };
+declare function assertExportsOfValueFile(fileExports: Record<string, unknown>, filePathToShowToUser: string, configName: string): void;
+declare function assertExportsOfConfigFile(fileExports: Record<string, unknown>, filePathToShowToUser: string): asserts fileExports is {
+    default: Record<string, unknown>;
+};

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

@@ -0,0 +1,54 @@
+export { assertExportsOfValueFile };
+export { assertExportsOfConfigFile };
+import { assert, assertUsage, assertWarning, isObject } from '../utils.js';
+import pc from '@brillout/picocolors';
+const EXPORTS_IGNORE = [
+    // vite-plugin-solid adds `export { $$registrations }`
+    '$$registrations',
+    // @vitejs/plugin-vue adds `export { _rerender_only }`
+    '_rerender_only'
+];
+// Tolerate `export { frontmatter }` in .mdx files
+const TOLERATE_SIDE_EXPORTS = ['.md', '.mdx'];
+function assertExportsOfValueFile(fileExports, filePathToShowToUser, configName) {
+    assertExports(fileExports, filePathToShowToUser, configName);
+}
+function assertExportsOfConfigFile(fileExports, filePathToShowToUser) {
+    assertExports(fileExports, filePathToShowToUser);
+    const exportDefault = fileExports.default;
+    assertUsage(isObject(exportDefault), `The ${pc.cyan('export default')} of ${filePathToShowToUser} should be an object (but it's ${pc.cyan(`typeof exportDefault === ${JSON.stringify(typeof exportDefault)}`)} instead)`);
+}
+function assertExports(fileExports, filePathToShowToUser, configName) {
+    const exportsAll = Object.keys(fileExports);
+    const exportsRelevant = exportsAll.filter((exportName) => !EXPORTS_IGNORE.includes(exportName));
+    const exportsInvalid = exportsRelevant.filter((e) => e !== 'default' &&
+        // !!configName => isValueFile
+        e !== configName);
+    if (exportsInvalid.length === 0) {
+        if (exportsRelevant.length === 1) {
+            return;
+        }
+        else {
+            assert(exportsRelevant.length === 0);
+            let errMsg = `${filePathToShowToUser} doesn't export any value, but it should have a ${pc.cyan('export default')}`;
+            if (configName)
+                errMsg += ` or ${pc.cyan(`export { ${configName} }`)}`;
+            assertUsage(false, errMsg);
+        }
+    }
+    else {
+        // !configName => isConfigFile
+        if (!configName) {
+            const exportsInvalidStr = exportsInvalid.join(', ');
+            assertUsage(false, `${filePathToShowToUser} replace ${pc.cyan(`export { ${exportsInvalidStr} }`)} with ${pc.cyan(`export default { ${exportsInvalidStr} }`)}`);
+        }
+        // !!configName => isValueFile
+        else {
+            if (TOLERATE_SIDE_EXPORTS.some((ext) => filePathToShowToUser.endsWith(ext)))
+                return;
+            exportsInvalid.forEach((exportInvalid) => {
+                assertWarning(false, `${filePathToShowToUser} should have only a single export: move ${pc.cyan(`export { ${exportInvalid} }`)} to +config.h.js or its own +${exportsInvalid}.js`, { onlyOnce: true });
+            });
+        }
+    }
+}

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

@@ -1,3 +1,3 @@
 export { findPageConfig };
-import type { PageConfig } from './PageConfig.js';
-declare function findPageConfig(pageConfigs: PageConfig[], pageId: string): null | PageConfig;
+import type { PageConfigRuntime } from './PageConfig.js';
+declare function findPageConfig(pageConfigs: PageConfigRuntime[], pageId: string): null | PageConfigRuntime;

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

@@ -1,2 +1,2 @@
 export { getExportPath };
-declare function getExportPath(fileExportPath: string[]): null | string;
+declare function getExportPath(fileExportPath: null | string[], configName: string): null | string;

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

@@ -1,18 +1,17 @@
 export { getExportPath };
 import { assert } from '../utils.js';
-// TODO: return null instead of 'export default'
-//  - Also return null insead of 'export *'?
-function getExportPath(fileExportPath) {
-    let prefix = '';
-    let suffix = '';
+function getExportPath(fileExportPath, configName) {
+    if (!fileExportPath)
+        return null;
     let [exportName, ...exportObjectPath] = fileExportPath;
     if (!exportName)
         return null;
-    if (exportName === '*') {
-        assert(exportObjectPath.length === 0);
-        return 'export *';
-    }
-    else if (exportName === 'default') {
+    if (exportObjectPath.length === 0 && ['*', 'default', configName].includes(exportName))
+        return null;
+    assert(exportName !== '*');
+    let prefix = '';
+    let suffix = '';
+    if (exportName === 'default') {
         prefix = 'export default';
     }
     else {

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

@@ -0,0 +1,3 @@
+export { loadConfigValues };
+import type { PageConfigRuntime, PageConfigRuntimeLoaded } from './PageConfig.js';
+declare function loadConfigValues(pageConfig: PageConfigRuntime, isDev: boolean): Promise<PageConfigRuntimeLoaded>;

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

@@ -0,0 +1,15 @@
+export { loadConfigValues };
+import { objectAssign } from '../utils.js';
+import { parseConfigValuesImported } from './serialize/parseConfigValuesImported.js';
+async function loadConfigValues(pageConfig, isDev) {
+    if ('isLoaded' in pageConfig &&
+        // We don't need to cache in dev, since Vite already caches the virtual module
+        !isDev) {
+        return pageConfig;
+    }
+    const configValuesImported = await pageConfig.loadConfigValuesAll();
+    const configValuesAddendum = parseConfigValuesImported(configValuesImported);
+    Object.assign(pageConfig.configValues, configValuesAddendum);
+    objectAssign(pageConfig, { isLoaded: true });
+    return pageConfig;
+}

package/dist/esm/shared/page-configs/serialize/PageConfigSerialized.d.ts

@@ -0,0 +1,32 @@
+export type { PageConfigRuntimeSerialized };
+export type { PageConfigGlobalRuntimeSerialized };
+export type { ConfigValueSerialized };
+export type { ConfigValueImported };
+import type { DefinedAt, PageConfigRuntime } from '../PageConfig.js';
+/** page config data structure serialized in virtual files: parsing it results in PageConfigRuntime */
+type PageConfigRuntimeSerialized = Omit<PageConfigRuntime, 'configValues'> & {
+    /** Config values that are loaded eagerly and serializable such as config.passToClient */
+    configValuesSerialized: Record<string, ConfigValueSerialized>;
+    /** Config values imported eagerly such as config.route */
+    configValuesImported: ConfigValueImported[];
+};
+type PageConfigGlobalRuntimeSerialized = {
+    configValuesImported: ConfigValueImported[];
+};
+/** Value is serialized. */
+type ConfigValueSerialized = {
+    valueSerialized: string;
+    definedAt: DefinedAt;
+};
+/** Value is imported. */
+type ConfigValueImported = {
+    configName: string;
+    importPath: string;
+} & ({
+    isValueFile: true;
+    exportValues: Record<string, unknown>;
+} | {
+    isValueFile: false;
+    exportName: string;
+    exportValue: unknown;
+});

package/dist/esm/shared/page-configs/serialize/PageConfigSerialized.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/shared/page-configs/serialize/assertPageConfigs.d.ts

@@ -0,0 +1,5 @@
+export { assertPageConfigsSerialized };
+export { assertPageConfigGlobalSerialized };
+import type { PageConfigGlobalRuntimeSerialized, PageConfigRuntimeSerialized } from './PageConfigSerialized.js';
+declare function assertPageConfigsSerialized(pageConfigsSerialized: unknown): asserts pageConfigsSerialized is PageConfigRuntimeSerialized[];
+declare function assertPageConfigGlobalSerialized(pageConfigGlobalSerialized: unknown): asserts pageConfigGlobalSerialized is PageConfigGlobalRuntimeSerialized;

package/dist/esm/shared/page-configs/serialize/assertPageConfigs.js

@@ -0,0 +1,16 @@
+export { assertPageConfigsSerialized };
+export { assertPageConfigGlobalSerialized };
+import { assert, isObject, hasProp } from '../../utils.js';
+function assertPageConfigsSerialized(pageConfigsSerialized) {
+    assert(Array.isArray(pageConfigsSerialized));
+    pageConfigsSerialized.forEach((pageConfigSerialized) => {
+        assert(isObject(pageConfigSerialized));
+        assert(hasProp(pageConfigSerialized, 'pageId', 'string'));
+        assert(hasProp(pageConfigSerialized, 'routeFilesystem'));
+        assert(hasProp(pageConfigSerialized, 'configValuesSerialized'));
+        assert(hasProp(pageConfigSerialized, 'configValuesImported'));
+    });
+}
+function assertPageConfigGlobalSerialized(pageConfigGlobalSerialized) {
+    assert(hasProp(pageConfigGlobalSerialized, 'configValuesImported'));
+}

package/dist/esm/shared/page-configs/serialize/parseConfigValuesImported.d.ts

@@ -0,0 +1,4 @@
+export { parseConfigValuesImported };
+import type { ConfigValues } from '../PageConfig.js';
+import type { ConfigValueImported } from './PageConfigSerialized.js';
+declare function parseConfigValuesImported(configValuesImported: ConfigValueImported[]): ConfigValues;

package/dist/esm/shared/page-configs/serialize/parseConfigValuesImported.js

@@ -0,0 +1,50 @@
+export { parseConfigValuesImported };
+import { assert, assertUsage } from '../../utils.js';
+import { assertExportsOfValueFile } from '../assertExports.js';
+import pc from '@brillout/picocolors';
+function parseConfigValuesImported(configValuesImported) {
+    const configValues = {};
+    const addConfigValue = (configName, value, importPath, exportName) => {
+        configValues[configName] = {
+            value,
+            definedAt: {
+                file: {
+                    // importPath cannot be relative to the current file, since the current file is a virtual file
+                    filePathToShowToUser: importPath,
+                    fileExportPath: [configName, 'default'].includes(exportName)
+                        ? []
+                        : // Side-effect config
+                            [exportName]
+                }
+            }
+        };
+        assertIsNotNull(value, configName, importPath);
+    };
+    configValuesImported.forEach((configValueLoaded) => {
+        if (configValueLoaded.isValueFile) {
+            const { exportValues, importPath, configName } = configValueLoaded;
+            if (configName !== 'client') {
+                assertExportsOfValueFile(exportValues, importPath, configName);
+            }
+            Object.entries(exportValues).forEach(([exportName, exportValue]) => {
+                const isSideExport = exportName !== 'default'; // .md files may have "side-exports" such as `export { frontmatter }`
+                const configName = isSideExport ? exportName : configValueLoaded.configName;
+                if (isSideExport && configName in configValues) {
+                    // We can't avoid side-export conflicts upstream. (Because we cannot know about side-exports upstream at build-time.)
+                    // Side-exports have the lowest priority.
+                    return;
+                }
+                addConfigValue(configName, exportValue, importPath, exportName);
+            });
+        }
+        else {
+            const { configName, importPath, exportValue, exportName } = configValueLoaded;
+            addConfigValue(configName, exportValue, importPath, exportName);
+        }
+    });
+    return configValues;
+}
+function assertIsNotNull(configValue, configName, importPath) {
+    assert(!importPath.includes('+config.'));
+    assertUsage(configValue !== null, `Set ${pc.cyan(configName)} to ${pc.cyan('null')} in a +config.h.js file instead of ${importPath}`);
+}

package/dist/esm/shared/page-configs/serialize/parsePageConfigs.d.ts

@@ -0,0 +1,7 @@
+export { parsePageConfigs };
+import type { PageConfigRuntime, PageConfigGlobalRuntime } from '../PageConfig.js';
+import type { PageConfigGlobalRuntimeSerialized, PageConfigRuntimeSerialized } from './PageConfigSerialized.js';
+declare function parsePageConfigs(pageConfigsSerialized: PageConfigRuntimeSerialized[], pageConfigGlobalSerialized: PageConfigGlobalRuntimeSerialized): {
+    pageConfigs: PageConfigRuntime[];
+    pageConfigGlobal: PageConfigGlobalRuntime;
+};

package/dist/esm/shared/page-configs/serialize/parsePageConfigs.js

@@ -0,0 +1,62 @@
+export { parsePageConfigs };
+import { parse } from '@brillout/json-serializer/parse';
+import { parseConfigValuesImported } from './parseConfigValuesImported.js';
+import { assert, assertUsage, isCallable } from '../../utils.js';
+import { getConfigDefinedAtString } from '../utils.js';
+function parsePageConfigs(pageConfigsSerialized, pageConfigGlobalSerialized) {
+    const pageConfigs = pageConfigsSerialized.map((pageConfigSerialized) => {
+        const configValues = {};
+        {
+            const { configValuesSerialized } = pageConfigSerialized;
+            Object.entries(configValuesSerialized).forEach(([configName, configValueSeriliazed]) => {
+                {
+                    const { valueSerialized, definedAt } = configValueSeriliazed;
+                    assert(valueSerialized);
+                    assert(!configValues[configName]);
+                    configValues[configName] = {
+                        value: parse(valueSerialized),
+                        definedAt
+                    };
+                }
+            });
+        }
+        {
+            const { configValuesImported } = pageConfigSerialized;
+            const configValuesAddendum = parseConfigValuesImported(configValuesImported);
+            Object.assign(configValues, configValuesAddendum);
+        }
+        const { pageId, isErrorPage, routeFilesystem, loadConfigValuesAll } = pageConfigSerialized;
+        assertRouteConfigValue(configValues);
+        return {
+            pageId,
+            isErrorPage,
+            routeFilesystem,
+            configValues,
+            loadConfigValuesAll
+        };
+    });
+    const pageConfigGlobal = { configValues: {} };
+    {
+        const configValuesAddendum = parseConfigValuesImported(pageConfigGlobalSerialized.configValuesImported);
+        Object.assign(pageConfigGlobal.configValues, configValuesAddendum);
+    }
+    return { pageConfigs, pageConfigGlobal };
+}
+function assertRouteConfigValue(configValues) {
+    const configName = 'route';
+    const configValue = configValues[configName];
+    if (!configValue)
+        return;
+    const { value } = configValue;
+    const configValueType = typeof value;
+    const configDefinedAt = getConfigDefinedAtString(configName, configValue, true);
+    assertUsage(configValueType === 'string' || isCallable(value), `${configDefinedAt} has an invalid type '${configValueType}': it should be a string or a function instead, see https://vike.dev/route`);
+    /* We don't use assertRouteString() in order to avoid unnecessarily bloating the client-side bundle when using Server Routing:
+    * - When using Server Routing, this file is loaded => loading assertRouteString() would bloat the client bundle.
+    * - assertRouteString() is already called on the server-side
+    * - When using Server Routing, client-side validation is superfluous as Route Strings only need to be validated on the server-side
+   if (typeof configValue === 'string') {
+     assertRouteString(configValue, `${configElement.configDefinedAt} defines an`)
+   }
+   */
+}

package/dist/esm/shared/page-configs/serialize/serializeConfigValue.d.ts

@@ -0,0 +1,8 @@
+export { serializeConfigValue };
+export { serializeConfigValueImported };
+import { ConfigValueSource } from '../PageConfig.js';
+import { ConfigValueSerialized } from './PageConfigSerialized.js';
+declare function serializeConfigValue(lines: string[], configName: string, configValueSerialized: ConfigValueSerialized): void;
+declare function serializeConfigValueImported(configValueSource: ConfigValueSource, configName: string, whitespace: string, varCounterContainer: {
+    varCounter: number;
+}, importStatements: string[]): string[];

package/dist/esm/shared/page-configs/serialize/serializeConfigValue.js

@@ -0,0 +1,52 @@
+export { serializeConfigValue };
+export { serializeConfigValueImported };
+// This file is never loaded on the client-side but we save it under the vike/shared/ directory in order to collocate it with:
+//   - vike/shared/page-configs/serialize/parsePageConfigs.ts
+//   - vike/shared/page-configs/serialize/parseConfigValuesImported.ts
+// Both parsePageConfigs() parseConfigValuesImported() and are loaded on the client-side and server-side
+import { assertIsNotProductionRuntime } from '../../../utils/assertIsNotProductionRuntime.js';
+assertIsNotProductionRuntime();
+import path from 'path';
+import { assert, assertPosixPath } from '../../utils.js';
+import { generateEagerImport } from '../../../node/plugin/plugins/importUserCode/generateEagerImport.js';
+function serializeConfigValue(lines, configName, configValueSerialized) {
+    let whitespace = '      ';
+    lines.push(`${whitespace}['${configName}']: {`);
+    whitespace += '  ';
+    Object.entries(configValueSerialized).forEach(([key, val]) => {
+        const valSerialized = key === 'definedAt' ? JSON.stringify(val) : val;
+        lines.push(`${whitespace}  ${key}: ${valSerialized},`);
+    });
+    whitespace = whitespace.slice(2);
+    lines.push(`${whitespace}},`);
+}
+function serializeConfigValueImported(configValueSource, configName, whitespace, varCounterContainer, importStatements) {
+    assert(!configValueSource.valueIsFilePath);
+    assert(whitespace.replaceAll(' ', '').length === 0);
+    const { valueIsImportedAtRuntime, definedAtInfo } = configValueSource;
+    assert(valueIsImportedAtRuntime);
+    const { filePathRelativeToUserRootDir, importPathAbsolute, exportName } = definedAtInfo;
+    const importPath = filePathRelativeToUserRootDir ?? importPathAbsolute;
+    assertPosixPath(importPath);
+    const fileName = path.posix.basename(importPath);
+    const isValueFile = fileName.startsWith('+');
+    if (isValueFile)
+        assert(exportName === undefined);
+    const { importName, importStatement } = generateEagerImport(importPath, varCounterContainer.varCounter++, exportName);
+    importStatements.push(importStatement);
+    const lines = [];
+    lines.push(`  {`);
+    lines.push(`    configName: '${configName}',`);
+    lines.push(`    importPath: '${importPath}',`);
+    lines.push(`    isValueFile: ${JSON.stringify(isValueFile)},`);
+    if (isValueFile) {
+        lines.push(`    exportValues: ${importName},`);
+    }
+    else {
+        lines.push(`    exportValue: ${importName},`);
+        assert(exportName);
+        lines.push(`    exportName: ${JSON.stringify(exportName)},`);
+    }
+    lines.push(`  },`);
+    return lines;
+}

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

@@ -1,28 +1,35 @@
 export { getConfigValue };
 export { getPageConfig };
 export { getConfigDefinedAtString };
-export { getConfigDefinedAtInfo };
 export { getDefinedAtString };
-import type { DefinedAtInfo, PageConfig, PageConfigCommon } from './PageConfig.js';
+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 | {
+declare function getConfigValue(pageConfig: PageConfigCommon, configName: ConfigName, type: 'string'): null | ConfigValue & {
     value: string;
 };
-declare function getConfigValue(pageConfig: PageConfigCommon, configName: ConfigName, type: 'boolean'): null | {
+declare function getConfigValue(pageConfig: PageConfigCommon, configName: ConfigName, type: 'boolean'): null | ConfigValue & {
     value: boolean;
 };
-declare function getConfigValue(pageConfig: PageConfigCommon, configName: ConfigName): null | {
+declare function getConfigValue(pageConfig: PageConfigCommon, configName: ConfigName): null | ConfigValue & {
     value: unknown;
 };
-declare function getConfigDefinedAtInfo(pageConfig: PageConfigCommon, configName: ConfigName): DefinedAtInfo;
-declare function getPageConfig(pageId: string, pageConfigs: PageConfig[]): PageConfig;
-type ConfigDefinedAtUppercase<ConfigName extends string> = `Config ${ConfigName}${string}`;
-type ConfigDefinedAtLowercase<ConfigName extends string> = `config ${ConfigName}${string}`;
-declare function getConfigDefinedAtString<ConfigName extends string>(configName: ConfigName, { definedAtInfo }: {
-    definedAtInfo: null | DefinedAtInfo;
+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, append?: 'effect'): ConfigDefinedAtUppercase<ConfigName>;
-declare function getConfigDefinedAtString<ConfigName extends string>(configName: ConfigName, { definedAtInfo }: {
-    definedAtInfo: null | DefinedAtInfo;
+declare function getConfigDefinedAtString<ConfigName extends string>(configName: ConfigName, { definedAt }: {
+    definedAt: DefinedAt;
 }, sentenceBegin: false, append?: 'effect'): ConfigDefinedAtLowercase<ConfigName>;
-declare function getDefinedAtString(definedAtInfo: DefinedAtInfo, append?: 'effect'): string;
+declare function getDefinedAtString(configValue: ConfigValue, configName: string): string;
+declare function getConfigValueFilePathToShowToUser({ definedAt }: {
+    definedAt: DefinedAt;
+}): null | string;
+declare function getHookFilePathToShowToUser({ definedAt }: {
+    definedAt: DefinedAt;
+}): string;