vike 0.4.230-commit-eea72b2 → 0.4.230-commit-f07cc20

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

@@ -54,7 +54,11 @@ function assertExtensionsRequire(plusFiles) {
         Object.entries(require).forEach(([reqName, req]) => {
             const errBase = `${picocolors_1.default.bold(name)} requires ${picocolors_1.default.bold(reqName)}`;
             if (reqName === 'vike') {
-                (0, utils_js_1.assertUsage)(isVersionRange(utils_js_1.PROJECT_VERSION, req.version), `${errBase} version ${picocolors_1.default.bold(req.version)}, but ${picocolors_1.default.bold(utils_js_1.PROJECT_VERSION)} is installed.`);
+                let errMsg = `${errBase} version ${picocolors_1.default.bold(req.version)}, but ${picocolors_1.default.bold(utils_js_1.PROJECT_VERSION)} is installed.`;
+                if (req.optional) {
+                    errMsg += " Either update it, or remove it (it's an optional peer dependency).";
+                }
+                (0, utils_js_1.assertUsage)(isVersionRange(utils_js_1.PROJECT_VERSION, req.version), errMsg);
                 return;
             }
             const extensionVersion = extensions[reqName];

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

@@ -708,6 +708,8 @@ function getConfigDefinitions(plusFilesRelevant, filter) {
         assertMetaUsage(meta, `Config ${picocolors_1.default.cyan('meta')} defined at ${plusFile.filePath.filePathToShowToUser}`);
         // Set configDef._userEffectDefinedAtFilePath
         Object.entries(meta).forEach(([configName, configDef]) => {
+            if ('isDefinedByPeerDependency' in configDef)
+                return;
             if (!configDef.effect)
                 return;
             (0, utils_js_1.assert)(plusFile.isConfigFile);
@@ -717,6 +719,12 @@ function getConfigDefinitions(plusFilesRelevant, filter) {
             };
         });
         (0, utils_js_1.objectEntries)(meta).forEach(([configName, configDefinitionUserLand]) => {
+            if ('isDefinedByPeerDependency' in configDefinitionUserLand) {
+                configDefinitionUserLand = {
+                    env: { client: false, server: false, config: false },
+                    ...configDefinitionUserLand
+                };
+            }
             // User can override an existing config definition
             configDefinitions[configName] = {
                 ...configDefinitions[configName],
@@ -739,6 +747,8 @@ function assertMetaUsage(metaVal, metaConfigDefinedAt) {
             (0, utils_js_1.assert)(metaConfigDefinedAt); // We expect internal effects to return a valid meta value
             (0, utils_js_1.assertUsage)(false, `${metaConfigDefinedAt} sets ${picocolors_1.default.cyan(`meta.${configName}`)} to a value with an invalid type ${picocolors_1.default.cyan(typeof def)}: it should be an object instead.`);
         }
+        if (def.isDefinedByPeerDependency)
+            return;
         // env
         let configEnv;
         {
@@ -849,6 +859,7 @@ function applyEffectMetaEnv(configModFromEffect, configValueSources, configDefEf
         }
         assertMetaUsage(configValue, configDefinedAt);
         (0, utils_js_1.objectEntries)(configValue).forEach(([configTargetName, configTargetDef]) => {
+            (0, utils_js_1.assert)(!('isDefinedByPeerDependency' in configTargetDef));
             {
                 const keys = Object.keys(configTargetDef);
                 (0, utils_js_1.assertUsage)(keys.includes('env'), notSupported);

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.230-commit-eea72b2';
+exports.PROJECT_VERSION = '0.4.230-commit-f07cc20';

package/dist/esm/node/plugin/plugins/importUserCode/v1-design/getVikeConfig/assertExtensions.js

@@ -49,7 +49,11 @@ function assertExtensionsRequire(plusFiles) {
         Object.entries(require).forEach(([reqName, req]) => {
             const errBase = `${pc.bold(name)} requires ${pc.bold(reqName)}`;
             if (reqName === 'vike') {
-                assertUsage(isVersionRange(PROJECT_VERSION, req.version), `${errBase} version ${pc.bold(req.version)}, but ${pc.bold(PROJECT_VERSION)} is installed.`);
+                let errMsg = `${errBase} version ${pc.bold(req.version)}, but ${pc.bold(PROJECT_VERSION)} is installed.`;
+                if (req.optional) {
+                    errMsg += " Either update it, or remove it (it's an optional peer dependency).";
+                }
+                assertUsage(isVersionRange(PROJECT_VERSION, req.version), errMsg);
                 return;
             }
             const extensionVersion = extensions[reqName];

package/dist/esm/node/plugin/plugins/importUserCode/v1-design/getVikeConfig/configDefinitionsBuiltIn.d.ts

@@ -1,6 +1,7 @@
 export { configDefinitionsBuiltIn };
 export type { ConfigDefinition };
 export type { ConfigDefinitions };
+export type { ConfigDefinitionsInternal };
 export type { ConfigDefinitionInternal };
 export type { ConfigEffect };
 import type { ConfigEnvInternal, ConfigEnv, ConfigValueSources, DefinedAtFilePath } from '../../../../../../shared/page-configs/PageConfig.js';
@@ -10,7 +11,8 @@ import { type ConfigDefinedAt } from '../../../../../../shared/page-configs/getC
  *
  * https://vike.dev/meta
  */
-type ConfigDefinition = {
+type ConfigDefinition = ConfigDefinition_ | ConfigDefinitionDefinedByPeerDependency;
+type ConfigDefinition_ = {
     /** In what environment(s) the config value is loaded.
      *
      * https://vike.dev/meta
@@ -49,6 +51,12 @@ type ConfigDefinition = {
     }) => boolean);
     type?: string | string[];
 };
+type ConfigDefinitionDefinedByPeerDependency = {
+    /**
+     * Omit the "unknown config" error without defining the config — useful for optional peer dependencies: for example, vike-server sets +stream.require which is defined by vike-{react,vue,solid} but some users don't use vike-{react,vue,solid}
+     */
+    isDefinedByPeerDependency: true;
+};
 /**
  * Function called when the config value is defined.
  *
@@ -67,13 +75,15 @@ type ConfigEffect = (config: {
     configDefinedAt: ConfigDefinedAt;
 }) => Config | undefined;
 /** For Vike internal use */
-type ConfigDefinitionInternal = Omit<ConfigDefinition, 'env'> & {
+type ConfigDefinitionInternal = Omit<ConfigDefinition_, 'env'> & {
     _computed?: (configValueSources: ConfigValueSources) => unknown;
     _valueIsFilePath?: true;
     _userEffectDefinedAtFilePath?: DefinedAtFilePath;
     env: ConfigEnvInternal;
 };
 type ConfigDefinitions = Record<string, // configName
+ConfigDefinition>;
+type ConfigDefinitionsInternal = Record<string, // configName
 ConfigDefinitionInternal>;
 type ConfigDefinitionsBuiltIn = Record<ConfigNameBuiltIn | ConfigNameGlobal, ConfigDefinitionInternal>;
 declare const configDefinitionsBuiltIn: ConfigDefinitionsBuiltIn;

package/dist/esm/node/plugin/plugins/importUserCode/v1-design/getVikeConfig/loadFileAtConfigTime.d.ts

@@ -7,20 +7,20 @@ import type { FilePathResolved } from '../../../../../../shared/page-configs/Fil
 import { type EsbuildCache } from './transpileAndExecuteFile.js';
 import type { PlusFileValue } from './getPlusFilesAll.js';
 import { PointerImport } from './resolvePointerImport.js';
-import type { ConfigDefinitions } from './configDefinitionsBuiltIn.js';
+import type { ConfigDefinitionsInternal } from './configDefinitionsBuiltIn.js';
 type ConfigFile = {
     fileExports: Record<string, unknown>;
     filePath: FilePathResolved;
     extendsFilePaths: string[];
 };
-declare function loadPointerImport(pointerImport: PointerImportLoaded, userRootDir: string, configName: string, configDefinitions: ConfigDefinitions, esbuildCache: EsbuildCache): Promise<unknown>;
+declare function loadPointerImport(pointerImport: PointerImportLoaded, userRootDir: string, configName: string, configDefinitions: ConfigDefinitionsInternal, esbuildCache: EsbuildCache): Promise<unknown>;
 type PointerImportLoaded = PointerImport & ({
     fileExportValueLoaded: true;
     fileExportValue: unknown;
 } | {
     fileExportValueLoaded: false;
 });
-declare function loadValueFile(interfaceValueFile: PlusFileValue, configDefinitions: ConfigDefinitions, userRootDir: string, esbuildCache: EsbuildCache): Promise<void>;
+declare function loadValueFile(interfaceValueFile: PlusFileValue, configDefinitions: ConfigDefinitionsInternal, userRootDir: string, esbuildCache: EsbuildCache): Promise<void>;
 declare function loadConfigFile(configFilePath: FilePathResolved, userRootDir: string, visited: string[], isExtensionConfig: boolean, esbuildCache: EsbuildCache): Promise<{
     configFile: ConfigFile;
     extendsConfigs: ConfigFile[];

package/dist/esm/node/plugin/plugins/importUserCode/v1-design/getVikeConfig.d.ts

@@ -9,7 +9,7 @@ export { getVikeConfigFromCliOrEnv };
 export { isOverriden };
 export type { VikeConfigObject };
 import type { PageConfigGlobalBuildTime, ConfigValueSource, PageConfigBuildTime } from '../../../../../shared/page-configs/PageConfig.js';
-import { type ConfigDefinitions, type ConfigDefinitionInternal } from './getVikeConfig/configDefinitionsBuiltIn.js';
+import { type ConfigDefinitionsInternal, type ConfigDefinitionInternal } from './getVikeConfig/configDefinitionsBuiltIn.js';
 import type { ResolvedConfig, UserConfig } from 'vite';
 import { type PageConfigUserFriendly, type PageConfigsUserFriendly } from '../../../../../shared/page-configs/getUserFriendlyConfigs.js';
 import { type PlusFile } from './getVikeConfig/getPlusFilesAll.js';
@@ -34,7 +34,7 @@ declare function getVikeConfigFromCliOrEnv(): {
     configFromCliOptions: import("../../../../cli/parseCli.js").CliOptions | null;
     configFromEnvVar: Record<string, unknown> | null;
 };
-declare function getConfigDefinitionOptional(configDefinitions: ConfigDefinitions, configName: string): ConfigDefinitionInternal | null;
+declare function getConfigDefinitionOptional(configDefinitions: ConfigDefinitionsInternal, configName: string): ConfigDefinitionInternal | null;
 declare function getConfVal(plusFile: PlusFile, configName: string): null | {
     value: unknown;
     valueIsLoaded: true;

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

@@ -703,6 +703,8 @@ function getConfigDefinitions(plusFilesRelevant, filter) {
         assertMetaUsage(meta, `Config ${pc.cyan('meta')} defined at ${plusFile.filePath.filePathToShowToUser}`);
         // Set configDef._userEffectDefinedAtFilePath
         Object.entries(meta).forEach(([configName, configDef]) => {
+            if ('isDefinedByPeerDependency' in configDef)
+                return;
             if (!configDef.effect)
                 return;
             assert(plusFile.isConfigFile);
@@ -712,6 +714,12 @@ function getConfigDefinitions(plusFilesRelevant, filter) {
             };
         });
         objectEntries(meta).forEach(([configName, configDefinitionUserLand]) => {
+            if ('isDefinedByPeerDependency' in configDefinitionUserLand) {
+                configDefinitionUserLand = {
+                    env: { client: false, server: false, config: false },
+                    ...configDefinitionUserLand
+                };
+            }
             // User can override an existing config definition
             configDefinitions[configName] = {
                 ...configDefinitions[configName],
@@ -734,6 +742,8 @@ function assertMetaUsage(metaVal, metaConfigDefinedAt) {
             assert(metaConfigDefinedAt); // We expect internal effects to return a valid meta value
             assertUsage(false, `${metaConfigDefinedAt} sets ${pc.cyan(`meta.${configName}`)} to a value with an invalid type ${pc.cyan(typeof def)}: it should be an object instead.`);
         }
+        if (def.isDefinedByPeerDependency)
+            return;
         // env
         let configEnv;
         {
@@ -844,6 +854,7 @@ function applyEffectMetaEnv(configModFromEffect, configValueSources, configDefEf
         }
         assertMetaUsage(configValue, configDefinedAt);
         objectEntries(configValue).forEach(([configTargetName, configTargetDef]) => {
+            assert(!('isDefinedByPeerDependency' in configTargetDef));
             {
                 const keys = Object.keys(configTargetDef);
                 assertUsage(keys.includes('env'), notSupported);

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

@@ -23,7 +23,7 @@ export type { DefinedAtFilePath };
 import type { ConfigValueSerialized } from './serialize/PageConfigSerialized.js';
 import type { LocationId } from '../../node/plugin/plugins/importUserCode/v1-design/getVikeConfig/filesystemRouting.js';
 import type { FilePath } from './FilePath.js';
-import type { ConfigDefinitions } from '../../node/plugin/plugins/importUserCode/v1-design/getVikeConfig/configDefinitionsBuiltIn.js';
+import type { ConfigDefinitionsInternal } from '../../node/plugin/plugins/importUserCode/v1-design/getVikeConfig/configDefinitionsBuiltIn.js';
 import type { PlusFile } from '../../node/plugin/plugins/importUserCode/v1-design/getVikeConfig/getPlusFilesAll.js';
 import type { Operation } from '../../node/api/types.js';
 type PageConfigCommon = {
@@ -51,7 +51,7 @@ type PageConfigGlobalRuntime = {
 };
 /** Page config, build-time data structure */
 type PageConfigBuildTime = PageConfigCommon & {
-    configDefinitions: ConfigDefinitions;
+    configDefinitions: ConfigDefinitionsInternal;
     plusFiles: PlusFile[];
     configValueSources: ConfigValueSources;
     configValuesComputed: ConfigValuesComputed;
@@ -59,7 +59,7 @@ type PageConfigBuildTime = PageConfigCommon & {
 /** Global config that applies to all pages, build-time data structure */
 type PageConfigGlobalBuildTime = {
     configValueSources: ConfigValueSources;
-    configDefinitions: ConfigDefinitions;
+    configDefinitions: ConfigDefinitionsInternal;
     configValuesComputed?: undefined;
 };
 /** Same as PageConfigRuntime but also contains all lazily loaded config values such as config.Page */

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

@@ -1 +1 @@
-export declare const PROJECT_VERSION: "0.4.230-commit-eea72b2";
+export declare const PROJECT_VERSION: "0.4.230-commit-f07cc20";

package/dist/esm/utils/PROJECT_VERSION.js

@@ -1,2 +1,2 @@
 // Automatically updated by @brillout/release-me
-export const PROJECT_VERSION = '0.4.230-commit-eea72b2';
+export const PROJECT_VERSION = '0.4.230-commit-f07cc20';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vike",
-  "version": "0.4.230-commit-eea72b2",
+  "version": "0.4.230-commit-f07cc20",
   "repository": "https://github.com/vikejs/vike",
   "exports": {
     "./server": {