vike 0.4.236-commit-eab75f6 → 0.4.237

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

@@ -9,6 +9,8 @@ export type { HookNameOld };
 export type { HookNamePage };
 export type { HookNameGlobal };
 export type { ImportString };
+export type { Route };
+export type { KeepScrollPosition };
 export type { DataAsync };
 export type { DataSync };
 export type { GuardAsync };
@@ -33,8 +35,6 @@ export type { OnRenderHtmlAsync };
 export type { OnRenderHtmlSync };
 export type { RouteAsync };
 export type { RouteSync };
-export type { Route };
-export type { KeepScrollPosition };
 import type { PrefetchSetting, PrefetchStaticAssets } from '../client/runtime-client-routing/prefetch/PrefetchSetting.js';
 import type { ConfigDefinition } from '../node/vite/shared/resolveVikeConfigInternal/configDefinitionsBuiltIn.js';
 import type { DocumentHtml } from '../node/runtime/html/renderHtml.js';
@@ -44,73 +44,46 @@ import type { Vike, VikePackages } from './VikeNamespace.js';
 import type { HooksTimeoutProvidedByUser } from '../shared/hooks/getHook.js';
 import type { GlobalContext, PageContextClient, PageContextServer } from './PageContext.js';
 import type { InlineConfig } from 'vite';
-import type { PassToClient } from '../node/runtime/html/serializeContext.js';
+import type { PassToClientPublic } from '../node/runtime/html/serializeContext.js';
 type HookNameOld = HookName | HookNameOldDesign;
 type HookName = HookNamePage | HookNameGlobal;
 type HookNamePage = 'onHydrationEnd' | 'onBeforePrerenderStart' | 'onBeforeRender' | 'onPageTransitionStart' | 'onPageTransitionEnd' | 'onRenderHtml' | 'onRenderClient' | 'guard' | 'data' | 'onData' | 'route';
 type HookNameGlobal = 'onBeforeRoute' | 'onPrerenderStart' | 'onCreatePageContext' | 'onCreateGlobalContext';
 type HookNameOldDesign = 'render' | 'prerender' | 'onBeforePrerender';
-type ConfigNameBuiltIn = Exclude<keyof Config, keyof VikeVitePluginOptions | 'onBeforeRoute' | 'onPrerenderStart' | 'vite' | 'redirects'> | 'prerender' | 'isClientRuntimeLoaded' | 'onBeforeRenderEnv' | 'dataEnv' | 'hooksTimeout' | 'clientHooks' | 'middleware';
+type ConfigNameBuiltIn = Exclude<keyof Config, keyof VikeVitePluginOptions | 'onBeforeRoute' | 'onPrerenderStart' | 'vite' | 'redirects'> | 'prerender' | 'serverOnlyHooks' | 'isClientRuntimeLoaded' | 'onBeforeRenderEnv' | 'dataEnv' | 'hooksTimeout' | 'clientHooks' | 'middleware';
 type ConfigNameGlobal = 'onPrerenderStart' | 'onBeforeRoute' | 'prerender' | 'disableAutoFullBuild' | 'includeAssetsImportedByServer' | 'baseAssets' | 'baseServer' | 'redirects' | 'trailingSlash' | 'disableUrlNormalization' | 'vite';
 type Config = ConfigBuiltIn & Vike.Config & (VikePackages.ConfigVikeReact | VikePackages.ConfigVikeVue | VikePackages.ConfigVikeSolid | VikePackages.ConfigVikeSvelte | VikePackages.ConfigVikeAngular);
-/** Hook for fetching data.
- *
- *  https://vike.dev/data
- */
+/** @deprecated This type is deprecated, see https://vike.dev/data */
 type DataAsync<Data = unknown> = (pageContext: PageContextServer) => Promise<Data>;
-/** Hook for fetching data.
- *
- *  https://vike.dev/data
- */
+/** @deprecated This type is deprecated, see https://vike.dev/data */
 type DataSync<Data = unknown> = (pageContext: PageContextServer) => Data;
-/** Protect page(s), e.g. forbid unauthorized access.
- *
- *  https://vike.dev/guard
- */
+/** @deprecated This type is deprecated, see https://vike.dev/guard */
 type GuardAsync = (pageContext: PageContextServer) => Promise<void>;
-/** Protect page(s), e.g. forbid unauthorized access.
- *
- *  https://vike.dev/guard
- */
+/** @deprecated This type is deprecated, see https://vike.dev/guard */
 type GuardSync = (pageContext: PageContextServer) => void;
-/** Global Hook called before the whole pre-rendering process starts.
- *
- * https://vike.dev/onBeforePrerenderStart
- */
+/** @deprecated This type is deprecated, see https://vike.dev/onBeforePrerenderStart */
 type OnBeforePrerenderStartAsync<Data = unknown> = () => Promise<(string | {
     url: string;
     pageContext: Partial<Vike.PageContext & {
         data: Data;
     }>;
 })[]>;
