vike 0.4.228-commit-84954ae → 0.4.228-commit-1bb55f1

package/dist/esm/node/runtime/renderPage/createPageContextServerSide.d.ts

@@ -1,10 +1,10 @@
 export { createPageContextServerSide };
 export { createPageContextServerSideWithoutGlobalContext };
 export type { PageContextCreatedServerSide };
-import type { GlobalContextInternal, GlobalContextServer } from '../globalContext.js';
+import type { GlobalContextServerInternal, GlobalContextServer } from '../globalContext.js';
 import type { PageContextInit } from '../renderPage.js';
 type PageContextCreatedServerSide = Awaited<ReturnType<typeof createPageContextServerSide>>;
-declare function createPageContextServerSide(pageContextInit: PageContextInit, globalContext: GlobalContextInternal, globalObject_public: GlobalContextServer, { isPrerendering, ssr: { urlHandler, isClientSideNavigation } }: {
+declare function createPageContextServerSide(pageContextInit: PageContextInit, globalContext: GlobalContextServerInternal, globalObject_public: GlobalContextServer, { isPrerendering, ssr: { urlHandler, isClientSideNavigation } }: {
     isPrerendering: false;
     ssr: {
         urlHandler: null | ((url: string) => string);
@@ -22,6 +22,7 @@ declare function createPageContextServerSide(pageContextInit: PageContextInit, g
 } & {
     globalContext: GlobalContextServer;
     _globalContext: {
+        isGlobalContext: true;
         _virtualFileExports: unknown;
         _pageFilesAll: import("../../../shared/getPageFiles.js").PageFile[];
         _pageConfigs: import("../../../__internal/index.js").PageConfig[];
@@ -47,8 +48,10 @@ declare function createPageContextServerSide(pageContextInit: PageContextInit, g
         };
         baseServer: string;
         baseAssets: string;
+        isClientSide: false;
         _pageRoutes: import("../../../__internal/index.js").PageRoutes;
         _onBeforeRouteHook: import("../../../shared/hooks/getHook.js").Hook | null;
+        isGlobalContext: true;
         _virtualFileExports: unknown;
         _pageFilesAll: import("../../../shared/getPageFiles.js").PageFile[];
         _pageConfigs: import("../../../__internal/index.js").PageConfig[];
@@ -75,8 +78,10 @@ declare function createPageContextServerSide(pageContextInit: PageContextInit, g
         _usesClientRouter: boolean;
         baseServer: string;
         baseAssets: string;
+        isClientSide: false;
         _pageRoutes: import("../../../__internal/index.js").PageRoutes;
         _onBeforeRouteHook: import("../../../shared/hooks/getHook.js").Hook | null;
+        isGlobalContext: true;
         _virtualFileExports: unknown;
         _pageFilesAll: import("../../../shared/getPageFiles.js").PageFile[];
         _pageConfigs: import("../../../__internal/index.js").PageConfig[];
@@ -103,8 +108,10 @@ declare function createPageContextServerSide(pageContextInit: PageContextInit, g
         _usesClientRouter: boolean;
         baseServer: string;
         baseAssets: string;
+        isClientSide: false;
         _pageRoutes: import("../../../__internal/index.js").PageRoutes;
         _onBeforeRouteHook: import("../../../shared/hooks/getHook.js").Hook | null;
+        isGlobalContext: true;
         _virtualFileExports: unknown;
         _pageFilesAll: import("../../../shared/getPageFiles.js").PageFile[];
         _pageConfigs: import("../../../__internal/index.js").PageConfig[];
@@ -137,7 +144,7 @@ declare function createPageContextServerSide(pageContextInit: PageContextInit, g
     _source: import("../../../shared/page-configs/getPageConfigUserFriendly.js").Source;
     _sources: import("../../../shared/page-configs/getPageConfigUserFriendly.js").Sources;
     _from: import("../../../shared/page-configs/getPageConfigUserFriendly.js").From;
-    _isPageContextObject: boolean;
+    isPageContext: true;
 }>;
 declare function createPageContextServerSideWithoutGlobalContext(pageContextInit: PageContextInit): {
     isClientSide: boolean;

package/dist/esm/node/runtime/renderPage/getPageAssets.d.ts

@@ -5,7 +5,7 @@ export type { GetPageAssets };
 export type { PageContextGetPageAssets };
 import { type MediaType } from './inferMediaType.js';
 import type { ClientDependency } from '../../../shared/getPageFiles/analyzePageClientSide/ClientDependency.js';
-import type { GlobalContextInternal } from '../globalContext.js';
+import type { GlobalContextServerInternal } from '../globalContext.js';
 import type { ResolveClientEntriesDev } from '../../plugin/shared/resolveClientEntriesDev.js';
 type PageAsset = {
     src: string;
@@ -18,7 +18,7 @@ type PageContextGetPageAssets = {
     _baseServer: string;
     _baseAssets: string | null;
     _includeAssetsImportedByServer: boolean;
-    _globalContext: GlobalContextInternal;
+    _globalContext: GlobalContextServerInternal;
 };
 declare function getPageAssets(pageContext: PageContextGetPageAssets, clientDependencies: ClientDependency[], clientEntries: string[]): Promise<PageAsset[]>;
 declare function setResolveClientEntriesDev(resolveClientEntriesDev: ResolveClientEntriesDev): void;

package/dist/esm/node/runtime/renderPage/handleErrorWithoutErrorPage.d.ts

@@ -1,5 +1,5 @@
 export { handleErrorWithoutErrorPage };
-import type { GlobalContextInternal } from '../globalContext.js';
+import type { GlobalContextServerInternal } from '../globalContext.js';
 import type { PageContextAfterRender } from './renderPageAlreadyRouted.js';
 import type { PageConfigRuntime } from '../../../shared/page-configs/PageConfig.js';
 import type { PageFile } from '../../../shared/getPageFiles.js';
@@ -10,6 +10,6 @@ declare function handleErrorWithoutErrorPage<PageContext extends {
     pageId: null;
     _pageFilesAll: PageFile[];
     _pageConfigs: PageConfigRuntime[];
-    _globalContext: GlobalContextInternal;
+    _globalContext: GlobalContextServerInternal;
     urlOriginal: string;
 }>(pageContext: PageContext): Promise<PageContext & PageContextAfterRender>;

package/dist/esm/node/runtime/renderPage/loadUserFilesServerSide.d.ts

@@ -6,12 +6,12 @@ import { PromiseType } from '../utils.js';
 import { PageContextGetPageAssets, type PageAsset } from './getPageAssets.js';
 import { type PageContextDebugRouteMatches } from './debugPageFiles.js';
 import type { PageConfigRuntime } from '../../../shared/page-configs/PageConfig.js';
-import type { GlobalContextInternal } from '../globalContext.js';
+import type { GlobalContextServerInternal } from '../globalContext.js';
 type PageContext_loadUserFilesServerSide = PageContextGetPageAssets & PageContextDebugRouteMatches & {
     urlOriginal: string;
     _pageFilesAll: PageFile[];
     _pageConfigs: PageConfigRuntime[];
-    _globalContext: GlobalContextInternal;
+    _globalContext: GlobalContextServerInternal;
 };
 type PageFiles = PromiseType<ReturnType<typeof loadUserFilesServerSide>>;
 declare function loadUserFilesServerSide(pageContext: {

package/dist/esm/node/runtime/renderPage/log404/index.d.ts

@@ -1,12 +1,12 @@
 export { log404 };
 export { getRoutesInfo };
 import type { PageRoutes } from '../../../../shared/route/index.js';
-import type { GlobalContextInternal } from '../../globalContext.js';
+import type { GlobalContextServerInternal } from '../../globalContext.js';
 declare function log404(pageContext: {
     urlPathname: string;
     errorWhileRendering: null | Error;
     isClientSideNavigation: boolean;
     _pageRoutes: PageRoutes;
-    _globalContext: GlobalContextInternal;
+    _globalContext: GlobalContextServerInternal;
 }): Promise<void>;
 declare function getRoutesInfo(pageRoutes: PageRoutes): string | null;

package/dist/esm/node/runtime/renderPage/preparePageContextForUserConsumptionServerSide.d.ts

@@ -4,7 +4,7 @@ import { PageContextUrlInternal } from '../../../shared/getPageContextUrlCompute
 import type { PageConfigRuntime } from '../../../shared/page-configs/PageConfig.js';
 import type { PageConfigUserFriendlyOld } from '../../../shared/page-configs/getPageConfigUserFriendly.js';
 import { PageContextBuiltInServerInternal } from '../../../shared/types.js';
-import type { GlobalContextInternal, GlobalContextServer } from '../globalContext.js';
+import type { GlobalContextServerInternal, GlobalContextServer } from '../globalContext.js';
 type PageContextForUserConsumptionServerSide = PageContextBuiltInServerInternal & PageConfigUserFriendlyOld & {
     urlOriginal: string;
     /** @deprecated */
@@ -18,7 +18,7 @@ type PageContextForUserConsumptionServerSide = PageContextBuiltInServerInternal
     is404: null | boolean;
     isClientSideNavigation: boolean;
     pageProps?: Record<string, unknown>;
-    _globalContext: GlobalContextInternal;
+    _globalContext: GlobalContextServerInternal;
     globalContext: GlobalContextServer;
 } & Record<string, unknown>;
 declare function preparePageContextForUserConsumptionServerSide(pageContext: PageContextForUserConsumptionServerSide): void;

package/dist/esm/node/runtime/renderPage/preparePageContextForUserConsumptionServerSide.js

@@ -7,7 +7,7 @@ function preparePageContextForUserConsumptionServerSide(pageContext) {
     assert(isPlainObject(pageContext.routeParams));
     assert('Page' in pageContext);
     assert(typeof pageContext.isClientSideNavigation === 'boolean');
-    assert(pageContext._isPageContextObject);
+    assert(pageContext.isPageContext);
     assert(pageContext.isClientSide === false);
     assert(typeof pageContext.isPrerendering === 'boolean');
     preparePageContextForUserConsumption(pageContext);

package/dist/esm/node/runtime/renderPage/renderPageAlreadyRouted.d.ts

@@ -37,6 +37,7 @@ declare function prerenderPage(pageContext: PageContextCreatedServerSide & PageF
     } & {
         globalContext: import("../globalContext.js").GlobalContextServer;
         _globalContext: {
+            isGlobalContext: true;
             _virtualFileExports: unknown;
             _pageFilesAll: import("../../../shared/getPageFiles.js").PageFile[];
             _pageConfigs: import("../../../__internal/index.js").PageConfig[];
@@ -62,8 +63,10 @@ declare function prerenderPage(pageContext: PageContextCreatedServerSide & PageF
             };
             baseServer: string;
             baseAssets: string;
+            isClientSide: false;
             _pageRoutes: import("../../../__internal/index.js").PageRoutes;
             _onBeforeRouteHook: import("../../../shared/hooks/getHook.js").Hook | null;
+            isGlobalContext: true;
             _virtualFileExports: unknown;
             _pageFilesAll: import("../../../shared/getPageFiles.js").PageFile[];
             _pageConfigs: import("../../../__internal/index.js").PageConfig[];
@@ -90,8 +93,10 @@ declare function prerenderPage(pageContext: PageContextCreatedServerSide & PageF
             _usesClientRouter: boolean;
             baseServer: string;
             baseAssets: string;
+            isClientSide: false;
             _pageRoutes: import("../../../__internal/index.js").PageRoutes;
             _onBeforeRouteHook: import("../../../shared/hooks/getHook.js").Hook | null;
+            isGlobalContext: true;
             _virtualFileExports: unknown;
             _pageFilesAll: import("../../../shared/getPageFiles.js").PageFile[];
             _pageConfigs: import("../../../__internal/index.js").PageConfig[];
@@ -118,8 +123,10 @@ declare function prerenderPage(pageContext: PageContextCreatedServerSide & PageF
             _usesClientRouter: boolean;
             baseServer: string;
             baseAssets: string;
+            isClientSide: false;
             _pageRoutes: import("../../../__internal/index.js").PageRoutes;
             _onBeforeRouteHook: import("../../../shared/hooks/getHook.js").Hook | null;
+            isGlobalContext: true;
             _virtualFileExports: unknown;
             _pageFilesAll: import("../../../shared/getPageFiles.js").PageFile[];
             _pageConfigs: import("../../../__internal/index.js").PageConfig[];
@@ -152,7 +159,7 @@ declare function prerenderPage(pageContext: PageContextCreatedServerSide & PageF
         _source: import("../../../shared/page-configs/getPageConfigUserFriendly.js").Source;
         _sources: import("../../../shared/page-configs/getPageConfigUserFriendly.js").Sources;
         _from: import("../../../shared/page-configs/getPageConfigUserFriendly.js").From;
-        _isPageContextObject: boolean;
+        isPageContext: true;
     } & import("../../../shared/getPageFiles.js").PageConfigUserFriendlyOld & {
         Page: unknown;
         _isHtmlOnly: boolean;
@@ -184,6 +191,7 @@ declare function prerenderPage(pageContext: PageContextCreatedServerSide & PageF
     } & {
         globalContext: import("../globalContext.js").GlobalContextServer;
         _globalContext: {
+            isGlobalContext: true;
             _virtualFileExports: unknown;
             _pageFilesAll: import("../../../shared/getPageFiles.js").PageFile[];
             _pageConfigs: import("../../../__internal/index.js").PageConfig[];
@@ -209,8 +217,10 @@ declare function prerenderPage(pageContext: PageContextCreatedServerSide & PageF
             };
             baseServer: string;
             baseAssets: string;
+            isClientSide: false;
             _pageRoutes: import("../../../__internal/index.js").PageRoutes;
             _onBeforeRouteHook: import("../../../shared/hooks/getHook.js").Hook | null;
+            isGlobalContext: true;
             _virtualFileExports: unknown;
             _pageFilesAll: import("../../../shared/getPageFiles.js").PageFile[];
             _pageConfigs: import("../../../__internal/index.js").PageConfig[];
@@ -237,8 +247,10 @@ declare function prerenderPage(pageContext: PageContextCreatedServerSide & PageF
             _usesClientRouter: boolean;
             baseServer: string;
             baseAssets: string;
+            isClientSide: false;
             _pageRoutes: import("../../../__internal/index.js").PageRoutes;
             _onBeforeRouteHook: import("../../../shared/hooks/getHook.js").Hook | null;
+            isGlobalContext: true;
             _virtualFileExports: unknown;
             _pageFilesAll: import("../../../shared/getPageFiles.js").PageFile[];
             _pageConfigs: import("../../../__internal/index.js").PageConfig[];
@@ -265,8 +277,10 @@ declare function prerenderPage(pageContext: PageContextCreatedServerSide & PageF
             _usesClientRouter: boolean;
             baseServer: string;
             baseAssets: string;
+            isClientSide: false;
             _pageRoutes: import("../../../__internal/index.js").PageRoutes;
             _onBeforeRouteHook: import("../../../shared/hooks/getHook.js").Hook | null;
+            isGlobalContext: true;
             _virtualFileExports: unknown;
             _pageFilesAll: import("../../../shared/getPageFiles.js").PageFile[];
             _pageConfigs: import("../../../__internal/index.js").PageConfig[];
@@ -299,7 +313,7 @@ declare function prerenderPage(pageContext: PageContextCreatedServerSide & PageF
         _source: import("../../../shared/page-configs/getPageConfigUserFriendly.js").Source;
         _sources: import("../../../shared/page-configs/getPageConfigUserFriendly.js").Sources;
         _from: import("../../../shared/page-configs/getPageConfigUserFriendly.js").From;
-        _isPageContextObject: boolean;
+        isPageContext: true;
     } & import("../../../shared/getPageFiles.js").PageConfigUserFriendlyOld & {
         Page: unknown;
         _isHtmlOnly: boolean;

package/dist/esm/node/runtime/renderPage.d.ts

@@ -2,7 +2,7 @@ export { renderPage };
 export { renderPage_addAsyncHookwrapper };
 export type { PageContextInit };
 export type { PageContextBegin };
-import { type GlobalContextServer, type GlobalContextInternal } from './globalContext.js';
+import { type GlobalContextServer, type GlobalContextServerInternal } from './globalContext.js';
 import { type HttpResponse } from './renderPage/createHttpResponse.js';
 import type { PageContextServer } from '../../types/index.js';
 import type { PageContextBuiltInServerInternal } from '../../shared/types.js';
@@ -18,7 +18,7 @@ declare let asyncHookWrapper: <PageContext>(_httpRequestId: number, ret: () => P
     pageContextReturn: Awaited<PageContext>;
 }>;
 declare function renderPage_addAsyncHookwrapper(wrapper: typeof asyncHookWrapper): void;
-declare function getPageContextBegin(pageContextInit: PageContextInit, globalContext: GlobalContextInternal, globalContext_public: GlobalContextServer, httpRequestId: number): Promise<{
+declare function getPageContextBegin(pageContextInit: PageContextInit, globalContext: GlobalContextServerInternal, globalContext_public: GlobalContextServer, httpRequestId: number): Promise<{
     isClientSide: boolean;
     isPrerendering: boolean;
 } & Pick<PageContextBuiltInServerInternal, "urlOriginal" | "headersOriginal"> & {
@@ -27,6 +27,7 @@ declare function getPageContextBegin(pageContextInit: PageContextInit, globalCon
 } & {
     globalContext: GlobalContextServer;
     _globalContext: {
+        isGlobalContext: true;
         _virtualFileExports: unknown;
         _pageFilesAll: import("../../shared/getPageFiles.js").PageFile[];
         _pageConfigs: import("../../__internal/index.js").PageConfig[];
@@ -52,8 +53,10 @@ declare function getPageContextBegin(pageContextInit: PageContextInit, globalCon
         };
         baseServer: string;
         baseAssets: string;
+        isClientSide: false;
         _pageRoutes: import("../../shared/route/loadPageRoutes.js").PageRoutes;
         _onBeforeRouteHook: import("../../shared/hooks/getHook.js").Hook | null;
+        isGlobalContext: true;
         _virtualFileExports: unknown;
         _pageFilesAll: import("../../shared/getPageFiles.js").PageFile[];
         _pageConfigs: import("../../__internal/index.js").PageConfig[];
@@ -80,8 +83,10 @@ declare function getPageContextBegin(pageContextInit: PageContextInit, globalCon
         _usesClientRouter: boolean;
         baseServer: string;
         baseAssets: string;
+        isClientSide: false;
         _pageRoutes: import("../../shared/route/loadPageRoutes.js").PageRoutes;
         _onBeforeRouteHook: import("../../shared/hooks/getHook.js").Hook | null;
+        isGlobalContext: true;
         _virtualFileExports: unknown;
         _pageFilesAll: import("../../shared/getPageFiles.js").PageFile[];
         _pageConfigs: import("../../__internal/index.js").PageConfig[];
@@ -108,8 +113,10 @@ declare function getPageContextBegin(pageContextInit: PageContextInit, globalCon
         _usesClientRouter: boolean;
         baseServer: string;
         baseAssets: string;
+        isClientSide: false;
         _pageRoutes: import("../../shared/route/loadPageRoutes.js").PageRoutes;
         _onBeforeRouteHook: import("../../shared/hooks/getHook.js").Hook | null;
+        isGlobalContext: true;
         _virtualFileExports: unknown;
         _pageFilesAll: import("../../shared/getPageFiles.js").PageFile[];
         _pageConfigs: import("../../__internal/index.js").PageConfig[];
@@ -142,7 +149,7 @@ declare function getPageContextBegin(pageContextInit: PageContextInit, globalCon
     _source: import("../../shared/page-configs/getPageConfigUserFriendly.js").Source;
     _sources: import("../../shared/page-configs/getPageConfigUserFriendly.js").Sources;
     _from: import("../../shared/page-configs/getPageConfigUserFriendly.js").From;
-    _isPageContextObject: boolean;
+    isPageContext: true;
 } & {
     _httpRequestId: number;
 }>;

package/dist/esm/node/runtime/renderPage.js

@@ -5,7 +5,7 @@ import { createPageContextServerSide, createPageContextServerSideWithoutGlobalCo
 import { route } from '../../shared/route/index.js';
 import { assert, hasProp, objectAssign, isUrl, parseUrl, onSetupRuntime, assertWarning, getGlobalObject, checkType, assertUsage, normalizeUrlPathname, removeBaseServer, modifyUrlPathname, prependBase, removeUrlOrigin, setUrlOrigin, isUri, getUrlPretty } from './utils.js';
 import { assertNoInfiniteAbortLoop, getPageContextFromAllRewrites, isAbortError, logAbortErrorHandled } from '../../shared/route/abort.js';
-import { getGlobalContextInternal, initGlobalContext_renderPage } from './globalContext.js';
+import { getGlobalContextServerInternal, initGlobalContext_renderPage } from './globalContext.js';
 import { handlePageContextRequestUrl } from './renderPage/handlePageContextRequestUrl.js';
 import { createHttpResponseFavicon404, createHttpResponseRedirect, createHttpResponsePageContextJson, createHttpResponseError, createHttpResponseErrorWithoutGlobalContext, createHttpResponseBaseIsMissing } from './renderPage/createHttpResponse.js';
 import { logRuntimeError, logRuntimeInfo } from './renderPage/loggerRuntime.js';
@@ -76,7 +76,7 @@ async function renderPagePrepare(pageContextInit, httpRequestId) {
     else {
         // `globalContext` now contains the entire Vike config and getVikeConfig() isn't called anymore for this request.
     }
-    const { globalContext, globalContext_public } = await getGlobalContextInternal();
+    const { globalContext, globalContext_public } = await getGlobalContextServerInternal();
     const pageContextBegin = await getPageContextBegin(pageContextInit, globalContext, globalContext_public, httpRequestId);
     // Check Base URL
     {

package/dist/esm/shared/assertPageContextProvidedByUser.js

@@ -7,7 +7,7 @@ function assertPageContextProvidedByUser(pageContextProvidedByUser, { hookName,
     assert(!hookName.endsWith(')'));
     const errPrefix = `The ${pc.cyan('pageContext')} object provided by the ${hookName}() hook defined by ${hookFilePath}`;
     assertUsage(isObject(pageContextProvidedByUser), `${errPrefix} should be an object (but it's ${pc.cyan(`typeof pageContext === ${JSON.stringify(typeof pageContextProvidedByUser)}`)} instead)`);
-    assertUsage(!('_isPageContextObject' in pageContextProvidedByUser), `${errPrefix} shouldn't be the whole ${pc.cyan('pageContext')} object, see https://vike.dev/pageContext-manipulation#do-not-return-entire-pagecontext`);
+    assertUsage(!('isPageContext' in pageContextProvidedByUser), `${errPrefix} shouldn't be the whole ${pc.cyan('pageContext')} object, see https://vike.dev/pageContext-manipulation#do-not-return-entire-pagecontext`);
     // In principle, it's possible to use onBeforeRoute()` to override and define the whole routing.
     // Is that a good idea to allow users to do this? Beyond deep integration with Vue Router or React Router, is there a use case for this?
     assertWarning(!('pageId' in pageContextProvidedByUser), `${errPrefix} sets ${pc.cyan('pageContext.pageId')} which means that Vike's routing is overriden. This is an experimental feature: make sure to contact a vike maintainer before using this.`, { onlyOnce: true });

package/dist/esm/shared/createGlobalContextShared.d.ts

@@ -1,9 +1,17 @@
 export { createGlobalContextShared };
+export { getGlobalContextSyncErrMsg };
 export type { GlobalContextShared };
 export type { GlobalContextSharedPublic };
+declare const getGlobalContextSyncErrMsg = "The global context isn't set yet, call getGlobalContextSync() later or use getGlobalContext() instead.";
 declare function createGlobalContextShared<GlobalContextAddendum extends object>(virtualFileExports: unknown, globalObject: {
     globalContext?: Record<string, unknown>;
 }, addGlobalContext?: (globalContext: GlobalContextShared) => Promise<GlobalContextAddendum>): Promise<{
+    /**
+     * Useful for distinguishing `globalContext` from other objects and narrowing down TypeScript unions.
+     *
+     * https://vike.dev/globalContext#typescript
+     */
+    isGlobalContext: true;
     _virtualFileExports: unknown;
     _pageFilesAll: import("./getPageFiles.js").PageFile[];
     _pageConfigs: import("./page-configs/PageConfig.js").PageConfigRuntime[];
@@ -12,9 +20,15 @@ declare function createGlobalContextShared<GlobalContextAddendum extends object>
     config: import("./page-configs/Config/PageContextConfig.js").ConfigResolved;
     pages: import("./page-configs/getPageConfigUserFriendly.js").PageConfigsUserFriendly;
 } & Awaited<GlobalContextAddendum>>;
-type GlobalContextSharedPublic = Pick<GlobalContextShared, 'config' | 'pages'>;
+type GlobalContextSharedPublic = Pick<GlobalContextShared, 'config' | 'pages' | 'isGlobalContext'>;
 type GlobalContextShared = ReturnType<typeof createGlobalContextBase>;
 declare function createGlobalContextBase(virtualFileExports: unknown): {
+    /**
+     * Useful for distinguishing `globalContext` from other objects and narrowing down TypeScript unions.
+     *
+     * https://vike.dev/globalContext#typescript
+     */
+    isGlobalContext: true;
     _virtualFileExports: unknown;
     _pageFilesAll: import("./getPageFiles.js").PageFile[];
     _pageConfigs: import("./page-configs/PageConfig.js").PageConfigRuntime[];

package/dist/esm/shared/createGlobalContextShared.js

@@ -1,4 +1,6 @@
 export { createGlobalContextShared };
+export { getGlobalContextSyncErrMsg };
+const getGlobalContextSyncErrMsg = "The global context isn't set yet, call getGlobalContextSync() later or use getGlobalContext() instead.";
 import { getPageConfigsRuntime } from './getPageConfigsRuntime.js';
 import { executeHookGenericGlobalCumulative } from './hooks/executeHookGeneric.js';
 import { objectAssign } from './utils.js';
@@ -31,6 +33,12 @@ async function createGlobalContextShared(virtualFileExports, globalObject, addGl
 function createGlobalContextBase(virtualFileExports) {
     const { pageFilesAll, allPageIds, pageConfigs, pageConfigGlobal, globalConfig, pageConfigsUserFriendly } = getPageConfigsRuntime(virtualFileExports);
     const globalContext = {
+        /**
+         * Useful for distinguishing `globalContext` from other objects and narrowing down TypeScript unions.
+         *
+         * https://vike.dev/globalContext#typescript
+         */
+        isGlobalContext: true,
         _virtualFileExports: virtualFileExports,
         _pageFilesAll: pageFilesAll,
         _pageConfigs: pageConfigs,

package/dist/esm/shared/createPageContextShared.d.ts

@@ -5,5 +5,5 @@ declare function createPageContextShared<T extends object>(pageContextCreated: T
     _source: import("./page-configs/getPageConfigUserFriendly.js").Source;
     _sources: import("./page-configs/getPageConfigUserFriendly.js").Sources;
     _from: import("./page-configs/getPageConfigUserFriendly.js").From;
-    _isPageContextObject: boolean;
+    isPageContext: true;
 }>;

package/dist/esm/shared/createPageContextShared.js

@@ -7,7 +7,7 @@ async function createPageContextShared(pageContextCreated, pageConfigGlobal) {
         pageConfigGlobalValues: pageConfigGlobal.configValues
     });
     objectAssign(pageContextCreated, {
-        _isPageContextObject: true,
+        isPageContext: true,
         ...pageConfigGlobalUserFriendly
     }, true);
     await executeHookGenericGlobalCumulative('onCreatePageContext', pageConfigGlobal, pageContextCreated, pageContextCreated);

package/dist/esm/shared/route/loadPageRoutes.js

@@ -8,7 +8,7 @@ import { getDefinedAtString } from '../page-configs/getConfigDefinedAt.js';
 import { warnDeprecatedAllowKey } from './resolveRouteFunction.js';
 import { getHookFromPageConfigGlobal, getHookTimeoutDefault } from '../hooks/getHook.js';
 async function loadPageRoutes(
-// Remove all arguments and use GlobalContextInternal instead?
+// Remove all arguments and use GlobalContextServerInternal instead?
 pageFilesAll, pageConfigs, pageConfigGlobal, allPageIds) {
     // TODO/next-major: remove & make this function sync
     await Promise.all(pageFilesAll.filter((p) => p.fileType === '.page.route').map((p) => p.loadFile?.()));

package/dist/esm/shared/types.d.ts

@@ -26,24 +26,34 @@ type GlobalContext = GlobalContextServer | GlobalContextClient;
 type PageContextWithServerRouting<Data = unknown> = PageContextClientWithServerRouting<Data> | PageContextServer<Data>;
 type PageContextClientWithServerRouting<Data = unknown> = PageContextBuiltInClientWithServerRouting<Data> & Vike.PageContext & Vike.PageContextClient;
 type PageContextBuiltInCommon<Data> = {
+    /**
+     * Useful for distinguishing `pageContext` from other objects and narrowing down TypeScript unions.
+     *
+     * https://vike.dev/pageContext#typescript
+     */
+    isPageContext: true;
     /** The `export { Page }` of your `.page.js` file.
      *
      * https://vike.dev/Page
+     * https://vike.dev/pageContext#Page
      */
     Page: Config['Page'];
     /** Route Parameters, e.g. `pageContext.routeParams.productId` for a Route String `/product/@productId`.
      *
      * https://vike.dev/route-string
+     * https://vike.dev/pageContext#routeParams
      */
     routeParams: Record<string, string>;
     /** The page's data which was fetched using the data() hook.
      *
      * https://vike.dev/data
+     * https://vike.dev/pageContext#data
      */
     data: Data;
     /** The page's configuration values.
      *
      * https://vike.dev/config
+     * https://vike.dev/pageContext#config
      */
     config: PageContextConfig;
     /** The page's configuration, including the configs origin and overriden configs.
@@ -72,9 +82,8 @@ type PageContextBuiltInCommon<Data> = {
      *
      * As a string object normalized by Vike.
      *
-     * See also:
-     * - https://vike.dev/headers
-     * - `pageContext.headersOriginal`
+     * https://vike.dev/headers
+     * https://vike.dev/pageContext#headers
      */
     headers: Record<string, string> | null;
     /**
@@ -82,9 +91,8 @@ type PageContextBuiltInCommon<Data> = {
      *
      * The original object provided by the server.
      *
-     * See also:
-     * - https://vike.dev/headers
-     * - `pageContext.headers`
+     * https://vike.dev/headers
+     * https://vike.dev/pageContext#headersOriginal
      */
     headersOriginal?: unknown;
     /** If an error occurs, whether the error is a `404 Page Not Found`.
@@ -95,25 +103,28 @@ type PageContextBuiltInCommon<Data> = {
     /**
      * Whether the page was navigated by the client-side router.
      *
-     * https://vike.dev/pageContext
+     * https://vike.dev/pageContext#isClientSideNavigation
      */
     isClientSideNavigation: boolean;
     /**
      * The reason why the original page was aborted. Usually used for showing a custom message on the error page.
      *
      * https://vike.dev/render
+     * https://vike.dev/pageContext#abortReason
      */
     abortReason?: unknown;
     /**
      * The status code set by `throw render(abortStatusCode)`.
      *
      * https://vike.dev/render
+     * https://vike.dev/pageContext#abortStatusCode
      */
     abortStatusCode?: AbortStatusCode;
     /**
      * Error that occured while rendering.
      *
      * https://vike.dev/error-tracking
+     * https://vike.dev/pageContext#errorWhileRendering
      */
     errorWhileRendering?: unknown;
     /**
@@ -134,14 +145,17 @@ type PageContextBuiltInCommon<Data> = {
      * Whether the Base URL is missing in the URL of the HTTP request made to the SSR server.
      *
      * https://vike.dev/base-url#setup
+     * https://vike.dev/pageContext#isBaseMissing
      */
     isBaseMissing?: true;
 };
 type PageContextBuiltInServer<Data> = PageContextBuiltInCommon<Data> & PageContextUrlServer & {
     /**
-     * Whether the page is being rendered on the client- or server-side / pre-rendered.
+     * Whether the page is being rendered on the client-side or server-side / pre-rendered.
+     *
+     * We recommend using `import.meta.env.SSR` instead, see https://vike.dev/pageContext#isClientSide
      *
-     * In order to save client-side KBs, we recommend using `import.meta.env.SSR` whenever possible instead, see https://vike.dev/pageContext
+     * https://vike.dev/pageContext#isClientSide
      */
     isClientSide: false;
     /**
@@ -150,13 +164,14 @@ type PageContextBuiltInServer<Data> = PageContextBuiltInCommon<Data> & PageConte
      * The value is always `false` in development.
      *
      * https://vike.dev/pre-rendering
-     * https://vike.dev/pageContext
+     * https://vike.dev/pageContext#isPrerendering
      */
     isPrerendering: boolean;
     /**
      * Runtime information about your app.
      *
      * https://vike.dev/getGlobalContext
+     * https://vike.dev/pageContext#globalContext
      */
     globalContext: GlobalContextServer;
     isHydration?: undefined;
@@ -170,12 +185,14 @@ type PageContextBuiltInClientWithClientRouting<Data> = Partial<PageContextBuiltI
      * Whether the user is navigating back in history.
      *
      * The value is `true` when the user clicks on his browser's backward navigation button, or when invoking `history.back()`.
+     *
+     * https://vike.dev/pageContext#isBackwardNavigation
      */
     isBackwardNavigation: boolean | null;
     /**
      * Upon client-side page navigation, you can use `pageContext.previousPageContext` to access the `pageContext` of the previous page.
      *
-     * https://vike.dev/pageContext
+     * https://vike.dev/pageContext#previousPageContext
      */
     previousPageContext: PageContextClient<Data> | null;
     globalContext: GlobalContextClient;
@@ -185,12 +202,16 @@ type PageContextBuiltInClientWithServerRouting<Data> = Partial<PageContextBuiltI
      * Whether the current page is already rendered to HTML.
      *
      * The `isHydration` value is always `true` when using Server Routing.
+     *
+     * https://vike.dev/pageContext#isHydration
      */
     isHydration: true;
     /**
      * Whether the user is navigating back in history.
      *
      * The `isBackwardNavigation` property only works with Client Routing. (The value is always `null` when using Server Routing.)
+     *
+     * https://vike.dev/pageContext#isBackwardNavigation
      */
     isBackwardNavigation: null;
     globalContext: GlobalContextClientWithServerRouting;
@@ -199,7 +220,9 @@ type PageContextClientCommon = {
     /**
      * Whether the page is being rendered on the client-side, or rendered on the server-side / pre-rendered.
      *
-     * In order to save client-side KBs, we recommend using `import.meta.env.SSR` whenever possible instead, see https://vike.dev/pageContext
+     * In order to save client-side KBs, we recommend using `import.meta.env.SSR` whenever possible instead, see https://vike.dev/pageContext#isClientSide
+     *
+     * https://vike.dev/pageContext#isClientSide
      */
     isClientSide: true;
     /**
@@ -208,7 +231,7 @@ type PageContextClientCommon = {
      * The value is always `false` in development.
      *
      * https://vike.dev/pre-rendering
-     * https://vike.dev/pageContext
+     * https://vike.dev/pageContext#isPrerendering
      */
     isPrerendering: false;
 };

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

@@ -1 +1 @@
-export declare const PROJECT_VERSION: "0.4.228-commit-84954ae";
+export declare const PROJECT_VERSION: "0.4.228-commit-1bb55f1";

package/dist/esm/utils/PROJECT_VERSION.js

@@ -1,2 +1,2 @@
 // Automatically updated by @brillout/release-me
-export const PROJECT_VERSION = '0.4.228-commit-84954ae';
+export const PROJECT_VERSION = '0.4.228-commit-1bb55f1';

package/dist/esm/utils/objectAssign.js

@@ -7,6 +7,6 @@ function objectAssign(obj, objAddendum, objAddendumCanBePageContextObject) {
     if (!objAddendum)
         return;
     if (!objAddendumCanBePageContextObject)
-        assert(!('_isPageContextObject' in objAddendum));
+        assert(!('isPageContext' in objAddendum));
     Object.defineProperties(obj, Object.getOwnPropertyDescriptors(objAddendum));
 }