vike 0.4.235-commit-7b1ab35 → 0.4.235-commit-9b9289b

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 (44) hide show
  1. package/dist/cjs/node/runtime/globalContext.js +18 -6
  2. package/dist/cjs/node/runtime/html/injectAssets/injectHtmlTags.js +2 -0
  3. package/dist/cjs/node/runtime/html/serializeContext.js +14 -1
  4. package/dist/cjs/node/runtime/renderPage/createHttpResponse/getCacheControl.js +7 -7
  5. package/dist/cjs/node/runtime/renderPage/createHttpResponse.js +8 -5
  6. package/dist/cjs/node/runtime/renderPage/loadPageConfigsLazyServerSide.js +25 -0
  7. package/dist/cjs/node/runtime/renderPage/renderPageAlreadyRouted.js +1 -0
  8. package/dist/cjs/node/runtime/renderPage.js +1 -0
  9. package/dist/cjs/node/vite/shared/resolveVikeConfigInternal/configDefinitionsBuiltIn.js +4 -0
  10. package/dist/cjs/node/vite/shared/resolveVikeConfigInternal/filesystemRouting.js +4 -6
  11. package/dist/cjs/shared/createGlobalContextShared.js +18 -7
  12. package/dist/cjs/shared/route/loadPageRoutes.js +7 -1
  13. package/dist/cjs/utils/PROJECT_VERSION.js +1 -1
  14. package/dist/esm/client/runtime-client-routing/getPageContextFromHooks.d.ts +8 -0
  15. package/dist/esm/client/runtime-client-routing/history.d.ts +4 -2
  16. package/dist/esm/client/runtime-client-routing/history.js +13 -35
  17. package/dist/esm/client/runtime-client-routing/initClientRouter.js +3 -2
  18. package/dist/esm/client/runtime-client-routing/renderPageClientSide.d.ts +2 -0
  19. package/dist/esm/client/shared/createGetGlobalContextClient.d.ts +2 -2
  20. package/dist/esm/node/prerender/runPrerender.d.ts +1 -0
  21. package/dist/esm/node/runtime/globalContext.d.ts +14 -12
  22. package/dist/esm/node/runtime/globalContext.js +20 -8
  23. package/dist/esm/node/runtime/html/injectAssets/injectHtmlTags.js +2 -0
  24. package/dist/esm/node/runtime/html/serializeContext.js +14 -1
  25. package/dist/esm/node/runtime/renderPage/createHttpResponse/getCacheControl.d.ts +3 -3
  26. package/dist/esm/node/runtime/renderPage/createHttpResponse/getCacheControl.js +7 -7
  27. package/dist/esm/node/runtime/renderPage/createHttpResponse.d.ts +1 -0
  28. package/dist/esm/node/runtime/renderPage/createHttpResponse.js +8 -5
  29. package/dist/esm/node/runtime/renderPage/loadPageConfigsLazyServerSide.d.ts +5 -2
  30. package/dist/esm/node/runtime/renderPage/loadPageConfigsLazyServerSide.js +25 -0
  31. package/dist/esm/node/runtime/renderPage/renderPageAlreadyRouted.d.ts +2 -0
  32. package/dist/esm/node/runtime/renderPage/renderPageAlreadyRouted.js +1 -0
  33. package/dist/esm/node/runtime/renderPage.js +1 -0
  34. package/dist/esm/node/vite/shared/resolveVikeConfigInternal/configDefinitionsBuiltIn.js +4 -0
  35. package/dist/esm/node/vite/shared/resolveVikeConfigInternal/filesystemRouting.js +4 -6
  36. package/dist/esm/shared/createGlobalContextShared.d.ts +3 -3
  37. package/dist/esm/shared/createGlobalContextShared.js +18 -7
  38. package/dist/esm/shared/route/loadPageRoutes.d.ts +5 -0
  39. package/dist/esm/shared/route/loadPageRoutes.js +7 -1
  40. package/dist/esm/types/Config.d.ts +7 -0
  41. package/dist/esm/types/PageContext.d.ts +8 -2
  42. package/dist/esm/utils/PROJECT_VERSION.d.ts +1 -1
  43. package/dist/esm/utils/PROJECT_VERSION.js +1 -1
  44. package/package.json +2 -2
@@ -21,8 +21,10 @@ export type { GlobalContextServerInternal as GlobalContextServerInternal };
21
21
  export type { GlobalContextServer };
22
22
  import type { ViteManifest } from '../../types/ViteManifest.js';
23
23
  import type { ResolvedConfig, ViteDevServer } from 'vite';
24
+ import { type PageRoutes } from '../../shared/route/loadPageRoutes.js';
24
25
  import type { ViteConfigRuntime } from '../vite/shared/getViteConfigRuntime.js';
25
26
  import type { GlobalContext } from '../../types/PageContext.js';
27
+ import type { Hook } from '../../shared/hooks/getHook.js';
26
28
  declare const vikeConfigErrorRecoverMsg: "Vike config loaded";
27
29
  type GlobalContextServer = Pick<GlobalContextServerInternal, 'assetsManifest' | 'config' | 'viteConfig' | 'viteConfigRuntime' | 'pages' | 'baseServer' | 'baseAssets' | 'isClientSide'> & Vike.GlobalContext & Vike.GlobalContextServer;
28
30
  type GlobalContextServerInternal = Awaited<ReturnType<typeof setGlobalContext>>;
