vike 0.4.160 → 0.4.161

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (121) hide show
  1. package/dist/cjs/node/cli/bin.js +5 -0
  2. package/dist/cjs/node/client/router.js +4 -2
  3. package/dist/cjs/node/plugin/plugins/autoFullBuild.js +2 -2
  4. package/dist/cjs/node/plugin/plugins/buildConfig/fixServerAssets.js +148 -0
  5. package/dist/cjs/node/plugin/plugins/buildConfig.js +42 -15
  6. package/dist/cjs/node/plugin/plugins/commonConfig.js +5 -13
  7. package/dist/cjs/node/plugin/plugins/config/stemUtils.js +1 -1
  8. package/dist/cjs/node/plugin/plugins/distFileNames.js +9 -1
  9. package/dist/cjs/node/plugin/plugins/extractAssetsPlugin.js +7 -2
  10. package/dist/cjs/node/plugin/plugins/importBuild/index.js +4 -7
  11. package/dist/cjs/node/plugin/plugins/importUserCode/v1-design/getVikeConfig/crawlPlusFiles.js +1 -5
  12. package/dist/cjs/node/plugin/plugins/importUserCode/v1-design/getVikeConfig/filesystemRouting.js +28 -46
  13. package/dist/cjs/node/plugin/plugins/importUserCode/v1-design/getVikeConfig/{loadFileConfigEnv.js → loadFileAtConfigTime.js} +5 -5
  14. package/dist/cjs/node/plugin/plugins/importUserCode/v1-design/getVikeConfig/resolveFilePath.js +33 -0
  15. package/dist/cjs/node/plugin/plugins/importUserCode/v1-design/getVikeConfig/resolveImportPath.js +2 -2
  16. package/dist/cjs/node/plugin/plugins/importUserCode/v1-design/getVikeConfig/{transformImports.js → transformFileImports.js} +7 -7
  17. package/dist/cjs/node/plugin/plugins/importUserCode/v1-design/getVikeConfig/transpileAndExecuteFile.js +21 -27
  18. package/dist/cjs/node/plugin/plugins/importUserCode/v1-design/getVikeConfig.js +155 -111
  19. package/dist/cjs/node/plugin/plugins/importUserCode/v1-design/getVirtualFilePageConfigValuesAll.js +2 -1
  20. package/dist/cjs/node/plugin/utils.js +3 -2
  21. package/dist/cjs/node/prerender/runPrerender.js +12 -5
  22. package/dist/cjs/node/runtime/globalContext.js +7 -4
  23. package/dist/cjs/node/runtime/html/injectAssets/getHtmlTags.js +2 -2
  24. package/dist/cjs/node/runtime/html/renderHtml.js +1 -1
  25. package/dist/cjs/node/runtime/html/stream.js +2 -2
  26. package/dist/cjs/node/runtime/renderPage/executeOnRenderHtmlHook.js +2 -2
  27. package/dist/cjs/node/runtime/renderPage/getHttpResponseBody.js +39 -39
  28. package/dist/cjs/node/runtime/renderPage/loadUserFilesServerSide.js +1 -1
  29. package/dist/cjs/node/runtime/renderPage/{logHintForCjsEsmError.js → logErrorHint.js} +81 -43
  30. package/dist/cjs/node/runtime/renderPage/loggerProd.js +3 -3
  31. package/dist/cjs/node/runtime/utils.js +1 -1
  32. package/dist/cjs/shared/page-configs/serialize/parseConfigValuesImported.js +53 -26
  33. package/dist/cjs/shared/route/executeGuardHook.js +3 -2
  34. package/dist/cjs/shared/utils.js +0 -1
  35. package/dist/cjs/utils/assertNodeVersion.js +2 -2
  36. package/dist/cjs/utils/{findUserPackageJsonPath.js → findFile.js} +11 -8
  37. package/dist/cjs/utils/isVersionOrAbove.js +29 -0
  38. package/dist/cjs/utils/nodeEnv.js +23 -1
  39. package/dist/cjs/utils/objectKeys.js +19 -3
  40. package/dist/cjs/utils/projectInfo.js +1 -1
  41. package/dist/cjs/utils/sorter.js +62 -1
  42. package/dist/esm/client/client-routing-runtime/index.d.ts +1 -1
  43. package/dist/esm/client/client-routing-runtime/index.js +1 -1
  44. package/dist/esm/node/cli/bin.js +3 -1
  45. package/dist/esm/node/client/router.d.ts +2 -0
  46. package/dist/esm/node/client/router.js +3 -1
  47. package/dist/esm/node/plugin/plugins/autoFullBuild.js +2 -2
  48. package/dist/esm/node/plugin/plugins/buildConfig/fixServerAssets.d.ts +13 -0
  49. package/dist/esm/node/plugin/plugins/buildConfig/fixServerAssets.js +142 -0
  50. package/dist/esm/node/plugin/plugins/buildConfig.d.ts +2 -0
  51. package/dist/esm/node/plugin/plugins/buildConfig.js +43 -16
  52. package/dist/esm/node/plugin/plugins/commonConfig.js +6 -14
  53. package/dist/esm/node/plugin/plugins/config/stemUtils.js +2 -2
  54. package/dist/esm/node/plugin/plugins/distFileNames.js +9 -1
  55. package/dist/esm/node/plugin/plugins/extractAssetsPlugin.js +8 -3
  56. package/dist/esm/node/plugin/plugins/importBuild/index.d.ts +6 -1
  57. package/dist/esm/node/plugin/plugins/importBuild/index.js +4 -7
  58. package/dist/esm/node/plugin/plugins/importUserCode/v1-design/getVikeConfig/configDefinitionsBuiltIn.d.ts +2 -0
  59. package/dist/esm/node/plugin/plugins/importUserCode/v1-design/getVikeConfig/crawlPlusFiles.d.ts +0 -1
  60. package/dist/esm/node/plugin/plugins/importUserCode/v1-design/getVikeConfig/crawlPlusFiles.js +1 -5
  61. package/dist/esm/node/plugin/plugins/importUserCode/v1-design/getVikeConfig/filesystemRouting.d.ts +39 -12
  62. package/dist/esm/node/plugin/plugins/importUserCode/v1-design/getVikeConfig/filesystemRouting.js +29 -47
  63. package/dist/esm/node/plugin/plugins/importUserCode/v1-design/getVikeConfig/{loadFileConfigEnv.js → loadFileAtConfigTime.js} +4 -4
  64. package/dist/esm/node/plugin/plugins/importUserCode/v1-design/getVikeConfig/resolveFilePath.d.ts +5 -0
  65. package/dist/esm/node/plugin/plugins/importUserCode/v1-design/getVikeConfig/resolveFilePath.js +27 -0
  66. package/dist/esm/node/plugin/plugins/importUserCode/v1-design/getVikeConfig/resolveImportPath.d.ts +1 -1
  67. package/dist/esm/node/plugin/plugins/importUserCode/v1-design/getVikeConfig/resolveImportPath.js +1 -1
  68. package/dist/esm/node/plugin/plugins/importUserCode/v1-design/getVikeConfig/{transformImports.d.ts → transformFileImports.d.ts} +2 -2
  69. package/dist/esm/node/plugin/plugins/importUserCode/v1-design/getVikeConfig/{transformImports.js → transformFileImports.js} +6 -6
  70. package/dist/esm/node/plugin/plugins/importUserCode/v1-design/getVikeConfig/transpileAndExecuteFile.d.ts +1 -1
  71. package/dist/esm/node/plugin/plugins/importUserCode/v1-design/getVikeConfig/transpileAndExecuteFile.js +20 -26
  72. package/dist/esm/node/plugin/plugins/importUserCode/v1-design/getVikeConfig.d.ts +4 -0
  73. package/dist/esm/node/plugin/plugins/importUserCode/v1-design/getVikeConfig.js +153 -109
  74. package/dist/esm/node/plugin/plugins/importUserCode/v1-design/getVirtualFilePageConfigValuesAll.js +2 -1
  75. package/dist/esm/node/plugin/utils.d.ts +3 -2
  76. package/dist/esm/node/plugin/utils.js +3 -2
  77. package/dist/esm/node/prerender/runPrerender.js +13 -6
  78. package/dist/esm/node/runtime/globalContext.js +8 -5
  79. package/dist/esm/node/runtime/html/injectAssets/getHtmlTags.js +2 -2
  80. package/dist/esm/node/runtime/html/renderHtml.js +1 -1
  81. package/dist/esm/node/runtime/html/stream.js +2 -2
  82. package/dist/esm/node/runtime/renderPage/executeOnRenderHtmlHook.js +2 -2
  83. package/dist/esm/node/runtime/renderPage/getHttpResponseBody.d.ts +6 -5
  84. package/dist/esm/node/runtime/renderPage/getHttpResponseBody.js +39 -39
  85. package/dist/esm/node/runtime/renderPage/loadUserFilesServerSide.js +1 -1
  86. package/dist/esm/node/runtime/renderPage/logErrorHint.d.ts +8 -0
  87. package/dist/esm/node/runtime/renderPage/{logHintForCjsEsmError.js → logErrorHint.js} +80 -42
  88. package/dist/esm/node/runtime/renderPage/loggerProd.js +3 -3
  89. package/dist/esm/node/runtime/utils.d.ts +1 -1
  90. package/dist/esm/node/runtime/utils.js +1 -1
  91. package/dist/esm/shared/page-configs/Config.d.ts +1 -1
  92. package/dist/esm/shared/page-configs/PageConfig.d.ts +2 -0
  93. package/dist/esm/shared/page-configs/serialize/parseConfigValuesImported.js +53 -26
  94. package/dist/esm/shared/route/executeGuardHook.js +3 -2
  95. package/dist/esm/shared/utils.d.ts +0 -1
  96. package/dist/esm/shared/utils.js +0 -1
  97. package/dist/esm/utils/assertNodeVersion.js +2 -2
  98. package/dist/esm/utils/findFile.d.ts +3 -0
  99. package/dist/esm/utils/findFile.js +21 -0
  100. package/dist/esm/utils/getOutDirs.d.ts +1 -0
  101. package/dist/esm/utils/isVersionOrAbove.d.ts +2 -0
  102. package/dist/esm/utils/isVersionOrAbove.js +26 -0
  103. package/dist/esm/utils/nodeEnv.d.ts +4 -0
  104. package/dist/esm/utils/nodeEnv.js +19 -0
  105. package/dist/esm/utils/objectKeys.d.ts +10 -1
  106. package/dist/esm/utils/objectKeys.js +20 -3
  107. package/dist/esm/utils/projectInfo.d.ts +2 -2
  108. package/dist/esm/utils/projectInfo.js +1 -1
  109. package/dist/esm/utils/sorter.d.ts +59 -0
  110. package/dist/esm/utils/sorter.js +61 -0
  111. package/package.json +1 -1
  112. package/dist/cjs/utils/objectEntries.js +0 -8
  113. package/dist/esm/node/runtime/renderPage/logHintForCjsEsmError.d.ts +0 -13
  114. package/dist/esm/utils/findUserPackageJsonPath.d.ts +0 -2
  115. package/dist/esm/utils/findUserPackageJsonPath.js +0 -18
  116. package/dist/esm/utils/objectEntries.d.ts +0 -4
  117. package/dist/esm/utils/objectEntries.js +0 -5
  118. /package/dist/cjs/node/runtime/renderPage/{logHintForCjsEsmError → logErrorHint}/errors.js +0 -0
  119. /package/dist/esm/node/plugin/plugins/importUserCode/v1-design/getVikeConfig/{loadFileConfigEnv.d.ts → loadFileAtConfigTime.d.ts} +0 -0
  120. /package/dist/esm/node/runtime/renderPage/{logHintForCjsEsmError → logErrorHint}/errors.d.ts +0 -0
  121. /package/dist/esm/node/runtime/renderPage/{logHintForCjsEsmError → logErrorHint}/errors.js +0 -0
