vike 0.4.266 → 0.4.267-commit-7884d91

package/dist/client/runtime-client-routing/createPageContextClient.d.ts

@@ -39,6 +39,10 @@ declare function createPageContextClient(urlOriginal: string): Promise<{
         _pageFilesAll: import("../../shared-server-client/getPageFiles.js").PageFile[];
         _pageConfigs: import("../../types/PageConfig.js").PageConfigRuntime[];
         _pageConfigGlobal: import("../../types/PageConfig.js").PageConfigGlobalRuntime;
+        _environmentEntries: Record<string, {
+            pageConfigs: import("../../types/PageConfig.js").PageConfigRuntime[];
+            pageConfigGlobal: import("../../types/PageConfig.js").PageConfigGlobalRuntime;
+        } | null>;
         _allPageIds: string[];
     } & {
         isClientSide: true;

package/dist/client/runtime-client-routing/getGlobalContextClientInternal.d.ts

@@ -25,6 +25,10 @@ declare function getGlobalContextClientInternal(): Promise<{
     _pageFilesAll: import("../../shared-server-client/getPageFiles.js").PageFile[];
     _pageConfigs: import("../../types/PageConfig.js").PageConfigRuntime[];
     _pageConfigGlobal: import("../../types/PageConfig.js").PageConfigGlobalRuntime;
+    _environmentEntries: Record<string, {
+        pageConfigs: import("../../types/PageConfig.js").PageConfigRuntime[];
+        pageConfigGlobal: import("../../types/PageConfig.js").PageConfigGlobalRuntime;
+    } | null>;
     _allPageIds: string[];
 } & {
     isClientSide: true;

package/dist/client/runtime-client-routing/getPageContextFromHooks.d.ts

@@ -13,10 +13,10 @@ type PageContextSerialized = {
     pageId: string;
     _hasPageContextFromServer: true;
 };
-declare function getPageContextFromHooksServer_firstRender(): PageContextSerialized & {
+declare function getPageContextFromHooksServer_firstRender(): Promise<PageContextSerialized & {
     routeParams: Record<string, string>;
     _hasPageContextFromServer: true;
-};
+}>;
 declare function getPageContextFromHooksClient_firstRender(pageContext: PageContextSerialized & PageContextBegin & PageContextConfig & {
     _hasPageContextFromServer: true;
 } & PageContextPublicClient): Promise<((PageContextSerialized & ({
@@ -57,6 +57,10 @@ declare function getPageContextFromHooksClient_firstRender(pageContext: PageCont
         _pageFilesAll: PageFile[];
         _pageConfigs: import("../../types/PageConfig.js").PageConfigRuntime[];
         _pageConfigGlobal: import("../../types/PageConfig.js").PageConfigGlobalRuntime;
+        _environmentEntries: Record<string, {
+            pageConfigs: import("../../types/PageConfig.js").PageConfigRuntime[];
+            pageConfigGlobal: import("../../types/PageConfig.js").PageConfigGlobalRuntime;
+        } | null>;
         _allPageIds: string[];
     } & {
         isClientSide: true;
@@ -113,6 +117,10 @@ declare function getPageContextFromHooksClient_firstRender(pageContext: PageCont
             _pageFilesAll: PageFile[];
             _pageConfigs: import("../../types/PageConfig.js").PageConfigRuntime[];
             _pageConfigGlobal: import("../../types/PageConfig.js").PageConfigGlobalRuntime;
+            _environmentEntries: Record<string, {
+                pageConfigs: import("../../types/PageConfig.js").PageConfigRuntime[];
+                pageConfigGlobal: import("../../types/PageConfig.js").PageConfigGlobalRuntime;
+            } | null>;
             _allPageIds: string[];
         } & {
             isClientSide: true;
@@ -180,6 +188,8 @@ declare function getPageContextFromHooksClient_firstRender(pageContext: PageCont
         } | null;
     } & {
         urlOriginal: string;
+    } & {
+        Page: unknown;
     }) | null;
     pageContextsAborted: import("../../shared-server-client/route/abort.js").PageContextAborted[];
 } & (import("../../shared-server-client/route/abort.js").PageContextAbort | null))) & PageContextConfig & {
@@ -299,6 +309,10 @@ declare function getPageContextFromHooksClient(pageContext: {
         _pageFilesAll: PageFile[];
         _pageConfigs: import("../../types/PageConfig.js").PageConfigRuntime[];
         _pageConfigGlobal: import("../../types/PageConfig.js").PageConfigGlobalRuntime;
+        _environmentEntries: Record<string, {
+            pageConfigs: import("../../types/PageConfig.js").PageConfigRuntime[];
+            pageConfigGlobal: import("../../types/PageConfig.js").PageConfigGlobalRuntime;
+        } | null>;
         _allPageIds: string[];
     } & {
         isClientSide: true;
@@ -355,6 +369,10 @@ declare function getPageContextFromHooksClient(pageContext: {
             _pageFilesAll: PageFile[];
             _pageConfigs: import("../../types/PageConfig.js").PageConfigRuntime[];
             _pageConfigGlobal: import("../../types/PageConfig.js").PageConfigGlobalRuntime;
+            _environmentEntries: Record<string, {
+                pageConfigs: import("../../types/PageConfig.js").PageConfigRuntime[];
+                pageConfigGlobal: import("../../types/PageConfig.js").PageConfigGlobalRuntime;
+            } | null>;
             _allPageIds: string[];
         } & {
             isClientSide: true;
@@ -422,6 +440,8 @@ declare function getPageContextFromHooksClient(pageContext: {
         } | null;
     } & {
         urlOriginal: string;
+    } & {
+        Page: unknown;
     }) | null;
     pageContextsAborted: import("../../shared-server-client/route/abort.js").PageContextAborted[];
 } & (import("../../shared-server-client/route/abort.js").PageContextAbort | null)) & PageContextConfig)) & import("../../shared-server-client/createPageContextShared.js").PageContextCreated & Omit<Partial<PageContextConfig & {

package/dist/client/runtime-client-routing/getPageContextFromHooks.js

@@ -9,8 +9,8 @@ import { hasProp } from '../../utils/hasProp.js';
 import { isObject } from '../../utils/isObject.js';
 import { objectAssign } from '../../utils/objectAssign.js';
 import { redirectHard } from '../../utils/redirectHard.js';
-import { parse } from '@brillout/json-serializer/parse';
 import { getPageContextSerializedInHtml } from '../shared/getJsonSerializedInHtml.js';
+import { readPageContextJson } from './streamedValues.js';
 import { analyzePageServerSide } from '../../shared-server-client/getPageFiles/analyzePageServerSide.js';
 import { removeBuiltInOverrides } from './getPageContext/removeBuiltInOverrides.js';
 import { getPageContextRequestUrl } from '../../shared-server-client/getPageContextRequestUrl.js';
@@ -30,8 +30,8 @@ const globalObject = getGlobalObject('getPageContextFromHooks.ts', {});
 //   - Possible implementation: new computed prop `clientOnlyHooks: string[]` (list of hook ids) and add `hookId` to serialized config values
 const clientHooks = ['guard', 'data', 'onBeforeRender'];
 // Get `pageContext` values from `<script id="vike_pageContext" type="application/json">`
-function getPageContextFromHooksServer_firstRender() {
-    const pageContextSerialized = getPageContextSerializedInHtml();
+async function getPageContextFromHooksServer_firstRender() {
+    const pageContextSerialized = await getPageContextSerializedInHtml();
     processPageContextFromServer(pageContextSerialized);
     objectAssign(pageContextSerialized, {
         _hasPageContextFromServer: true,
@@ -210,8 +210,7 @@ async function fetchPageContextFromServer(pageContext) {
         }
         assertUsage(isCorrect, `Wrong Content-Type for ${pageContextUrl}: it should be ${contentTypeCorrect} but it's ${contentType} instead. Make sure to properly use pageContext.httpResponse.headers, see https://vike.dev/renderPage`);
     }
-    const responseText = await response.text();
-    const pageContextFromServer = parse(responseText);
+    const pageContextFromServer = await readPageContextJson(response);
     assert(isObject(pageContextFromServer));
     if (isAbortPageContext(pageContextFromServer)) {
         throw AbortRender(pageContextFromServer);

package/dist/client/runtime-client-routing/history.d.ts

@@ -1,11 +1,28 @@
-export { pushHistoryState };
-export { replaceHistoryStateOriginal };
+export { changeUrl };
 export { onPopStateBegin };
 export { saveScrollPosition };
 export { initHistory };
+export { historyApiReplaceStateOriginal };
 export type { HistoryInfo };
 export type { ScrollPosition };
 import '../assertEnvClient.js';
+declare function changeUrl(url: string, overwriteLastHistoryEntry: boolean): void;
+declare function historyApiReplaceStateOriginal(state: unknown, url?: Parameters<typeof window.history.replaceState>[2]): void;
+declare function onPopStateBegin(): {
+    skip: true;
+    previous?: undefined;
+    current?: undefined;
+} | {
+    skip?: undefined;
+    previous: HistoryInfo;
+    current: HistoryInfo;
+};
+type ScrollPosition = {
+    x: number;
+    y: number;
+};
+declare function saveScrollPosition(scrollPosition?: ScrollPosition): void;
+declare function initHistory(): void;
 type StateEnhanced = {
     vike: {
         timestamp: number;
@@ -13,24 +30,7 @@ type StateEnhanced = {
         triggeredBy: 'user' | 'vike' | 'browser';
     };
 };
-type ScrollPosition = {
-    x: number;
-    y: number;
-};
-declare function saveScrollPosition(scrollPosition?: ScrollPosition): void;
-declare function pushHistoryState(url: string, overwriteLastHistoryEntry: boolean): void;
-declare function replaceHistoryStateOriginal(state: unknown, url?: Parameters<typeof window.history.replaceState>[2]): void;
 type HistoryInfo = {
     url: `/${string}`;
     state: StateEnhanced;
 };
-declare function onPopStateBegin(): {
-    skip: true;
-    previous?: undefined;
-    current?: undefined;
-} | {
-    skip?: undefined;
-    previous: HistoryInfo;
-    current: HistoryInfo;
-};
-declare function initHistory(): void;

package/dist/client/runtime-client-routing/history.js

@@ -1,8 +1,8 @@
-export { pushHistoryState };
-export { replaceHistoryStateOriginal };
+export { changeUrl };
 export { onPopStateBegin };
 export { saveScrollPosition };
 export { initHistory };
+export { historyApiReplaceStateOriginal };
 import { getCurrentUrl } from '../shared/getCurrentUrl.js';
 import { assert, assertUsage } from '../../utils/assert.js';
 import { getGlobalObject } from '../../utils/getGlobalObject.js';
@@ -15,49 +15,9 @@ const globalObject = getGlobalObject('history.ts', {
 });
 initHistory(); // we redundantly call initHistory() to ensure it's called early
 globalObject.previous = getHistoryInfo();
-// `window.history.state === null` when:
-// - The very first render
-// - Click on `<a href="#some-hash" />`
-// - `location.hash = 'some-hash'`
-function enhance() {
-    if (isEnhanced(window.history.state))
-        return;
-    const stateEnhanced = {
-        vike: {
-            timestamp: getTimestamp(),
-            scrollPosition: getScrollPosition(),
-            triggeredBy: 'browser',
-        },
-    };
-    replaceHistoryState(stateEnhanced);
-}
-function getState() {
-    const state = window.history.state;
-    // *Every* state added to the history needs to go through Vike.
-    // - Otherwise Vike's `popstate` listener won't work. (Because, for example, if globalObject.previous is outdated => isHashNavigation faulty => client-side navigation is wrongfully skipped.)
-    // - Therefore, we have to monkey patch history.pushState() and history.replaceState()
-    // - Therefore, we need the assert() below to ensure history.state has been enhanced by Vike
-    //   - If users stumble upon this assert() then let's make it a assertUsage()
-    assertIsEnhanced(state);
-    return state;
-}
-function getScrollPosition() {
-    const scrollPosition = { x: window.scrollX, y: window.scrollY };
-    return scrollPosition;
-}
-function getTimestamp() {
-    return new Date().getTime();
-}
-function saveScrollPosition(scrollPosition) {
-    scrollPosition || (scrollPosition = getScrollPosition());
-    // Don't overwrite history.state if it was set by a non-Vike history.pushState() call.
-    // https://github.com/vikejs/vike/issues/2801#issuecomment-3490431479
-    if (!isEnhanced(window.history.state))
+function changeUrl(url, overwriteLastHistoryEntry) {
+    if (getCurrentUrl() === url)
         return;
-    const state = getState();
-    replaceHistoryState({ ...state, vike: { ...state.vike, scrollPosition } });
-}
-function pushHistoryState(url, overwriteLastHistoryEntry) {
     if (!overwriteLastHistoryEntry) {
         const state = {
             vike: {
@@ -67,24 +27,68 @@ function pushHistoryState(url, overwriteLastHistoryEntry) {
                 triggeredBy: 'vike',
             },
         };
-        // Calling the monkey patched history.pushState() (and not the original) so that other tools (e.g. user tracking) can listen to Vike's pushState() calls.
-        // - https://github.com/vikejs/vike/issues/1582
-        window.history.pushState(state, '', url);
+        historyApiPushState(state, url);
     }
     else {
-        replaceHistoryState(getState(), url);
+        historyApiReplaceState(getState(), url);
     }
 }
-function replaceHistoryState(state, url) {
+function historyApiPushState(state, url) {
+    // Calling the monkey patched history.pushState() (not the original) so that other tools (e.g. user tracking) can listen to Vike's pushState() calls.
+    // - https://github.com/vikejs/vike/issues/1582
+    window.history.pushState(state, '', url);
+    assertIsEnhanced(window.history.state);
+}
+function historyApiReplaceState(state, url) {
     const url_ = url ?? null; // Passing `undefined` chokes older Edge versions.
     window.history.replaceState(state, '', url_);
     assertIsEnhanced(window.history.state);
 }
-function replaceHistoryStateOriginal(state, url) {
+function historyApiReplaceStateOriginal(state, url) {
     // Bypass all monkey patches.
     // - Useful, for example, to avoid other tools listening to history.replaceState() calls
     History.prototype.replaceState.bind(window.history)(state, '', url);
 }
+function onPopStateBegin() {
+    const { previous } = globalObject;
+    const isStateEnhanced = isEnhanced(window.history.state);
+    // Either:
+    // - `window.history.pushState(null, '', '/some-path')` , or
+    // - hash navigation
+    //   - Click on `<a href="#some-hash">`
+    //   - Using the `location` API (only hash navigation)
+    // See comments a the top of the ./initOnPopState.ts file.
+    const isStatePristine = window.history.state === null;
+    if (!isStateEnhanced && !isStatePristine) {
+        // Going to a history entry not created by Vike — entering another "SPA realm" => hard reload
+        // https://github.com/vikejs/vike/issues/2801#issuecomment-3490431479
+        redirectHard(getCurrentUrl());
+        return { skip: true };
+    }
+    if (!isStateEnhanced)
+        enhanceState();
+    const current = getHistoryInfo();
+    globalObject.previous = current;
+    // Let the browser handle hash navigations.
+    // - Upon hash navigation: `isHistoryStatePristine===true` (see comment above).
+    if (isStatePristine) {
+        return { skip: true };
+    }
+    return { previous, current };
+}
+function saveScrollPosition(scrollPosition) {
+    scrollPosition || (scrollPosition = getScrollPosition());
+    // Don't overwrite history.state if it was set by a non-Vike history.pushState() call.
+    // https://github.com/vikejs/vike/issues/2801#issuecomment-3490431479
+    if (!isEnhanced(window.history.state))
+        return;
+    const state = getState();
+    historyApiReplaceState({ ...state, vike: { ...state.vike, scrollPosition } });
+}
+function initHistory() {
+    monkeyPatchHistoryAPI(); // the earlier we call it the better (Vike can workaround erroneous library monkey patches if Vike is the last one in the monkey patch chain)
+    enhanceState(); // enhance very first window.history.state which is `null`
+}
 // Monkey patch:
 // - history.pushState()
 // - history.replaceState()
@@ -114,11 +118,26 @@ function monkeyPatchHistoryAPI() {
                 if (isEnhanced(window.history.state))
                     return;
                 Object.assign(state, window.history.state);
-                replaceHistoryStateOriginal(state);
+                historyApiReplaceStateOriginal(state);
             });
         };
     });
 }
+function getState() {
+    const state = window.history.state;
+    // *Every* state added to the history needs to go through Vike.
+    // - Otherwise Vike's `popstate` listener won't work. (Because, for example, if globalObject.previous is outdated => isHashNavigation faulty => client-side navigation is wrongfully skipped.)
+    // - Therefore, we have to monkey patch history.pushState() and history.replaceState()
+    // - Therefore, we need the assert() below to ensure history.state has been enhanced by Vike
+    //   - If users stumble upon this assert() then let's make it a assertUsage()
+    assertIsEnhanced(state);
+    return state;
+}
+function assertIsEnhanced(state) {
+    if (isEnhanced(state))
+        return;
+    assert(false, { state });
+}
 function isEnhanced(state) {
     if (state?.vike) {
         /* We don't use the assert() below to save client-side KBs.
@@ -135,10 +154,21 @@ function isEnhanced(state) {
     }
     return false;
 }
-function assertIsEnhanced(state) {
-    if (isEnhanced(state))
+// `window.history.state === null` when:
+// - The very first render
+// - Click on `<a href="#some-hash" />`
+// - `location.hash = 'some-hash'`
+function enhanceState() {
+    if (isEnhanced(window.history.state))
         return;
-    assert(false, { state });
+    const stateEnhanced = {
+        vike: {
+            timestamp: getTimestamp(),
+            scrollPosition: getScrollPosition(),
+            triggeredBy: 'browser',
+        },
+    };
+    historyApiReplaceState(stateEnhanced);
 }
 function getHistoryInfo() {
     return {
@@ -146,34 +176,10 @@ function getHistoryInfo() {
         state: getState(),
     };
 }
-function onPopStateBegin() {
-    const { previous } = globalObject;
-    const isStateEnhanced = isEnhanced(window.history.state);
-    // Either:
-    // - `window.history.pushState(null, '', '/some-path')` , or
-    // - hash navigation
-    //   - Click on `<a href="#some-hash">`
-    //   - Using the `location` API (only hash navigation)
-    // See comments a the top of the ./initOnPopState.ts file.
-    const isStatePristine = window.history.state === null;
-    if (!isStateEnhanced && !isStatePristine) {
-        // Going to a history entry not created by Vike — entering another "SPA realm" => hard reload
-        // https://github.com/vikejs/vike/issues/2801#issuecomment-3490431479
-        redirectHard(getCurrentUrl());
-        return { skip: true };
-    }
-    if (!isStateEnhanced)
-        enhance();
-    const current = getHistoryInfo();
-    globalObject.previous = current;
-    // Let the browser handle hash navigations.
-    // - Upon hash navigation: `isHistoryStatePristine===true` (see comment above).
-    if (isStatePristine) {
-        return { skip: true };
-    }
-    return { previous, current };
+function getScrollPosition() {
+    const scrollPosition = { x: window.scrollX, y: window.scrollY };
+    return scrollPosition;
 }
-function initHistory() {
-    monkeyPatchHistoryAPI(); // the earlier we call it the better (Vike can workaround erroneous library monkey patches if Vike is the last one in the monkey patch chain)
-    enhance(); // enhance very first window.history.state which is `null`
+function getTimestamp() {
+    return new Date().getTime();
 }