vike-react 0.5.3 → 0.5.4

package/dist/+config.d.ts

@@ -1,6 +1,6 @@
+export { config };
 import { ssrEffect } from './renderer/ssrEffect.js';
-import './types/index.js';
-declare const _default: {
+declare const config: {
     name: string;
     require: {
         vike: string;
@@ -88,6 +88,12 @@ declare const _default: {
                 server: true;
             };
         };
+        onAfterRenderHtml: {
+            env: {
+                server: true;
+            };
+            cumulative: true;
+        };
         onBeforeRenderClient: {
             env: {
                 client: true;
@@ -121,4 +127,5 @@ declare const _default: {
         };
     };
 };
-export default _default;
+import './types/Config.js';
+import './types/PageContext.js';

package/dist/+config.js

@@ -1,8 +1,7 @@
-import { isNotFalse } from './utils/isNotFalse.js';
+export { config };
 import { ssrEffect } from './renderer/ssrEffect.js';
-// This is required to make TypeScript load the global interfaces such as Vike.PageContext so that they're always loaded: we can assume that the user always imports this file over `import vikeReact from 'vike-react/config'`
-import './types/index.js';
-export default {
+import { isNotFalse } from './utils/isNotFalse.js';
+const config = {
     name: 'vike-react',
     require: {
         vike: '>=0.4.182'
@@ -69,6 +68,10 @@ export default {
         streamIsRequired: {
             env: { server: true }
         },
+        onAfterRenderHtml: {
+            env: { server: true },
+            cumulative: true
+        },
         onBeforeRenderClient: {
             env: { client: true },
             cumulative: true
@@ -89,3 +92,6 @@ export default {
         }
     }
 };
+// This is required to make TypeScript load the global interfaces Vike.Config and Vike.PageContext so that they're always loaded: we can assume that the user always imports this file over `import vikeReact from 'vike-react/config'`
+import './types/Config.js';
+import './types/PageContext.js';

package/dist/index.d.ts

@@ -1 +1 @@
-export { default } from './+config.js';
+export { config as default } from './+config.js';

package/dist/index.js

@@ -1,3 +1,3 @@
 // TODO/next-major-release: remove this file/export
 console.warn("[vike-react][warning][deprecation] Replace `import vikeReact from 'vike-react'` with `import vikeReact from 'vike-react/config'` (typically in your /pages/+config.js)");
-export { default } from './+config.js';
+export { config as default } from './+config.js';

package/dist/renderer/onRenderHtml.d.ts

@@ -1,4 +1,6 @@
 export { onRenderHtml };
+import { renderToStream } from 'react-streaming/server';
 import type { OnRenderHtmlAsync } from 'vike/types';
 declare const onRenderHtml: OnRenderHtmlAsync;
+export type PageHtmlStream = Awaited<ReturnType<typeof renderToStream>>;
 export type Viewport = 'responsive' | number | null;

package/dist/renderer/onRenderHtml.js

@@ -9,6 +9,7 @@ import { getHeadSetting } from './getHeadSetting.js';
 import { getPageElement } from './getPageElement.js';
 import { isReactElement } from '../utils/isReactElement.js';
 import { getTagAttributesString } from '../utils/getTagAttributesString.js';
+import { callCumulativeHooks } from '../utils/callCumulativeHooks.js';
 addEcosystemStamp();
 const onRenderHtml = async (pageContext) => {
     const pageHtml = await getPageHtml(pageContext);
@@ -36,11 +37,13 @@ async function getPageHtml(pageContext) {
         const page = getPageElement(pageContext);
         const { stream, streamIsRequired } = pageContext.config;
         if (!stream && !streamIsRequired) {
-            pageHtml = dangerouslySkipEscape(renderToString(page));
+            const pageHtmlString = renderToString(page);
+            pageContext.pageHtmlString = pageHtmlString;
+            pageHtml = dangerouslySkipEscape(pageHtmlString);
         }
         else {
             const disable = stream === false ? true : undefined;
-            pageHtml = await renderToStream(page, {
+            const pageHtmlStream = await renderToStream(page, {
                 webStream: typeof stream === 'string' ? stream === 'web' : undefined,
                 userAgent: pageContext.headers?.['user-agent'] ||
                     // TODO/eventually: remove old way of acccessing the User Agent header.
@@ -48,8 +51,12 @@ async function getPageHtml(pageContext) {
                     pageContext.userAgent,
                 disable
             });
+            pageContext.pageHtmlStream = pageHtmlStream;
+            pageHtml = pageHtmlStream;
         }
     }
+    // https://github.com/vikejs/vike/discussions/1804#discussioncomment-10394481
+    await callCumulativeHooks(pageContext.config.onAfterRenderHtml, pageContext);
     return pageHtml;
 }
 function getHeadHtml(pageContext) {

package/dist/types/Config.d.ts

@@ -1,4 +1,4 @@
-import type { ImportString, PageContextClient, PageContext as PageContext_, PageContextServer } from 'vike/types';
+import type { ImportString, PageContextServer, PageContext, PageContextClient } from 'vike/types';
 import type { TagAttributes } from '../utils/getTagAttributesString.js';
 import type { Viewport } from '../renderer/onRenderHtml.js';
 import type { ConfigsCumulative } from '../hooks/useConfig/configsCumulative.js';
@@ -152,6 +152,12 @@ declare global {
              * https://vike.dev/reactStrictMode
              */
             reactStrictMode?: boolean;
+            /**
+             * Server-side hook called right after rendering the page's root React component to HTML.
+             *
+             * https://vike.dev/onAfterRenderHtml
+             */
+            onAfterRenderHtml?: (pageContext: PageContextServer) => void;
             /**
              * Client-side hook called before the page is rendered.
              *
@@ -177,11 +183,13 @@ declare global {
             Head?: Head[];
             bodyAttributes?: TagAttributes[];
             htmlAttributes?: TagAttributes[];
+            onAfterRenderHtml?: Function[];
             onBeforeRenderClient?: Function[];
             onAfterRenderClient?: Function[];
         }
     }
 }
+type PageContext_ = PageContext;
 export type Head = React.ReactNode | (() => React.ReactNode);
 type Wrapper = (props: {
     children: React.ReactNode;

package/dist/types/PageContext.d.ts

@@ -2,6 +2,7 @@ import type React from 'react';
 import type { JSX } from 'react';
 import type ReactDOM from 'react-dom/client';
 import type { ConfigFromHookResolved } from './Config.js';
+import type { PageHtmlStream } from '../renderer/onRenderHtml.js';
 declare global {
     namespace Vike {
         interface PageContext {
@@ -11,6 +12,10 @@ declare global {
             page?: JSX.Element;
             /** The React root DOM container */
             root?: ReactDOM.Root;
+            /** The +Page.jsx component rendered to the HTML string. */
+            pageHtmlString?: string;
+            /** The +Pagejsx component rendered to an HTML stream. */
+            pageHtmlStream?: PageHtmlStream;
         }
     }
 }

package/dist/utils/callCumulativeHooks.d.ts

@@ -1 +1,2 @@
-export declare function callCumulativeHooks(values: undefined | unknown[], pageContext: unknown): Promise<unknown[]>;
+export { callCumulativeHooks };
+declare function callCumulativeHooks(values: undefined | unknown[], pageContext: Record<string, any>): Promise<unknown[]>;

package/dist/utils/callCumulativeHooks.js

@@ -1,8 +1,11 @@
-export async function callCumulativeHooks(values, pageContext) {
+export { callCumulativeHooks };
+import { providePageContext } from 'vike/getPageContext';
+async function callCumulativeHooks(values, pageContext) {
     if (!values)
         return [];
     const valuesPromises = values.map((val) => {
         if (typeof val === 'function') {
+            providePageContext(pageContext);
             // Hook
             return val(pageContext);
         }

package/package.json

@@ -1,12 +1,11 @@
 {
   "name": "vike-react",
-  "version": "0.5.3",
+  "version": "0.5.4",
+  "repository": "https://github.com/vikejs/vike-react",
   "type": "module",
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
   "exports": {
-    "./useData": "./dist/hooks/useData.js",
     "./usePageContext": "./dist/hooks/usePageContext.js",
+    "./useData": "./dist/hooks/useData.js",
     "./useConfig": {
       "browser": "./dist/hooks/useConfig/useConfig-client.js",
       "default": "./dist/hooks/useConfig/useConfig-server.js"
@@ -19,14 +18,22 @@
       "browser": "./dist/components/Head/Head-client.js",
       "default": "./dist/components/Head/Head-server.js"
     },
-    "./ClientOnly": "./dist/components/ClientOnly.js",
     "./clientOnly": "./dist/helpers/clientOnly.js",
+    "./ClientOnly": "./dist/components/ClientOnly.js",
     ".": "./dist/index.js",
     "./config": "./dist/+config.js",
     "./renderer/onRenderHtml": "./dist/renderer/onRenderHtml.js",
     "./renderer/onRenderClient": "./dist/renderer/onRenderClient.js",
     "./components/Loading": "./dist/components/Loading.js"
   },
+  "dependencies": {
+    "react-streaming": "^0.3.42"
+  },
+  "peerDependencies": {
+    "react": ">=18.0.0",
+    "react-dom": ">=18.0.0",
+    "vike": ">=0.4.182"
+  },
   "scripts": {
     "dev": "tsc --watch",
     "build": "rimraf dist/ && tsc && pnpm run build:css",
@@ -35,11 +42,6 @@
     "release:minor": "release-me minor",
     "release:commit": "release-me commit"
   },
-  "peerDependencies": {
-    "react": ">=18.0.0",
-    "react-dom": ">=18.0.0",
-    "vike": ">=0.4.182"
-  },
   "devDependencies": {
     "@biomejs/biome": "^1.6.4",
     "@brillout/release-me": "^0.3.8",
@@ -51,12 +53,9 @@
     "react-streaming": "^0.3.43",
     "rimraf": "^5.0.5",
     "typescript": "^5.5.4",
-    "vike": "^0.4.183",
+    "vike": "^0.4.191",
     "vite": "^5.4.0"
   },
-  "dependencies": {
-    "react-streaming": "^0.3.42"
-  },
   "typesVersions": {
     "*": {
       "useData": [
@@ -94,9 +93,13 @@
       ]
     }
   },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "files": [
     "dist/"
   ],
-  "repository": "github:vikejs/vike-react",
-  "license": "MIT"
+  "license": "MIT",
+  "keywords": [
+    "react"
+  ]
 }

package/dist/types/index.d.ts

@@ -1,2 +0,0 @@
-import './PageContext.js';
-import './Config.js';

package/dist/types/index.js

@@ -1,2 +0,0 @@
-import './PageContext.js';
-import './Config.js';