@@ -119,11 +119,11 @@ function processHookReturnValue(hookReturnValue, renderHook) {
119
119
  const val = hookReturnValue.pageContext;
120
120
  const errBegin = `${errPrefix} returned ${pc.cyan('{ pageContext }')}, but ${pc.cyan('pageContext')}`;
121
121
  if (isPromise(val) || isCallable(val)) {
122
- assertWarning(!isPromise(val), `${errBegin} is a promise which is deprecated in favor of async functions, see https://vike.dev/stream#initial-data-after-stream-end`, { onlyOnce: true });
122
+ assertWarning(!isPromise(val), `${errBegin} is a promise which is deprecated in favor of async functions, see https://vike.dev/streaming#initial-data-after-stream-end`, { onlyOnce: true });
123
123
  pageContextPromise = val;
124
124
  }
125
125
  else {
126
- assertUsage(isObject(val), `${errBegin} should be an object or an async function, see https://vike.dev/stream#initial-data-after-stream-end`);
126
+ assertUsage(isObject(val), `${errBegin} should be an object or an async function, see https://vike.dev/streaming#initial-data-after-stream-end`);
127
127
  assertPageContextProvidedByUser(val, renderHook);
128
128
  pageContextProvidedByRenderHook = val;
129
129
  }
@@ -7,9 +7,10 @@ import { type HtmlRender } from '../html/renderHtml.js';
7
7
  import type { RenderHook } from './executeOnRenderHtmlHook.js';
8
8
  type HttpResponseBody = {
9
9
  body: string;
10
- getBody: () => Promise<string>;
11
- getReadableWebStream: () => StreamReadableWeb;
12
10
  pipe: (writable: StreamWritableWeb | StreamWritableNode) => void;
11
+ getReadableWebStream: () => StreamReadableWeb;
12
+ getReadableNodeStream: () => Promise<StreamReadableNode>;
13
+ getBody: () => Promise<string>;
13
14
  /** @deprecated */
14
15
  getNodeStream: () => Promise<StreamReadableNode>;
15
16
  /** @deprecated */
@@ -21,12 +22,12 @@ type HttpResponseBody = {
21
22
  };
22
23
  declare function getHttpResponseBody(htmlRender: HtmlRender, renderHook: null | RenderHook): string;
23
24
  declare function getHttpResponseBodyStreamHandlers(htmlRender: HtmlRender, renderHook: null | RenderHook): {
25
+ pipe(writable: StreamWritableNode | StreamWritableWeb): void;
26
+ getReadableWebStream(): StreamReadableWeb;
27
+ getReadableNodeStream(): Promise<import("stream").Readable>;
24
28
  getBody(): Promise<string>;
25
29
  getNodeStream(): Promise<import("stream").Readable>;
26
30
  getWebStream(): StreamReadableWeb;
27
- getReadableNodeStream(): Promise<import("stream").Readable>;
28
- getReadableWebStream(): StreamReadableWeb;
29
31
  pipeToWebWritable(writable: StreamWritableWeb): void;
30
32
  pipeToNodeWritable(writable: StreamWritableNode): void;
31
- pipe(writable: StreamWritableNode | StreamWritableWeb): void;
32
33
  };
@@ -4,7 +4,7 @@ import { isStream, getStreamName, inferStreamName, isStreamWritableWeb, isStream
4
4
  import { assert, assertUsage, assertWarning } from '../utils.js';
5
5
  import { getHtmlString } from '../html/renderHtml.js';
6
6
  import pc from '@brillout/picocolors';
7
- const streamDocs = 'See https://vike.dev/stream for more information.';
7
+ const streamDocs = 'See https://vike.dev/streaming for more information.';
8
8
  function getHttpResponseBody(htmlRender, renderHook) {
9
9
  if (typeof htmlRender !== 'string') {
10
10
  assertUsage(false, getErrMsg(htmlRender, renderHook, 'body', `Use ${pc.cyan('pageContext.httpResponse.pipe()')} instead`));
@@ -14,6 +14,44 @@ function getHttpResponseBody(htmlRender, renderHook) {
14
14
  }
15
15
  function getHttpResponseBodyStreamHandlers(htmlRender, renderHook) {
16
16
  return {
17
+ pipe(writable) {
18
+ const getErrMsgMixingStreamTypes = (writableType) => `The ${getErrMsgBody(htmlRender, renderHook)} while a ${writableType} was passed to pageContext.httpResponse.pipe() which is contradictory. You cannot mix a Web Stream with a Node.js Stream.`;
19
+ if (isStreamWritableWeb(writable)) {
20
+ const success = pipeToStreamWritableWeb(htmlRender, writable);
21
+ if (success) {
22
+ return;
23
+ }
24
+ else {
25
+ assert(isStreamReadableNode(htmlRender) || isStreamPipeNode(htmlRender));
26
+ assertUsage(false, getErrMsgMixingStreamTypes('Web Writable'));
27
+ }
28
+ }
29
+ if (isStreamWritableNode(writable)) {
30
+ const success = pipeToStreamWritableNode(htmlRender, writable);
31
+ if (success) {
32
+ return;
33
+ }
34
+ else {
35
+ assert(isStreamReadableWeb(htmlRender) || isStreamPipeWeb(htmlRender));
36
+ assertUsage(false, getErrMsgMixingStreamTypes('Node.js Writable'));
37
+ }
38
+ }
39
+ assertUsage(false, `The argument ${pc.cyan('writable')} passed to ${pc.cyan('pageContext.httpResponse.pipe(writable)')} doesn't seem to be ${getStreamName('writable', 'web')} nor ${getStreamName('writable', 'node')}.`);
40
+ },
41
+ getReadableWebStream() {
42
+ const webStream = getStreamReadableWeb(htmlRender);
43
+ if (webStream === null) {
44
+ assertUsage(false, getErrMsg(htmlRender, renderHook, 'getReadableWebStream()', getFixMsg('readable', 'web')));
45
+ }
46
+ return webStream;
47
+ },
48
+ async getReadableNodeStream() {
49
+ const nodeStream = await getStreamReadableNode(htmlRender);
50
+ if (nodeStream === null) {
51
+ assertUsage(false, getErrMsg(htmlRender, renderHook, 'getReadableNodeStream()', getFixMsg('readable', 'node')));
52
+ }
53
+ return nodeStream;
54
+ },
17
55
  async getBody() {
18
56
  const body = await getHtmlString(htmlRender);
19
57
  return body;
@@ -38,20 +76,6 @@ function getHttpResponseBodyStreamHandlers(htmlRender, renderHook) {
38
76
  }
39
77
  return webStream;
40
78
  },
41
- async getReadableNodeStream() {
42
- const nodeStream = await getStreamReadableNode(htmlRender);
43
- if (nodeStream === null) {
44
- assertUsage(false, getErrMsg(htmlRender, renderHook, 'getReadableNodeStream()', getFixMsg('readable', 'node')));
45
- }
46
- return nodeStream;
47
- },
48
- getReadableWebStream() {
49
- const webStream = getStreamReadableWeb(htmlRender);
50
- if (webStream === null) {
51
- assertUsage(false, getErrMsg(htmlRender, renderHook, 'getReadableWebStream()', getFixMsg('readable', 'web')));
52
- }
53
- return webStream;
54
- },
55
79
  // TODO/v1-release: remove
56
80
  pipeToWebWritable(writable) {
57
81
  assertWarning(false, '`pageContext.httpResponse.pipeToWebWritable(res)` is outdated, use `pageContext.httpResponse.pipe(res)` instead. ' +
@@ -69,30 +93,6 @@ function getHttpResponseBodyStreamHandlers(htmlRender, renderHook) {
69
93
  if (!success) {
70
94
  assertUsage(false, getErrMsg(htmlRender, renderHook, 'pipeToNodeWritable()'));
71
95
  }
72
- },
73
- pipe(writable) {
74
- const getErrMsgMixingStreamTypes = (writableType) => `The ${getErrMsgBody(htmlRender, renderHook)} while a ${writableType} was passed to pageContext.httpResponse.pipe() which is contradictory. You cannot mix a Web Stream with a Node.js Stream.`;
75
- if (isStreamWritableWeb(writable)) {
76
- const success = pipeToStreamWritableWeb(htmlRender, writable);
77
- if (success) {
78
- return;
79
- }
80
- else {
81
- assert(isStreamReadableNode(htmlRender) || isStreamPipeNode(htmlRender));
82
- assertUsage(false, getErrMsgMixingStreamTypes('Web Writable'));
83
- }
84
- }
85
- if (isStreamWritableNode(writable)) {
86
- const success = pipeToStreamWritableNode(htmlRender, writable);
87
- if (success) {
88
- return;
89
- }
90
- else {
91
- assert(isStreamReadableWeb(htmlRender) || isStreamPipeWeb(htmlRender));
92
- assertUsage(false, getErrMsgMixingStreamTypes('Node.js Writable'));
93
- }
94
- }
95
- assertUsage(false, `The argument ${pc.cyan('writable')} passed to ${pc.cyan('pageContext.httpResponse.pipe(writable)')} doesn't seem to be ${getStreamName('writable', 'web')} nor ${getStreamName('writable', 'node')}.`);
96
96
  }
97
97
  };
98
98
  function getFixMsg(type, standard) {
@@ -42,7 +42,7 @@ async function loadUserFilesServerSide(pageContext) {
42
42
  // TODO/v1-release: remove
43
43
  Object.assign(pageContextAddendum, {
44
44
  _getPageAssets: async () => {
45
- assertWarning(false, 'pageContext._getPageAssets() deprecated, see https://vike.dev/preload', {
45
+ assertWarning(false, 'pageContext._getPageAssets() deprecated, see https://vike.dev/preloading', {
46
46
  onlyOnce: true,
47
47
  showStackTrace: true
48
48
  });
@@ -0,0 +1,8 @@
1
+ export { logErrorHint };
2
+ export { isCjsEsmError };
3
+ export { isKnownError };
4
+ export { getHint };
5
+ declare function logErrorHint(error: unknown): void;
6
+ declare function getHint(error: unknown): null | string;
7
+ declare function isKnownError(error: unknown): false | string;
8
+ declare function isCjsEsmError(error: unknown): boolean | string[];
@@ -1,12 +1,22 @@
1
- export { logHintForCjsEsmError };
2
- // For ./logHintForCjsEsmError/*.spec.ts
1
+ export { logErrorHint };
2
+ // For ./logErrorHint/*.spec.ts
3
3
  export { isCjsEsmError };
4
- export { isReactInvalidComponentError };
4
+ export { isKnownError };
5
5
  export { getHint };
6
6
  import pc from '@brillout/picocolors';
7
7
  import { assert, formatHintLog, isNotNullish, isObject, unique, joinEnglish } from '../utils.js';
8
- function logHintForCjsEsmError(error) {
9
- /* Collect errors for ./logHintForCjsEsmError.spec.ts
8
+ const knownErrors = [
9
+ {
10
+ errMsg: 'jsxDEV is not a function',
11
+ link: 'https://github.com/vikejs/vike/issues/1469#issuecomment-1919518096'
12
+ },
13
+ {
14
+ errMsg: 'Element type is invalid: expected a string (for built-in components) or a class/function (for composite components)',
15
+ link: 'https://vike.dev/broken-npm-package#react-invalid-component'
16
+ }
17
+ ];
18
+ function logErrorHint(error) {
19
+ /* Collect errors for ./logErrorHint.spec.ts
10
20
  collectError(error)
11
21
  //*/
12
22
  const hint = getHint(error);
@@ -14,9 +24,10 @@ function logHintForCjsEsmError(error) {
14
24
  logHint(hint);
15
25
  }
16
26
  function getHint(error) {
17
- if (isReactInvalidComponentError(error)) {
18
- const hint = 'To fix this error, see https://vike.dev/broken-npm-package#react-invalid-component';
19
- return hint;
27
+ {
28
+ const link = isKnownError(error);
29
+ if (link)
30
+ return `To fix this error, see ${link}`;
20
31
  }
21
32
  const res = isCjsEsmError(error);
22
33
  if (res) {
@@ -37,43 +48,71 @@ function logHint(hint) {
37
48
  hint = formatHintLog(hint);
38
49
  console.error(hint);
39
50
  }
40
- function isReactInvalidComponentError(error) {
51
+ function isKnownError(error) {
41
52
  const anywhere = getAnywhere(error);
42
- return includes(anywhere, 'Element type is invalid: expected a string (for built-in components) or a class/function (for composite components)');
53
+ const knownErr = knownErrors.find((knownErorr) => {
54
+ return includes(anywhere, knownErorr.errMsg);
55
+ });
56
+ if (!knownErr)
57
+ return false;
58
+ return knownErr.link;
43
59
  }
44
- /**
45
- * `false` -> noop
46
- * `true` -> generic message
47
- * `'some-npm-package'` -> add some-npm-package to `ssr.noExternal`
48
- */
60
+ // `false` -> noop
61
+ // `true` -> generic message
62
+ // `'some-npm-package'` -> add some-npm-package to `ssr.noExternal`
49
63
  function isCjsEsmError(error) {
64
+ const res = check(error);
65
+ if (res === true || res === false)
66
+ return res;
67
+ const packageNames = normalizeRes(res);
68
+ if (packageNames === false)
69
+ return packageNames;
70
+ packageNames.forEach((packageName) => {
71
+ assert(!['vite', 'vike'].includes(packageName));
72
+ });
73
+ return packageNames;
74
+ }
75
+ function normalizeRes(res) {
76
+ let packageNames = Array.isArray(res) ? res : [res];
77
+ packageNames = unique(packageNames.filter(isNotNullish).filter((packageName) => packageName !== '@brillout/import'));
78
+ if (packageNames.length === 0)
79
+ return false;
80
+ return packageNames;
81
+ }
82
+ function check(error) {
50
83
  const message = getErrMessage(error);
51
84
  const anywhere = getAnywhere(error);
52
85
  const packageName_stack1 = getPackageName_stack1(error);
53
86
  const packageName_stack2 = getPackageName_stack2(error);
54
87
  const isRelatedToNodeModules = !!packageName_stack1 || !!packageName_stack2 || includesNodeModules(message);
55
- // const relatedNpmPackages = normalize([packageName_stack1, packageName_stack2, extractFromNodeModulesPath(message)])
88
+ /*
89
+ const relatedNpmPackages = normalizeArray([
90
+ packageName_stack1 || null,
91
+ packageName_stack2 || null,
92
+ (message && extractFromNodeModulesPath(message)) || null
93
+ ])
94
+ */
56
95
  // ERR_UNSUPPORTED_DIR_IMPORT
57
96
  {
58
- const packageNames = parseNodeModulesPathMessage('ERR_UNSUPPORTED_DIR_IMPORT', anywhere);
59
- if (packageNames)
60
- return packageNames;
97
+ const packageName = parseNodeModulesPathMessage('ERR_UNSUPPORTED_DIR_IMPORT', anywhere);
98
+ if (packageName)
99
+ return packageName;
61
100
  }
62
101
  // ERR_UNKNOWN_FILE_EXTENSION
63
102
  {
64
- const packageNames = parseUnkownFileExtensionMessage(anywhere);
65
- if (packageNames)
66
- return packageNames;
103
+ const packageName = parseUnkownFileExtensionMessage(anywhere);
104
+ if (packageName)
105
+ return packageName;
67
106
  }
68
107
  {
69
- const packageNames = parseNodeModulesPathMessage('ERR_UNKNOWN_FILE_EXTENSION', anywhere);
70
- if (packageNames)
71
- return packageNames;
108
+ const packageName = parseNodeModulesPathMessage('ERR_UNKNOWN_FILE_EXTENSION', anywhere);
109
+ if (packageName)
110
+ return packageName;
72
111
  }
73
112
  {
74
- const packageNames = parseNodeModulesPathMessage('is not exported', anywhere);
75
- if (packageNames)
76
- return packageNames;
113
+ const packageName = parseNodeModulesPathMessage('is not exported', anywhere);
114
+ if (packageName)
115
+ return packageName;
77
116
  }
78
117
  // Using CJS inside ESM modules.
79
118
  if (includes(anywhere, 'require is not a function') ||
@@ -94,7 +133,7 @@ function isCjsEsmError(error) {
94
133
  if (includes(anywhere, 'ERR_REQUIRE_ESM')) {
95
134
  /* The issue is the importer, not the importee.
96
135
  if (relatedNpmPackages) return relatedNpmPackages
97
- */
136
+ */
98
137
  {
99
138
  if (packageName_stack1)
100
139
  return packageName_stack1;
@@ -114,9 +153,9 @@ function isCjsEsmError(error) {
114
153
  */
115
154
  // `SyntaxError: Named export '${exportName}' not found. The requested module '${packageName}' is a CommonJS module, which may not support all module.exports as named exports.`
116
155
  {
117
- const packageNames = parseImportFrom(anywhere);
118
- if (packageNames)
119
- return packageNames;
156
+ const packageName = parseImportFrom(anywhere);
157
+ if (packageName)
158
+ return packageName;
120
159
  }
121
160
  if (includes(anywhere, 'Cannot read properties of undefined')) {
122
161
  if (isRelatedToNodeModules) {
@@ -152,7 +191,7 @@ function parseCannotFindMessage(str) {
152
191
  return false;
153
192
  // const packageNameCannotFind = extractFromPath(match[1]!)
154
193
  const packageNameFrom = extractFromPath(match[2]);
155
- return normalize([
194
+ return normalizeArray([
156
195
  // packageNameCannotFind,
157
196
  packageNameFrom
158
197
  ]);
@@ -163,7 +202,7 @@ function parseUnkownFileExtensionMessage(str) {
163
202
  return false;
164
203
  const filePath = match[1];
165
204
  const packageName = extractFromPath(filePath);
166
- return normalize([packageName]);
205
+ return packageName;
167
206
  }
168
207
  function parseImportFrom(str) {
169
208
  const match = /\bimport\b.*?\bfrom\b\s*?"(.+?)"/.exec(str);
@@ -171,7 +210,7 @@ function parseImportFrom(str) {
171
210
  return false;
172
211
  const importPath = match[1];
173
212
  const packageName = extractFromPath(importPath);
174
- return normalize([packageName]);
213
+ return packageName;
175
214
  }
176
215
  function parseNodeModulesPathMessage(begin, str) {
177
216
  str = str.replaceAll('\\', '/');
@@ -225,7 +264,6 @@ function extractFromPath(filePath) {
225
264
  packageName = packageName.split('/')[0];
226
265
  }
227
266
  packageName = clean(packageName);
228
- assert(!['vite', 'vike'].includes(packageName));
229
267
  return packageName;
230
268
  }
231
269
  function clean(packageName) {
@@ -243,7 +281,7 @@ function extractFromNodeModulesPath(str) {
243
281
  return false;
244
282
  const packageName = extractFromPath(str);
245
283
  assert(packageName);
246
- return normalize([packageName]);
284
+ return packageName;
247
285
  }
248
286
  function includes(str1, str2) {
249
287
  return !!str1 && str1.toLowerCase().includes(str2.toLowerCase());
@@ -258,11 +296,11 @@ function includesNodeModules(str) {
258
296
  return false;
259
297
  return true;
260
298
  }
261
- function normalize(packageNames) {
262
- const result = unique(packageNames.filter(isNotNullish).filter((packageName) => packageName !== '@brillout/import'));
263
- if (result.length === 0)
264
- return false;
265
- return result;
299
+ function normalizeArray(arr) {
300
+ const arrNormalized = arr.filter(isNotNullish);
301
+ if (arrNormalized.length === 0)
302
+ return null;
303
+ return arrNormalized;
266
304
  }
267
305
  function getErrMessage(err) {
268
306
  if (!isObject(err))
@@ -6,7 +6,7 @@ import { isAbortError } from '../../../shared/route/abort.js';
6
6
  import { setAlreadyLogged } from './isNewError.js';
7
7
  import { isObject, warnIfErrorIsNotObject } from '../utils.js';
8
8
  import pc from '@brillout/picocolors';
9
- import { logHintForCjsEsmError } from './logHintForCjsEsmError.js';
9
+ import { logErrorHint } from './logErrorHint.js';
10
10
  function logErrorProd(err, _httpRquestId) {
11
11
  warnIfErrorIsNotObject(err);
12
12
  setAlreadyLogged(err);
@@ -20,6 +20,6 @@ function logErrorProd(err, _httpRquestId) {
20
20
  }
21
21
  // Every server-side runtime error is expected to go through onRuntimeError(). (In principle, any runtime error is (or at least should) be catched by Vike, otherwise Vike couldn't render the error page.)
22
22
  function onRuntimeError(err) {
23
- // The more runtime errors we pass to logHintForCjsEsmError() the better.
24
- logHintForCjsEsmError(err);
23
+ // The more runtime errors we pass to logErrorHint() the better.
24
+ logErrorHint(err);
25
25
  }
@@ -36,7 +36,7 @@ export * from '../../utils/isNpmPackage.js';
36
36
  export * from '../../utils/isNotNullish.js';
37
37
  export * from '../../utils/isScriptFile.js';
38
38
  export * from '../../utils/removeFileExtention.js';
39
- export * from '../../utils/objectEntries.js';
39
+ export * from '../../utils/objectKeys.js';
40
40
  export * from '../../utils/isStringRecord.js';
41
41
  export * from '../../utils/getFileExtension.js';
42
42
  export * from '../../utils/assertIsNotProductionRuntime.js';
@@ -39,7 +39,7 @@ export * from '../../utils/isNpmPackage.js';
39
39
  export * from '../../utils/isNotNullish.js';
40
40
  export * from '../../utils/isScriptFile.js';
41
41
  export * from '../../utils/removeFileExtention.js';
42
- export * from '../../utils/objectEntries.js';
42
+ export * from '../../utils/objectKeys.js';
43
43
  export * from '../../utils/isStringRecord.js';
44
44
  export * from '../../utils/getFileExtension.js';
45
45
  export * from '../../utils/assertIsNotProductionRuntime.js';
@@ -201,7 +201,7 @@ type OnRenderHtmlSync = (pageContext: PageContextServer) => DocumentHtml | {
201
201
  pageContext: OnRenderHtmlPageContextReturn | (() => Promise<OnRenderHtmlPageContextReturn> | OnRenderHtmlPageContextReturn);
202
202
  };
203
203
  type OnRenderHtmlPageContextReturn = Partial<Vike.PageContext & {
204
- /** See https://vike.dev/stream */
204
+ /** See https://vike.dev/streaming */
205
205
  enableEagerStreaming: boolean;
206
206
  }>;
207
207
  /** @deprecated Use a sync route() with an async guard() instead */
@@ -17,6 +17,7 @@ export type { DefinedAtFileFullInfo };
17
17
  export type { FilePathResolved };
18
18
  export type { FilePath };
19
19
  import type { ConfigValueImported, ConfigValueSerialized } from './serialize/PageConfigSerialized.js';
20
+ import type { LocationId } from '../../node/plugin/plugins/importUserCode/v1-design/getVikeConfig/filesystemRouting.js';
20
21
  type PageConfigBase = {
21
22
  pageId: string;
22
23
  isErrorPage?: true;
@@ -71,6 +72,7 @@ type ConfigValueSource = {
71
72
  value?: unknown;
72
73
  configEnv: ConfigEnvInternal;
73
74
  definedAt: DefinedAtFileFullInfo;
75
+ locationId: LocationId;
74
76
  /** Wether the config value is loaded at runtime, for example config.Page or config.onBeforeRender */
75
77
  valueIsImportedAtRuntime: boolean;
76
78
  /** Whether the config value is a file path, for example config.client */
@@ -2,41 +2,68 @@ export { parseConfigValuesImported };
2
2
  import { assert } from '../../utils.js';
3
3
  import { assertPlusFileExport } from '../assertPlusFileExport.js';
4
4
  function parseConfigValuesImported(configValuesImported) {
5
- const configValues = {};
6
- const addConfigValue = (configName, value, importPath, exportName) => {
7
- configValues[configName] = {
8
- value,
9
- definedAt: {
10
- // importPath cannot be relative to the current file, since the current file is a virtual file
11
- filePathToShowToUser: importPath,
12
- fileExportPathToShowToUser: [configName, 'default'].includes(exportName)
13
- ? []
14
- : // Side-effect config
15
- [exportName]
16
- }
17
- };
18
- assertIsNotNull(value, configName, importPath);
19
- };
20
- configValuesImported.forEach((configValueLoaded) => {
5
+ const configValuesUnmerged = {};
6
+ configValuesImported
7
+ .filter((c) => c.configName !== 'client')
8
+ .forEach((configValueLoaded) => {
21
9
  if (configValueLoaded.isValueFile) {
22
10
  const { exportValues, importPath, configName } = configValueLoaded;
23
- if (configName !== 'client') {
24
- assertPlusFileExport(exportValues, importPath, configName);
25
- }
11
+ assertPlusFileExport(exportValues, importPath, configName);
26
12
  Object.entries(exportValues).forEach(([exportName, exportValue]) => {
27
13
  const isSideExport = exportName !== 'default'; // .md files may have "side-exports" such as `export { frontmatter }`
28
14
  const configName = isSideExport ? exportName : configValueLoaded.configName;
29
- if (isSideExport && configName in configValues) {
30
- // We can't avoid side-export conflicts upstream. (Because we cannot know about side-exports upstream at build-time.)
31
- // Side-exports have the lowest priority.
32
- return;
33
- }
34
- addConfigValue(configName, exportValue, importPath, exportName);
15
+ configValuesUnmerged[configName] ?? (configValuesUnmerged[configName] = []);
16
+ configValuesUnmerged[configName].push({
17
+ value: exportValue,
18
+ importPath,
19
+ exportName,
20
+ isSideExport
21
+ });
35
22
  });
36
23
  }
37
24
  else {
38
25
  const { configName, importPath, exportValue, exportName } = configValueLoaded;
39
- addConfigValue(configName, exportValue, importPath, exportName);
26
+ configValuesUnmerged[configName] ?? (configValuesUnmerged[configName] = []);
27
+ configValuesUnmerged[configName].push({
28
+ value: exportValue,
29
+ importPath,
30
+ exportName,
31
+ isSideExport: false
32
+ });
33
+ }
34
+ });
35
+ const configValues = {};
36
+ Object.entries(configValuesUnmerged).forEach(([configName, values]) => {
37
+ const valuesWithoutSideExports = values.filter((v) => !v.isSideExport);
38
+ const isCumulative = valuesWithoutSideExports.length > 1;
39
+ const noSideExports = valuesWithoutSideExports.length === values.length;
40
+ if (isCumulative) {
41
+ // Vike currently doesn't support side exports for cumulative configs
42
+ assert(noSideExports);
43
+ // TODO: implement
44
+ assert(false);
45
+ }
46
+ else {
47
+ const val = valuesWithoutSideExports[0] ??
48
+ // We can't avoid side-export conflicts upstream. (We cannot know about side-exports at build-time.)
49
+ // Side-exports have lower precedence.
50
+ values[0];
51
+ assert(val);
52
+ const { value, importPath, exportName } = val;
53
+ configValues[configName] = {
54
+ value,
55
+ definedAt: {
56
+ // importPath cannot be relative to the current file, since the current file is a virtual file
57
+ filePathToShowToUser: importPath,
58
+ fileExportPathToShowToUser: [configName, 'default'].includes(exportName)
59
+ ? []
60
+ : [
61
+ // Side-export
62
+ exportName
63
+ ]
64
+ }
65
+ };
66
+ assertIsNotNull(value, configName, importPath);
40
67
  }
41
68
  });
42
69
  return configValues;
@@ -1,6 +1,7 @@
1
1
  export { executeGuardHook };
2
2
  import { getHook, getHookTimeoutDefault } from '../hooks/getHook.js';
3
3
  import { assert, assertUsage, executeHook, isCallable } from './utils.js';
4
+ const errIntro = 'The guard() hook defined by';
4
5
  async function executeGuardHook(pageContext, prepareForUserConsumption) {
5
6
  let hook;
6
7
  if (pageContext._pageFilesAll.length > 0) {
@@ -20,7 +21,7 @@ async function executeGuardHook(pageContext, prepareForUserConsumption) {
20
21
  if (res)
21
22
  pageContextForUserConsumption = res;
22
23
  const hookResult = await executeHook(() => guard(pageContextForUserConsumption), hook);
23
- assertUsage(hookResult === undefined, `The guard() hook of ${hook.hookFilePath} returns a value, but guard() doesn't accept any return value`);
24
+ assertUsage(hookResult === undefined, `${errIntro} ${hook.hookFilePath} returns a value, but guard() shouldn't return any value`);
24
25
  }
25
26
  function findPageGuard(pageId, pageFilesAll) {
26
27
  const pageRouteFile = pageFilesAll.find((p) => p.pageId === pageId && p.fileType === '.page.route');
@@ -33,6 +34,6 @@ function findPageGuard(pageId, pageFilesAll) {
33
34
  return null;
34
35
  const hookFilePath = filePath;
35
36
  const hookTimeout = getHookTimeoutDefault('guard');
36
- assertUsage(isCallable(hookFn), `guard() defined by ${hookFilePath} should be a function`);
37
+ assertUsage(isCallable(hookFn), `${errIntro} ${hookFilePath} should be a function`);
37
38
  return { hookFn, hookName: 'guard', hookFilePath, hookTimeout };
38
39
  }
@@ -18,6 +18,5 @@ export * from '../utils/projectInfo.js';
18
18
  export * from '../utils/isPropertyGetter.js';
19
19
  export * from '../utils/isPromise.js';
20
20
  export * from '../utils/checkType.js';
21
- export * from '../utils/objectEntries.js';
22
21
  export * from '../utils/getValuePrintable.js';
23
22
  export * from '../utils/escapeRegex.js';
@@ -22,6 +22,5 @@ export * from '../utils/projectInfo.js';
22
22
  export * from '../utils/isPropertyGetter.js';
23
23
  export * from '../utils/isPromise.js';
24
24
  export * from '../utils/checkType.js';
25
- export * from '../utils/objectEntries.js';
26
25
  export * from '../utils/getValuePrintable.js';
27
26
  export * from '../utils/escapeRegex.js';
@@ -1,11 +1,11 @@
1
1
  export { assertNodeVersion };
2
2
  import { assertUsage } from './assert.js';
3
3
  import { isNodeJS } from './isNodeJS.js';
4
+ import { isVersionOrAbove } from './isVersionOrAbove.js';
4
5
  // package.json#engines.node isn't enough as users can ignore it
5
6
  function assertNodeVersion() {
6
7
  if (!isNodeJS())
7
8
  return;
8
9
  const version = process.versions.node;
9
- const major = parseInt(version.split('.')[0], 10);
10
- assertUsage(major >= 16, `Node.js ${version} isn't supported, use Node.js >=16.0.0 instead.`);
10
+ assertUsage(isVersionOrAbove(version, '16.0.0'), `Node.js ${version} isn't supported, use Node.js >=16.0.0 instead.`);
11
11
  }
@@ -0,0 +1,3 @@
1
+ export { findFile };
2
+ type Filename = 'package.json' | 'vike.config.js' | 'vike.config.ts';
3
+ declare function findFile(arg: Filename | Filename[], cwd: string): null | string;
@@ -0,0 +1,21 @@
1
+ export { findFile };
2
+ import path from 'path';
3
+ import fs from 'fs';
4
+ function findFile(arg, cwd) {
5
+ const filenames = Array.isArray(arg) ? arg : [arg];
6
+ let dir = cwd;
7
+ while (true) {
8
+ for (const filename of filenames) {
9
+ const configFilePath = path.join(dir, `./${filename}`);
10
+ if (fs.existsSync(configFilePath)) {
11
+ // return toPosixPath(configFilePath)
12
+ return configFilePath;
13
+ }
14
+ }
15
+ const dirPrevious = dir;
16
+ dir = path.dirname(dir);
17
+ if (dir === dirPrevious) {
18
+ return null;
19
+ }
20
+ }
21
+ }
@@ -1,5 +1,6 @@
1
1
  export { getOutDirs };
2
2
  export { resolveOutDir };
3
+ export type { OutDirs };
3
4
  import type { UserConfig, ResolvedConfig } from 'vite';
4
5
  type OutDirs = {
5
6
  /** Absolute path to `outDir` */
@@ -0,0 +1,2 @@
1
+ export { isVersionOrAbove };
2
+ declare function isVersionOrAbove(versionActual: string, versionExpected: `${number}.${number}.${number}`): boolean;