-/** Global Hook called before the whole pre-rendering process starts.
- *
- * https://vike.dev/onBeforePrerenderStart
- */
+/** @deprecated This type is deprecated, see https://vike.dev/onBeforePrerenderStart */
 type OnBeforePrerenderStartSync<Data = unknown> = () => (string | {
     url: string;
     pageContext: Partial<Vike.PageContext & {
         data: Data;
     }>;
 })[];
-/** Hook called before the page is rendered.
- *
- *  https://vike.dev/onBeforeRender
- */
+/** @deprecated This type is deprecated, see https://vike.dev/onBeforeRender */
 type OnBeforeRenderAsync = (pageContext: PageContextServer) => Promise<{
     pageContext: Partial<Vike.PageContext>;
 } | void>;
-/** Hook called before the page is rendered.
- *
- *  https://vike.dev/onBeforeRender
- */
+/** @deprecated This type is deprecated, see https://vike.dev/onBeforeRender */
 type OnBeforeRenderSync = (pageContext: PageContextServer) => {
     pageContext: Partial<Vike.PageContext>;
 } | void;
-/** Hook called before the URL is routed to a page.
- *
- * https://vike.dev/onBeforeRoute
- */
+/** @deprecated This type is deprecated, see https://vike.dev/onBeforeRoute */
 type OnBeforeRouteAsync = (pageContext: PageContextServer) => Promise<{
     pageContext: Partial<{
         /** The URL you provided to Vike when calling `renderPage({ urlOriginal })` in your server middleware.
@@ -120,10 +93,7 @@ type OnBeforeRouteAsync = (pageContext: PageContextServer) => Promise<{
         urlOriginal: string;
     } | Vike.PageContext>;
 }>;
-/** Hook called before the URL is routed to a page.
- *
- * https://vike.dev/onBeforeRoute
- */
+/** @deprecated This type is deprecated, see https://vike.dev/onBeforeRoute */
 type OnBeforeRouteSync = (pageContext: PageContextServer) => {
     pageContext: Partial<{
         /** The URL you provided to Vike when calling `renderPage({ urlOriginal })` in your server middleware.
@@ -133,40 +103,19 @@ type OnBeforeRouteSync = (pageContext: PageContextServer) => {
         urlOriginal: string;
     } | Vike.PageContext>;
 };
-/** Hook called after the page is hydrated.
- *
- * https://vike.dev/onHydrationEnd
- */
+/** @deprecated This type is deprecated, see https://vike.dev/onHydrationEnd */
 type OnHydrationEndAsync = (pageContext: PageContextClient) => Promise<void>;
-/** Hook called after the page is hydrated.
- *
- * https://vike.dev/onHydrationEnd
- */
+/** @deprecated This type is deprecated, see https://vike.dev/onHydrationEnd */
 type OnHydrationEndSync = (pageContext: PageContextClient) => void;
-/** Hook called after the user navigates to a new page.
- *
- * https://vike.dev/onPageTransitionEnd
- */
+/** @deprecated This type is deprecated, see https://vike.dev/onPageTransitionEnd */
 type OnPageTransitionEndAsync = (pageContext: PageContextClient) => Promise<void>;
-/** Hook called after the user navigates to a new page.
- *
- * https://vike.dev/onPageTransitionEnd
- */
+/** @deprecated This type is deprecated, see https://vike.dev/onPageTransitionEnd */
 type OnPageTransitionEndSync = (pageContext: PageContextClient) => void;
-/** Hook called before the user navigates to a new page.
- *
- * https://vike.dev/onPageTransitionStart
- */
+/** @deprecated This type is deprecated, see https://vike.dev/onPageTransitionStart */
 type OnPageTransitionStartAsync = (pageContext: PageContextClient) => Promise<void>;
-/** Hook called before the user navigates to a new page.
- *
- * https://vike.dev/onPageTransitionStart
- */
+/** @deprecated This type is deprecated, see https://vike.dev/onPageTransitionStart */
 type OnPageTransitionStartSync = (pageContext: PageContextClient) => void;
-/** Page Hook called when pre-rendering starts.
- *
- * https://vike.dev/onPrerenderStart
- */
+/** @deprecated This type is deprecated, see https://vike.dev/onPrerenderStart */
 type OnPrerenderStartAsync = (prerenderContext: {
     pageContexts: PageContextServer[];
 }) => Promise<{
@@ -174,10 +123,7 @@ type OnPrerenderStartAsync = (prerenderContext: {
         pageContexts: PageContextServer[];
     };
 }>;
-/** Page Hook called when pre-rendering starts.
- *
- * https://vike.dev/onPrerenderStart
- */
+/** @deprecated This type is deprecated, see https://vike.dev/onPrerenderStart */
 type OnPrerenderStartSync = (prerenderContext: {
     pageContexts: PageContextServer[];
 }) => {
@@ -185,25 +131,13 @@ type OnPrerenderStartSync = (prerenderContext: {
         pageContexts: PageContextServer[];
     };
 };
-/** Hook called when page is rendered on the client-side.
- *
- * https://vike.dev/onRenderClient
- */
+/** @deprecated This type is deprecated, see https://vike.dev/onRenderClient */
 type OnRenderClientAsync = (pageContext: PageContextClient) => Promise<void>;
-/** Hook called when page is rendered on the client-side.
- *
- * https://vike.dev/onRenderClient
- */
+/** @deprecated This type is deprecated, see https://vike.dev/onRenderClient */
 type OnRenderClientSync = (pageContext: PageContextClient) => void;
-/** Hook called when page is rendered to HTML on the server-side.
- *
- * https://vike.dev/onRenderHtml
- */
+/** @deprecated This type is deprecated, see https://vike.dev/onRenderHtml */
 type OnRenderHtmlAsync = (pageContext: PageContextServer) => Promise<OnRenderHtmlReturn>;
-/** Hook called when page is rendered to HTML on the server-side.
- *
- * https://vike.dev/onRenderHtml
- */
+/** @deprecated This type is deprecated, see https://vike.dev/onRenderHtml */
 type OnRenderHtmlSync = (pageContext: PageContextServer) => OnRenderHtmlReturn;
 type OnRenderHtmlReturn = DocumentHtml | {
     injectFilter?: (assets: InjectFilterEntry[]) => void;
@@ -219,20 +153,21 @@ type RouteAsync = (pageContext: PageContextServer | PageContextClient) => Promis
     routeParams?: Record<string, string>;
     precedence?: number;
 } | boolean>;
-/** The page's URL(s).
- *
- *  https://vike.dev/route
- */
+/** @deprecated This type is deprecated, see https://vike.dev/route */
 type RouteSync = (pageContext: PageContextServer | PageContextClient) => {
     routeParams?: Record<string, string>;
     precedence?: number;
 } | boolean;
-type Route = string | RouteSync | RouteAsync;
 /** Whether the page scrolls to the top upon navigation.
  *
  * https://vike.dev/keepScrollPosition
  */
 type KeepScrollPosition = boolean | string | string[] | ((pageContext: PageContextClient) => boolean | string | string[]);
+/** The page's route.
+ *
+ * https://vike.dev/routing
+ */
+type Route = string | RouteSync | RouteAsync;
 /** Page configuration.
  *
  * https://vike.dev/config
@@ -363,7 +298,7 @@ type ConfigBuiltIn = {
      *
      * https://vike.dev/passToClient
      */
-    passToClient?: PassToClient | ImportString;
+    passToClient?: PassToClientPublic | ImportString;
     /** Hook called when page is rendered on the client-side.
      *
      * https://vike.dev/onRenderClient

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

@@ -1,8 +1,10 @@
 export type { PageContext, PageContextServer, PageContextClient, GlobalContext, GlobalContextServer, GlobalContextClient, PageContextWithServerRouting, PageContextClientWithServerRouting, GlobalContextClientWithServerRouting, } from './PageContext.js';
+export type { PrerenderContextPublic as PrerenderContext } from '../node/prerender/runPrerender.js';
 export type { PageContextBuiltInServer } from './PageContext.js';
 export type { PageContextBuiltInClientWithClientRouting } from './PageContext.js';
 export type { PageContextBuiltInClientWithServerRouting } from './PageContext.js';
-export type { Config, ConfigMeta as Meta, ImportString, DataAsync, DataSync, GuardAsync, GuardSync, OnBeforePrerenderStartAsync, OnBeforePrerenderStartSync, OnBeforeRenderAsync, OnBeforeRenderSync, OnBeforeRouteAsync, OnBeforeRouteSync, OnHydrationEndAsync, OnHydrationEndSync, OnPageTransitionEndAsync, OnPageTransitionEndSync, OnPageTransitionStartAsync, OnPageTransitionStartSync, OnPrerenderStartAsync, OnPrerenderStartSync, OnRenderClientAsync, OnRenderClientSync, OnRenderHtmlAsync, OnRenderHtmlSync, RouteAsync, RouteSync, KeepScrollPosition, } from './Config.js';
+export type { Config, ConfigMeta as Meta, ImportString, KeepScrollPosition, } from './Config.js';
+export type { DataAsync, DataSync, GuardAsync, GuardSync, OnBeforePrerenderStartAsync, OnBeforePrerenderStartSync, OnBeforeRenderAsync, OnBeforeRenderSync, OnBeforeRouteAsync, OnBeforeRouteSync, OnHydrationEndAsync, OnHydrationEndSync, OnPageTransitionEndAsync, OnPageTransitionEndSync, OnPageTransitionStartAsync, OnPageTransitionStartSync, OnPrerenderStartAsync, OnPrerenderStartSync, OnRenderClientAsync, OnRenderClientSync, OnRenderHtmlAsync, OnRenderHtmlSync, RouteAsync, RouteSync, } from './Config.js';
 export type { ConfigResolved } from './Config/PageContextConfig.js';
 export type { ConfigEnv } from './PageConfig.js';
 export type { ConfigDefinition, ConfigEffect, } from '../node/vite/shared/resolveVikeConfigInternal/configDefinitionsBuiltIn.js';

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

@@ -1 +1 @@
-export declare const PROJECT_VERSION: "0.4.236-commit-eab75f6";
+export declare const PROJECT_VERSION: "0.4.237";

package/dist/esm/utils/PROJECT_VERSION.js

@@ -1,2 +1,2 @@
 // Automatically updated by @brillout/release-me
-export const PROJECT_VERSION = '0.4.236-commit-eab75f6';
+export const PROJECT_VERSION = '0.4.237';

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

@@ -1,4 +1,4 @@
 export { cast };
 export { castProp };
-declare function cast<T>(_thing: unknown): asserts _thing is T;
-declare function castProp<PropType, ObjectType, PropName extends PropertyKey>(_obj: ObjectType, _prop: PropName): asserts _obj is ObjectType & Record<PropName, PropType>;
+declare function cast<Type>(_thing: unknown): asserts _thing is Type;
+declare function castProp<PropType>(_obj: object, prop: PropertyKey): asserts _obj is Record<typeof prop, PropType>;

package/dist/esm/utils/cast.js

@@ -1,4 +1,4 @@
 export { cast };
 export { castProp };
 function cast(_thing) { }
-function castProp(_obj, _prop) { }
+function castProp(_obj, prop) { }

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

@@ -1 +1 @@
-export declare function objectFilter<Val, Val2 extends Val, Obj extends Record<string, Val>>(obj: Obj, filter: (arg: [string, Val]) => arg is [string, Val2]): Record<string, Val2>;
+export declare function objectFilter<T, U extends T>(obj: Record<string, T>, filter: (entry: [string, T]) => entry is [string, U]): Record<string, U>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vike",
-  "version": "0.4.236-commit-eab75f6",
+  "version": "0.4.237",
   "repository": "https://github.com/vikejs/vike",
   "exports": {
     "./server": {

package/dist/cjs/node/vite/plugins/pluginVirtualFiles/isRuntimeEnvMatch.js

@@ -1,23 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isRuntimeEnvMatch = isRuntimeEnvMatch;
-function isRuntimeEnvMatch(configEnv, runtime) {
-    // Runtime
-    if (!runtime.isForClientSide) {
-        if (!configEnv.server)
-            return false;
-    }
-    else {
-        if (!configEnv.client)
-            return false;
-        if (configEnv.client === 'if-client-routing' && !runtime.isClientRouting)
-            return false;
-    }
-    // Production/development
-    if (
-    //
-    (configEnv.production === true && runtime.isDev) ||
-        (configEnv.production === false && !runtime.isDev))
-        return false;
-    return true;
-}

package/dist/esm/node/vite/plugins/pluginVirtualFiles/isRuntimeEnvMatch.d.ts

@@ -1,7 +0,0 @@
-export { isRuntimeEnvMatch };
-import type { ConfigEnvInternal } from '../../../../types/PageConfig.js';
-declare function isRuntimeEnvMatch(configEnv: ConfigEnvInternal, runtime: {
-    isForClientSide: boolean;
-    isClientRouting: boolean;
-    isDev: boolean;
-}): boolean;

package/dist/esm/node/vite/plugins/pluginVirtualFiles/isRuntimeEnvMatch.js

@@ -1,21 +0,0 @@
-export { isRuntimeEnvMatch };
-function isRuntimeEnvMatch(configEnv, runtime) {
-    // Runtime
-    if (!runtime.isForClientSide) {
-        if (!configEnv.server)
-            return false;
-    }
-    else {
-        if (!configEnv.client)
-            return false;
-        if (configEnv.client === 'if-client-routing' && !runtime.isClientRouting)
-            return false;
-    }
-    // Production/development
-    if (
-    //
-    (configEnv.production === true && runtime.isDev) ||
-        (configEnv.production === false && !runtime.isDev))
-        return false;
-    return true;
-}