@@ -64,8 +66,8 @@ declare function getGlobalContextServerInternal(): Promise<{
64
66
  baseServer: string;
65
67
  baseAssets: string;
66
68
  isClientSide: false;
67
- _pageRoutes: import("../../shared/route/loadPageRoutes.js").PageRoutes;
68
- _onBeforeRouteHook: import("../../shared/hooks/getHook.js").Hook | null;
69
+ _pageRoutes: PageRoutes;
70
+ _onBeforeRouteHook: Hook | null;
69
71
  }) | (Record<string, unknown> & {
70
72
  isGlobalContext: true;
71
73
  _isOriginalObject: true;
@@ -104,8 +106,8 @@ declare function getGlobalContextServerInternal(): Promise<{
104
106
  baseServer: string;
105
107
  baseAssets: string;
106
108
  isClientSide: false;
107
- _pageRoutes: import("../../shared/route/loadPageRoutes.js").PageRoutes;
108
- _onBeforeRouteHook: import("../../shared/hooks/getHook.js").Hook | null;
109
+ _pageRoutes: PageRoutes;
110
+ _onBeforeRouteHook: Hook | null;
109
111
  }) | (Record<string, unknown> & {
110
112
  isGlobalContext: true;
111
113
  _isOriginalObject: true;
@@ -144,8 +146,8 @@ declare function getGlobalContextServerInternal(): Promise<{
144
146
  baseServer: string;
145
147
  baseAssets: string;
146
148
  isClientSide: false;
147
- _pageRoutes: import("../../shared/route/loadPageRoutes.js").PageRoutes;
148
- _onBeforeRouteHook: import("../../shared/hooks/getHook.js").Hook | null;
149
+ _pageRoutes: PageRoutes;
150
+ _onBeforeRouteHook: Hook | null;
149
151
  });
150
152
  }>;
151
153
  /**
@@ -222,8 +224,8 @@ declare function setGlobalContext(virtualFileExports: unknown): Promise<{
222
224
  baseServer: string;
223
225
  baseAssets: string;
224
226
  isClientSide: false;
225
- _pageRoutes: import("../../shared/route/loadPageRoutes.js").PageRoutes;
226
- _onBeforeRouteHook: import("../../shared/hooks/getHook.js").Hook | null;
227
+ _pageRoutes: PageRoutes;
228
+ _onBeforeRouteHook: Hook | null;
227
229
  } | {
228
230
  _isPrerendering: true;
229
231
  viteConfig: ResolvedConfig;
@@ -244,8 +246,8 @@ declare function setGlobalContext(virtualFileExports: unknown): Promise<{
244
246
  baseServer: string;
245
247
  baseAssets: string;
246
248
  isClientSide: false;
247
- _pageRoutes: import("../../shared/route/loadPageRoutes.js").PageRoutes;
248
- _onBeforeRouteHook: import("../../shared/hooks/getHook.js").Hook | null;
249
+ _pageRoutes: PageRoutes;
250
+ _onBeforeRouteHook: Hook | null;
249
251
  } | {
250
252
  _isPrerendering: false;
251
253
  viteConfig: null;
@@ -266,7 +268,7 @@ declare function setGlobalContext(virtualFileExports: unknown): Promise<{
266
268
  baseServer: string;
267
269
  baseAssets: string;
268
270
  isClientSide: false;
269
- _pageRoutes: import("../../shared/route/loadPageRoutes.js").PageRoutes;
270
- _onBeforeRouteHook: import("../../shared/hooks/getHook.js").Hook | null;
271
+ _pageRoutes: PageRoutes;
272
+ _onBeforeRouteHook: Hook | null;
271
273
  })>;
272
274
  declare function clearGlobalContext(): void;
@@ -13,7 +13,7 @@ export { setGlobalContext_viteDevServer };
13
13
  export { setGlobalContext_viteConfig };
14
14
  export { setGlobalContext_isPrerendering };
15
15
  export { setGlobalContext_isProduction };
16
- export { setGlobalContext_buildEntry };
16
+ export { setGlobalContext_buildEntry }; // production entry
17
17
  export { clearGlobalContext };
18
18
  export { assertBuildInfo };
19
19
  export { updateUserFiles };
@@ -30,7 +30,7 @@ import { assert, onSetupRuntime, assertUsage, assertWarning, isPlainObject, obje
30
30
  import { importServerProductionEntry } from '@brillout/vite-plugin-server-entry/runtime';
31
31
  import { virtualFileIdEntryServer } from '../shared/virtualFiles/virtualFileEntry.js';
32
32
  import pc from '@brillout/picocolors';
33
- import { loadPageRoutes } from '../../shared/route/loadPageRoutes.js';
33
+ import { loadPageRoutes, loadPageRoutesSync } from '../../shared/route/loadPageRoutes.js';
34
34
  import { assertV1Design } from '../shared/assertV1Design.js';
35
35
  import { resolveBase } from '../shared/resolveBase.js';
36
36
  import { createGlobalContextShared, getGlobalContextSyncErrMsg, } from '../../shared/createGlobalContextShared.js';
@@ -39,7 +39,7 @@ import { logRuntimeError, logRuntimeInfo } from './loggerRuntime.js';
39
39
  import { getVikeConfigErrorBuild, setVikeConfigError } from '../shared/getVikeConfigError.js';
40
40
  import { hasAlreadyLogged } from './renderPage/isNewError.js';
41
41
  const debug = createDebugger('vike:globalContext');
42
- const globalObject = getGlobalObject('runtime/globalContext.ts', getInitialGlobalContext());
42
+ const globalObject = getGlobalObject('runtime/globalContext.ts', getInitialGlobalObject());
43
43
  // Trick to break down TypeScript circular dependency
44
44
  // https://chat.deepseek.com/a/chat/s/d7e9f90a-c7f3-4108-9cd5-4ad6caed3539
45
45
  const globalObjectTyped = globalObject;
@@ -232,6 +232,7 @@ function assertViteManifest(manifest) {
232
232
  async function loadBuildEntry(outDir) {
233
233
  debug('loadBuildEntry()');
234
234
  if (globalObject.globalContext) {
235
+ debug('loadBuildEntry() - already done');
235
236
  return;
236
237
  }
237
238
  if (!globalObject.buildEntry) {
@@ -257,6 +258,8 @@ async function loadBuildEntry(outDir) {
257
258
  globalObject.buildInfo = buildEntry.buildInfo;
258
259
  await setGlobalContext(buildEntry.virtualFileExports);
259
260
  }
261
+ // This is the production entry, see:
262
+ // https://github.com/vikejs/vike/blob/798e5465dc3e3e6723b38b601a50350c0a006fb8/packages/vike/node/vite/plugins/pluginBuild/pluginBuildEntry.ts#L47
260
263
  async function setGlobalContext_buildEntry(buildEntry) {
261
264
  debug('setGlobalContext_buildEntry()');
262
265
  setIsProduction(true);
@@ -266,6 +269,7 @@ async function setGlobalContext_buildEntry(buildEntry) {
266
269
  assert(globalObject.buildEntry); // ensure no infinite loop
267
270
  await loadBuildEntry();
268
271
  assertGlobalContextIsDefined();
272
+ debug('setGlobalContext_buildEntry() - done');
269
273
  }
270
274
  function assertBuildEntry(buildEntry) {
271
275
  assert(isObject(buildEntry));
@@ -362,8 +366,9 @@ async function updateUserFiles() {
362
366
  return onSuccess();
363
367
  }
364
368
  async function setGlobalContext(virtualFileExports) {
369
+ debug('setGlobalContext()');
365
370
  assert(!getVikeConfigErrorBuild());
366
- const globalContext = await createGlobalContextShared(virtualFileExports, globalObject, addGlobalContext);
371
+ const globalContext = await createGlobalContextShared(virtualFileExports, globalObject, addGlobalContextAsync, addGlobalContextSync);
367
372
  assertV1Design(
368
373
  // pageConfigs is PageConfigRuntime[] but assertV1Design() requires PageConfigBuildTime[]
369
374
  globalContext._pageConfigs.length > 0, globalContext._pageFilesAll);
@@ -372,8 +377,15 @@ async function setGlobalContext(virtualFileExports) {
372
377
  // Never actually used, only used for TypeScript `ReturnType<typeof setGlobalContext>`
373
378
  return globalContext;
374
379
  }
375
- async function addGlobalContext(globalContext) {
380
+ async function addGlobalContextAsync(globalContext) {
376
381
  const { pageRoutes, onBeforeRouteHook } = await loadPageRoutes(globalContext._pageFilesAll, globalContext._pageConfigs, globalContext._pageConfigGlobal, globalContext._allPageIds);
382
+ return addGlobalContextCommon(globalContext, pageRoutes, onBeforeRouteHook);
383
+ }
384
+ function addGlobalContextSync(globalContext) {
385
+ const { pageRoutes, onBeforeRouteHook } = loadPageRoutesSync(globalContext._pageFilesAll, globalContext._pageConfigs, globalContext._pageConfigGlobal, globalContext._allPageIds);
386
+ return addGlobalContextCommon(globalContext, pageRoutes, onBeforeRouteHook);
387
+ }
388
+ function addGlobalContextCommon(globalContext, pageRoutes, onBeforeRouteHook) {
377
389
  const globalContextBase = {
378
390
  isClientSide: false,
379
391
  _pageRoutes: pageRoutes,
@@ -432,10 +444,10 @@ async function addGlobalContext(globalContext) {
432
444
  }
433
445
  function clearGlobalContext() {
434
446
  debug('clearGlobalContext()');
435
- objectReplace(globalObject, getInitialGlobalContext(), ['buildEntryPrevious']);
447
+ objectReplace(globalObject, getInitialGlobalObject(), ['buildEntryPrevious']);
436
448
  }
437
- function getInitialGlobalContext() {
438
- debug('getInitialGlobalContext()');
449
+ function getInitialGlobalObject() {
450
+ debug('getInitialGlobalObject()');
439
451
  const { promise: viteDevServerPromise, resolve: viteDevServerPromiseResolve } = genPromise();
440
452
  return {
441
453
  viteDevServerPromise,
@@ -149,6 +149,8 @@ function getTagClosing(tag) {
149
149
  return tagClosing;
150
150
  }
151
151
  function injectAtPlaceholder(htmlFragment, htmlString, isFirst) {
152
+ // TO-DO/eventually: soft deprecate in favor of https://github.com/vikejs/vike/issues/695
153
+ // Used by BurdaForward https://github.com/vikejs/vike/discussions/2528#discussioncomment-13637156
152
154
  const placeholder = isFirst ? '__VITE_PLUGIN_SSR__ASSETS_FIRST__' : '__VITE_PLUGIN__SSR_ASSETS_LAST__';
153
155
  const parts = htmlString.split(placeholder);
154
156
  if (parts.length === 1)
@@ -103,7 +103,20 @@ function serializeObject(obj, objName, passToClient) {
103
103
  return serialized;
104
104
  }
105
105
  function serializeValue(value, varName) {
106
- return stringify(value, { forbidReactElements: true, valueName: varName });
106
+ return stringify(value, {
107
+ forbidReactElements: true,
108
+ valueName: varName,
109
+ // Prevent Google from crawling URLs in JSON:
110
+ // - https://github.com/vikejs/vike/discussions/2541#discussioncomment-13660198
111
+ // - https://github.com/vikejs/vike/discussions/2277
112
+ // - https://github.com/vikejs/vike/pull/2542
113
+ replacer(_key, value) {
114
+ if (typeof value === 'string' && value.startsWith('/')) {
115
+ // No need to use a reviver: https://github.com/brillout/json-serializer/blob/70fc8ed3741306391b51655b05df24e6963d1fdb/test/main.spec.ts#L74-L80
116
+ return { replacement: (value = '!' + value) };
117
+ }
118
+ },
119
+ });
107
120
  }
108
121
  function getPassToClientPageContext(pageContext) {
109
122
  let passToClient = [...pageContext._passToClient, ...passToClientBuiltInPageContext];
@@ -1,5 +1,5 @@
1
1
  export { getCacheControl };
2
+ export { cacheControlDisable };
2
3
  import type { PageConfigRuntime } from '../../../../types/PageConfig.js';
3
- import type { HttpResponse } from '../createHttpResponse.js';
4
- type StatusCode = HttpResponse['statusCode'];
5
- declare function getCacheControl(pageId: string | null, pageConfigs: PageConfigRuntime[], statusCode: StatusCode): string;
4
+ declare const cacheControlDisable = "no-store, max-age=0";
5
+ declare function getCacheControl(pageId: string | null, pageConfigs: PageConfigRuntime[]): string;
@@ -1,13 +1,13 @@
1
+ // TODO/now: move
1
2
  export { getCacheControl };
3
+ export { cacheControlDisable };
2
4
  import { getPageConfig } from '../../../../shared/page-configs/helpers.js';
3
5
  import { getConfigValueRuntime } from '../../../../shared/page-configs/getConfigValueRuntime.js';
4
- const defaultValue = 'no-store, max-age=0';
5
- function getCacheControl(pageId, pageConfigs, statusCode) {
6
- // TO-DO/next-major-release: remove
6
+ const cacheControlDisable = 'no-store, max-age=0';
7
+ function getCacheControl(pageId, pageConfigs) {
8
+ // TO-DO/next-major-release: remove this line
7
9
  if (pageConfigs.length === 0)
8
- return defaultValue;
9
- if (statusCode > 499)
10
- return defaultValue;
10
+ return cacheControlDisable;
11
11
  if (pageId) {
12
12
  const pageConfig = getPageConfig(pageId, pageConfigs);
13
13
  const configValue = getConfigValueRuntime(pageConfig, 'cacheControl', 'string');
@@ -18,5 +18,5 @@ function getCacheControl(pageId, pageConfigs, statusCode) {
18
18
  // - Disabling caching by default is the safest strategy, because caching is problematic with authentication as described in https://github.com/vikejs/vike/issues/1275#issuecomment-1824366875
19
19
  // - Are there use cases when we don't need to disable caching?
20
20
  // - When there isn't any <script id="vike_pageContext" type="application/json"> then we can safely have caching. (We don't implement this exception because we're lazy and it's quite a rare situation.)
21
- return defaultValue;
21
+ return cacheControlDisable;
22
22
  }
@@ -28,6 +28,7 @@ declare function createHttpResponsePage(htmlRender: HtmlRender, renderHook: null
28
28
  __getPageAssets: GetPageAssets;
29
29
  _globalContext: GlobalContextServerInternal;
30
30
  abortStatusCode?: AbortStatusCode;
31
+ headersResponse?: Headers;
31
32
  }): Promise<HttpResponse>;
32
33
  declare function createHttpResponse404(errMsg404: string): HttpResponse;
33
34
  declare function createHttpResponseBaseIsMissing(urlOriginal: string, baseServer: string): HttpResponse;
@@ -9,8 +9,8 @@ import { assert, assertWarning, escapeHtml } from '../utils.js';
9
9
  import { getErrorPageId, isErrorPage } from '../../../shared/error-page.js';
10
10
  import { getHttpResponseBody, getHttpResponseBodyStreamHandlers } from './getHttpResponseBody.js';
11
11
  import { getEarlyHints } from './getEarlyHints.js';
12
- import { getCacheControl } from './createHttpResponse/getCacheControl.js';
13
12
  import { assertNoInfiniteHttpRedirect } from './createHttpResponse/assertNoInfiniteHttpRedirect.js';
13
+ import { cacheControlDisable } from './createHttpResponse/getCacheControl.js';
14
14
  async function createHttpResponsePage(htmlRender, renderHook, pageContext) {
15
15
  let statusCode = pageContext.abortStatusCode;
16
16
  if (!statusCode) {
@@ -29,10 +29,13 @@ async function createHttpResponsePage(htmlRender, renderHook, pageContext) {
29
29
  }
30
30
  const earlyHints = getEarlyHints(await pageContext.__getPageAssets());
31
31
  const headers = [];
32
- const cacheControl = getCacheControl(pageContext.pageId, pageContext._globalContext._pageConfigs, statusCode);
33
- if (cacheControl) {
34
- headers.push(['Cache-Control', cacheControl]);
35
- }
32
+ const headersResponse = pageContext.headersResponse || new Headers();
33
+ headersResponse.forEach((value, key) => {
34
+ headers.push([key, value]);
35
+ });
36
+ // An 5xx error page shouldn't be cached (it should be temporary)
37
+ if (statusCode >= 500)
38
+ headersResponse.set('Cache-Control', cacheControlDisable);
36
39
  return createHttpResponse(statusCode, 'text/html;charset=utf-8', headers, htmlRender, earlyHints, renderHook);
37
40
  }
38
41
  function createHttpResponse404(errMsg404) {
@@ -1,6 +1,7 @@
1
1
  export { loadPageConfigsLazyServerSideAndExecHook };
2
2
  export type { PageContext_loadPageConfigsLazyServerSide };
3
3
  export type { PageConfigsLazy };
4
+ import { type VikeConfigPublicPageLazy } from '../../../shared/getPageFiles.js';
4
5
  import { PromiseType } from '../utils.js';
5
6
  import { PageContextGetPageAssets, type PageAsset } from './getPageAssets.js';
6
7
  import { type PageContextDebugRouteMatches } from './debugPageFiles.js';
@@ -13,19 +14,21 @@ type PageContext_loadPageConfigsLazyServerSide = PageContextGetPageAssets & Page
13
14
  _globalContext: GlobalContextServerInternal;
14
15
  };
15
16
  type PageConfigsLazy = PromiseType<ReturnType<typeof loadPageConfigsLazyServerSide>>;
16
- declare function loadPageConfigsLazyServerSideAndExecHook<PageContext extends PageContext_loadPageConfigsLazyServerSide & PageContextExecuteHook>(pageContext: PageContext): Promise<PageContext & import("../../../shared/getPageFiles.js").VikeConfigPublicPageLazy & {
17
+ declare function loadPageConfigsLazyServerSideAndExecHook<PageContext extends PageContext_loadPageConfigsLazyServerSide & PageContextExecuteHook>(pageContext: PageContext): Promise<PageContext & VikeConfigPublicPageLazy & {
17
18
  Page: unknown;
18
19
  _isHtmlOnly: boolean;
19
20
  _passToClient: string[];
20
21
  _pageFilePathsLoaded: string[];
22
+ headersResponse: Headers;
21
23
  } & {
22
24
  __getPageAssets: () => Promise<PageAsset[]>;
23
25
  }>;
24
- declare function loadPageConfigsLazyServerSide(pageContext: PageContext_loadPageConfigsLazyServerSide): Promise<import("../../../shared/getPageFiles.js").VikeConfigPublicPageLazy & {
26
+ declare function loadPageConfigsLazyServerSide(pageContext: PageContext_loadPageConfigsLazyServerSide): Promise<VikeConfigPublicPageLazy & {
25
27
  Page: unknown;
26
28
  _isHtmlOnly: boolean;
27
29
  _passToClient: string[];
28
30
  _pageFilePathsLoaded: string[];
31
+ headersResponse: Headers;
29
32
  } & {
30
33
  __getPageAssets: () => Promise<PageAsset[]>;
31
34
  }>;
@@ -9,12 +9,15 @@ import { findPageConfig } from '../../../shared/page-configs/findPageConfig.js';
9
9
  import { analyzePage } from './analyzePage.js';
10
10
  import { loadConfigValues } from '../../../shared/page-configs/loadConfigValues.js';
11
11
  import { execHookServer } from './execHookServer.js';
12
+ import { getCacheControl } from './createHttpResponse/getCacheControl.js';
13
+ // TODO/now: rename?
12
14
  async function loadPageConfigsLazyServerSideAndExecHook(pageContext) {
13
15
  const pageContextAddendum = await loadPageConfigsLazyServerSide(pageContext);
14
16
  objectAssign(pageContext, pageContextAddendum);
15
17
  await execHookServer('onCreatePageContext', pageContext);
16
18
  return pageContext;
17
19
  }
20
+ // TODO/now: rename?
18
21
  async function loadPageConfigsLazyServerSide(pageContext) {
19
22
  const pageConfig = findPageConfig(pageContext._globalContext._pageConfigs, pageContext.pageId); // Make pageConfig globally available as pageContext._pageConfig ?
20
23
  const globalContext = pageContext._globalContext;
@@ -48,6 +51,7 @@ async function loadPageConfigsLazyServerSide(pageContext) {
48
51
  _isHtmlOnly: isHtmlOnly,
49
52
  _passToClient: passToClient,
50
53
  _pageFilePathsLoaded: pageFilesLoaded.map((p) => p.filePath),
54
+ headersResponse: resolveHeadersResponse(pageContext, pageContextAddendum),
51
55
  });
52
56
  objectAssign(pageContextAddendum, {
53
57
  __getPageAssets: async () => {
@@ -100,6 +104,7 @@ async function loadPageConfigsLazyServerSide(pageContext) {
100
104
  });
101
105
  return pageContextAddendum;
102
106
  }
107
+ // TODO/now: rename?
103
108
  async function loadPageUserFiles(pageFilesAll, pageConfig, pageConfigGlobal, pageId, isDev) {
104
109
  const pageFilesServerSide = getPageFilesServerSide(pageFilesAll, pageId);
105
110
  const pageConfigLoaded = !pageConfig ? null : await loadConfigValues(pageConfig, isDev);
@@ -110,3 +115,23 @@ async function loadPageUserFiles(pageFilesAll, pageConfig, pageConfigGlobal, pag
110
115
  pageFilesLoaded: pageFilesServerSide,
111
116
  };
112
117
  }
118
+ function resolveHeadersResponse(
119
+ // TODO/now: merge pageContextAddendum with pageContext
120
+ pageContext, pageContextAddendum) {
121
+ const headersResponse = mergeHeaders(pageContextAddendum.config.headersResponse);
122
+ if (!headersResponse.get('Cache-Control')) {
123
+ const cacheControl = getCacheControl(pageContext.pageId, pageContext._globalContext._pageConfigs);
124
+ if (cacheControl)
125
+ headersResponse.set('Cache-Control', cacheControl);
126
+ }
127
+ return headersResponse;
128
+ }
129
+ function mergeHeaders(headersList = []) {
130
+ const headersMerged = new Headers();
131
+ headersList.forEach((headers) => {
132
+ new Headers(headers).forEach((value, key) => {
133
+ headersMerged.append(key, value);
134
+ });
135
+ });
136
+ return headersMerged;
137
+ }
@@ -145,6 +145,7 @@ declare function prerenderPage(pageContext: PageContextCreated & PageConfigsLazy
145
145
  _isHtmlOnly: boolean;
146
146
  _passToClient: string[];
147
147
  _pageFilePathsLoaded: string[];
148
+ headersResponse: Headers;
148
149
  } & {
149
150
  __getPageAssets: () => Promise<import("./getPageAssets.js").PageAsset[]>;
150
151
  } & {
@@ -279,6 +280,7 @@ declare function prerenderPage(pageContext: PageContextCreated & PageConfigsLazy
279
280
  _isHtmlOnly: boolean;
280
281
  _passToClient: string[];
281
282
  _pageFilePathsLoaded: string[];
283
+ headersResponse: Headers;
282
284
  } & {
283
285
  __getPageAssets: () => Promise<import("./getPageAssets.js").PageAsset[]>;
284
286
  } & {
@@ -14,6 +14,7 @@ import { preparePageContextForPublicUsageServer } from './preparePageContextForP
14
14
  import { execHookGuard } from '../../../shared/route/execHookGuard.js';
15
15
  import pc from '@brillout/picocolors';
16
16
  import { isServerSideError } from '../../../shared/misc/isServerSideError.js';
17
+ // TODO/now: rename?
17
18
  async function renderPageAlreadyRouted(pageContext) {
18
19
  // pageContext.pageId can either be the:
19
20
  // - ID of the page matching the routing, or the
@@ -170,6 +170,7 @@ async function renderPageOnError(errNominalPage, pageContextBegin, pageContextNo
170
170
  return handleErrorWithoutErrorPage(pageContextErrorPageInit);
171
171
  }
172
172
  else {
173
+ // TODO/now: minor refactor
173
174
  objectAssign(pageContextErrorPageInit, { pageId: errorPageId });
174
175
  }
175
176
  }
@@ -210,6 +210,10 @@ const configDefinitionsBuiltIn = {
210
210
  env: { server: true },
211
211
  global: true,
212
212
  },
213
+ headersResponse: {
214
+ env: { server: true },
215
+ cumulative: true,
216
+ },
213
217
  };
214
218
  function getConfigEnv(configValueSources, configName) {
215
219
  const configValueSource = getConfigValueSource(configValueSources, configName);
@@ -32,12 +32,10 @@ function getFilesystemRouteString(locationId) {
32
32
  function getInheritanceRoot(locationId) {
33
33
  return getLogicalPath(locationId, [
34
34
  'renderer',
35
- // - Enable hooks defined by vike-{react,vue,solid} such as +onBeforeRenderClient to be defined at the root directory. In other words, avoid following error:
36
- // ```bash
37
- // [11:09:43.072][/test-preview.test.ts][npm run preview][stderr] Error: [vike][Wrong Usage] /+onBeforeRenderClient.ts sets the value of the config onBeforeRenderClient which is a custom config that is defined with https://vike.dev/meta at a path that doesn't apply to / — see https://vike.dev/config#inheritance
38
- // ```
39
- // - Not sure if it's a good idea? Could it make config inheritance confusing? Let's try for now and see how it goes.
40
- // - TO-DO/eventually: update docs https://github.com/vikejs/vike/blob/5fcdc4d5094f1a4dcbefc0b481cdd30a205aef2d/docs/pages/filesystem-routing/%2BPage.mdx?plain=1#L98
35
+ // Enable hooks defined by vike-{react,vue,solid} such as +onBeforeRenderClient to be defined at the root directory. In other words, avoid following error:
36
+ // ```bash
37
+ // [11:09:43.072][/test-preview.test.ts][npm run preview][stderr] Error: [vike][Wrong Usage] /+onBeforeRenderClient.ts sets the value of the config onBeforeRenderClient which is a custom config that is defined with https://vike.dev/meta at a path that doesn't apply to / — see https://vike.dev/config#inheritance
38
+ // ```
41
39
  'pages',
42
40
  ]);
43
41
  }
@@ -9,10 +9,10 @@ import type { GlobalContextServerInternal } from '../node/runtime/globalContext.
9
9
  import type { GlobalContextClientInternal } from '../client/runtime-client-routing/globalContext.js';
10
10
  import { type Hook } from './hooks/getHook.js';
11
11
  declare const getGlobalContextSyncErrMsg = "The global context isn't set yet, call getGlobalContextSync() later or use getGlobalContext() instead.";
12
- declare function createGlobalContextShared<GlobalContextAddendum extends object>(virtualFileExports: unknown, globalObject: {
12
+ declare function createGlobalContextShared<GlobalContextAddendum extends Record<string, any>>(virtualFileExports: unknown, globalObject: {
13
13
  globalContext?: Record<string, unknown>;
14
14
  onCreateGlobalContextHooks?: Hook[];
15
- }, addGlobalContext?: (globalContext: GlobalContextBase) => Promise<GlobalContextAddendum>): Promise<{
15
+ }, addGlobalContextAsync?: (globalContext: GlobalContextBase) => Promise<GlobalContextAddendum>, addGlobalContextSync?: (globalContext: GlobalContextBase) => GlobalContextAddendum): Promise<{
16
16
  /**
17
17
  * Useful for distinguishing `globalContext` from other objects and narrowing down TypeScript unions.
18
18
  *
@@ -35,7 +35,7 @@ declare function createGlobalContextShared<GlobalContextAddendum extends object>
35
35
  pages: {
36
36
  [k: string]: import("./page-configs/resolveVikeConfigPublic.js").VikeConfigPublicPageEager;
37
37
  };
38
- } & Awaited<GlobalContextAddendum>>;
38
+ } & GlobalContextAddendum>;
39
39
  type GlobalContextBasePublic = Pick<GlobalContextBase, 'config' | 'pages' | 'isGlobalContext'>;
40
40
  type GlobalContextBase = ReturnType<typeof createGlobalContextBase>;
41
41
  declare function createGlobalContextBase(virtualFileExports: unknown): {
@@ -7,10 +7,24 @@ import { execHookGlobal } from './hooks/execHook.js';
7
7
  import { prepareGlobalContextForPublicUsage } from './prepareGlobalContextForPublicUsage.js';
8
8
  import { getHookFromPageConfigGlobalCumulative } from './hooks/getHook.js';
9
9
  const getGlobalContextSyncErrMsg = "The global context isn't set yet, call getGlobalContextSync() later or use getGlobalContext() instead.";
10
- async function createGlobalContextShared(virtualFileExports, globalObject, addGlobalContext) {
10
+ async function createGlobalContextShared(virtualFileExports, globalObject, addGlobalContextAsync, addGlobalContextSync) {
11
11
  const globalContext = createGlobalContextBase(virtualFileExports);
12
- const globalContextAddendum = await addGlobalContext?.(globalContext);
13
- objectAssign(globalContext, globalContextAddendum);
12
+ let isNewGlobalContext;
13
+ if (!globalObject.globalContext) {
14
+ globalObject.globalContext = globalContext;
15
+ isNewGlobalContext = false;
16
+ }
17
+ else {
18
+ isNewGlobalContext = true;
19
+ }
20
+ if (addGlobalContextSync && globalContext._pageConfigs.length > 0) {
21
+ const globalContextAddendum = addGlobalContextSync?.(globalContext);
22
+ objectAssign(globalContext, globalContextAddendum);
23
+ }
24
+ else {
25
+ const globalContextAddendum = await addGlobalContextAsync?.(globalContext);
26
+ objectAssign(globalContext, globalContextAddendum);
27
+ }
14
28
  const onCreateGlobalContextHooks = getHookFromPageConfigGlobalCumulative(globalContext._pageConfigGlobal, 'onCreateGlobalContext');
15
29
  let hooksCalled = false;
16
30
  if (!hooksAreEqual(globalObject.onCreateGlobalContextHooks ?? [], onCreateGlobalContextHooks)) {
@@ -18,10 +32,7 @@ async function createGlobalContextShared(virtualFileExports, globalObject, addGl
18
32
  await execHookGlobal('onCreateGlobalContext', globalContext._pageConfigGlobal, null, globalContext, prepareGlobalContextForPublicUsage);
19
33
  hooksCalled = true;
20
34
  }
21
- if (!globalObject.globalContext) {
22
- globalObject.globalContext = globalContext;
23
- }
24
- else {
35
+ if (isNewGlobalContext) {
25
36
  // Singleton: ensure all `globalContext` user-land references are preserved & updated.
26
37
  if (hooksCalled) {
27
38
  objectReplace(globalObject.globalContext, globalContext);
@@ -1,4 +1,5 @@
1
1
  export { loadPageRoutes };
2
+ export { loadPageRoutesSync };
2
3
  export type { PageRoutes };
3
4
  export type { RouteType };
4
5
  import type { PageFile } from '../getPageFiles.js';
@@ -28,3 +29,7 @@ declare function loadPageRoutes(pageFilesAll: PageFile[], pageConfigs: PageConfi
28
29
  pageRoutes: PageRoutes;
29
30
  onBeforeRouteHook: null | Hook;
30
31
  }>;
32
+ declare function loadPageRoutesSync(pageFilesAll: PageFile[], pageConfigs: PageConfigRuntime[], pageConfigGlobal: PageConfigGlobalRuntime, allPageIds: string[]): {
33
+ pageRoutes: PageRoutes;
34
+ onBeforeRouteHook: null | Hook;
35
+ };
@@ -1,4 +1,5 @@
1
1
  export { loadPageRoutes };
2
+ export { loadPageRoutesSync };
2
3
  import { isErrorPageId } from '../error-page.js';
3
4
  import { assert, assertUsage, hasProp, slice } from './utils.js';
4
5
  import { deduceRouteStringFromFilesystemPath } from './deduceRouteStringFromFilesystemPath.js';
@@ -10,8 +11,13 @@ import { getHookFromPageConfigGlobal, getHookTimeoutDefault } from '../hooks/get
10
11
  async function loadPageRoutes(
11
12
  // Remove all arguments and use GlobalContextServerInternal instead?
12
13
  pageFilesAll, pageConfigs, pageConfigGlobal, allPageIds) {
13
- // TO-DO/next-major-release: remove & make this function sync
14
+ // TO-DO/next-major-release: remove this line, remove this function, rename loadPageRoutesSync() to loadPageRoutes()
14
15
  await Promise.all(pageFilesAll.filter((p) => p.fileType === '.page.route').map((p) => p.loadFile?.()));
16
+ return loadPageRoutesSync(pageFilesAll, pageConfigs, pageConfigGlobal, allPageIds);
17
+ }
18
+ function loadPageRoutesSync(
19
+ // Remove all arguments and use GlobalContextServerInternal instead?
20
+ pageFilesAll, pageConfigs, pageConfigGlobal, allPageIds) {
15
21
  const { onBeforeRouteHook, filesystemRoots } = getGlobalHooks(pageFilesAll, pageConfigs, pageConfigGlobal);
16
22
  const pageRoutes = getPageRoutes(filesystemRoots, pageFilesAll, pageConfigs, allPageIds);
17
23
  return { pageRoutes, onBeforeRouteHook };
@@ -508,6 +508,12 @@ type ConfigBuiltIn = {
508
508
  * https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control
509
509
  */
510
510
  cacheControl?: string;
511
+ /**
512
+ * Add HTTP headers to the HTTP response.
513
+ *
514
+ * https://vike.dev/headers#response
515
+ */
516
+ headersResponse?: HeadersInit;
511
517
  /**
512
518
  * Make development/preview server available over LAN and public addresses.
513
519
  *
@@ -561,6 +567,7 @@ type ConfigBuiltInResolved = {
561
567
  redirects?: Record<string, string>[];
562
568
  prerender?: Exclude<Config['prerender'], ImportString | undefined>[];
563
569
  middleware?: Function[];
570
+ headersResponse?: HeadersInit[];
564
571
  };
565
572
  type ConfigMeta = Record<string, ConfigDefinition>;
566
573
  type ImportString = `import:${string}`;
@@ -81,7 +81,7 @@ type PageContextBuiltInCommon<Data> = {
81
81
  */
82
82
  urlOriginal: string;
83
83
  /**
84
- * The HTTP Headers of the incoming HTTP Request.
84
+ * The HTTP request headers.
85
85
  *
86
86
  * As a string object normalized by Vike.
87
87
  *
@@ -90,7 +90,7 @@ type PageContextBuiltInCommon<Data> = {
90
90
  */
91
91
  headers: Record<string, string> | null;
92
92
  /**
93
- * The HTTP Headers of the incoming HTTP Request.
93
+ * The HTTP request headers.
94
94
  *
95
95
  * The original object provided by the server.
96
96
  *
@@ -98,6 +98,12 @@ type PageContextBuiltInCommon<Data> = {
98
98
  * https://vike.dev/pageContext#headersOriginal
99
99
  */
100
100
  headersOriginal?: unknown;
101
+ /**
102
+ * The HTTP response headers.
103
+ *
104
+ * https://vike.dev/headers#response
105
+ */
106
+ headersResponse: Headers;
101
107
  /** If an error occurs, whether the error is a `404 Page Not Found`.
102
108
  *
103
109
  * https://vike.dev/error-page
@@ -1 +1 @@
1
- export declare const PROJECT_VERSION: "0.4.235-commit-7b1ab35";
1
+ export declare const PROJECT_VERSION: "0.4.235-commit-9b9289b";
@@ -1,2 +1,2 @@
1
1
  // Automatically updated by @brillout/release-me
2
- export const PROJECT_VERSION = '0.4.235-commit-7b1ab35';
2
+ export const PROJECT_VERSION = '0.4.235-commit-9b9289b';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "vike",
3
- "version": "0.4.235-commit-7b1ab35",
3
+ "version": "0.4.235-commit-9b9289b",
4
4
  "repository": "https://github.com/vikejs/vike",
5
5
  "exports": {
6
6
  "./server": {
@@ -120,7 +120,7 @@
120
120
  },
121
121
  "dependencies": {
122
122
  "@brillout/import": "^0.2.6",
123
- "@brillout/json-serializer": "^0.5.15",
123
+ "@brillout/json-serializer": "^0.5.16",
124
124
  "@brillout/picocolors": "^1.0.26",
125
125
  "@brillout/require-shim": "^0.1.2",
126
126
  "@brillout/vite-plugin-server-entry": "^0.7.8",