vike-react 0.5.7 → 0.5.9

package/LICENSE.md

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2023-present Romuald Brillout
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,2 +1 @@
-Docs: [vike.dev/vike-react](https://vike.dev/vike-react)  
-Source code: [GitHub > vikejs/vike-react](https://github.com/vikejs/vike-react)
+See [Vike Docs > vike-react](https://vike.dev/vike-react).

package/dist/{+config.d.ts → config.d.ts}

@@ -5,7 +5,7 @@ declare const config: {
     require: {
         vike: string;
     };
-    Loading: "import:vike-react/__internal/components/Loading:default";
+    Loading: "import:vike-react/__internal/integration/Loading:default";
     onRenderHtml: "import:vike-react/__internal/integration/onRenderHtml:onRenderHtml";
     onRenderClient: "import:vike-react/__internal/integration/onRenderClient:onRenderClient";
     passToClient: string[];
@@ -102,6 +102,12 @@ declare const config: {
                 server: true;
             };
         };
+        onBeforeRenderHtml: {
+            env: {
+                server: true;
+            };
+            cumulative: true;
+        };
         onAfterRenderHtml: {
             env: {
                 server: true;

package/dist/{+config.js → config.js}

@@ -2,15 +2,17 @@ export { config as default };
 import { ssrEffect } from './integration/ssrEffect.js';
 import { isNotFalse } from './utils/isNotFalse.js';
 const config = {
+    // @eject-remove start
     name: 'vike-react',
     require: {
         vike: '>=0.4.182',
     },
-    Loading: 'import:vike-react/__internal/components/Loading:default',
+    Loading: 'import:vike-react/__internal/integration/Loading:default',
     // https://vike.dev/onRenderHtml
     onRenderHtml: 'import:vike-react/__internal/integration/onRenderHtml:onRenderHtml',
     // https://vike.dev/onRenderClient
     onRenderClient: 'import:vike-react/__internal/integration/onRenderClient:onRenderClient',
+    // @eject-remove end
     passToClient: [
         '_configFromHook',
         // https://github.com/vikejs/vike-react/issues/25
@@ -78,6 +80,10 @@ const config = {
         streamIsRequired: {
             env: { server: true },
         },
+        onBeforeRenderHtml: {
+            env: { server: true },
+            cumulative: true,
+        },
         onAfterRenderHtml: {
             env: { server: true },
             cumulative: true,
@@ -102,6 +108,8 @@ const config = {
         },
     },
 };
+// @eject-remove start
 // 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';
+// @eject-remove end

package/dist/index.d.ts

@@ -1 +1 @@
-export { default } from './+config.js';
+export { 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 { default } from './config.js';

package/dist/integration/onRenderHtml.js

@@ -32,27 +32,26 @@ const onRenderHtml = async (pageContext) => {
     </html>`;
 };
 async function getPageHtml(pageContext) {
-    let pageHtml;
-    if (!pageContext.Page) {
-        pageHtml = '';
-    }
-    else {
-        const { page } = getPageElement(pageContext);
+    if (pageContext.Page)
+        pageContext.page = getPageElement(pageContext).page;
+    // https://github.com/vikejs/vike-react/issues/87#issuecomment-2488742744
+    await callCumulativeHooks(pageContext.config.onBeforeRenderHtml, pageContext);
+    let pageHtml = '';
+    if (pageContext.page) {
         const { stream, streamIsRequired } = pageContext.config;
         if (!stream && !streamIsRequired) {
-            const pageHtmlString = renderToString(page);
+            const pageHtmlString = renderToString(pageContext.page);
             pageContext.pageHtmlString = pageHtmlString;
             pageHtml = dangerouslySkipEscape(pageHtmlString);
         }
         else {
-            const disable = stream === false ? true : undefined;
-            const pageHtmlStream = await renderToStream(page, {
+            const pageHtmlStream = await renderToStream(pageContext.page, {
                 webStream: typeof stream === 'string' ? stream === 'web' : undefined,
                 userAgent: pageContext.headers?.['user-agent'] ||
                     // TODO/eventually: remove old way of acccessing the User Agent header.
                     // @ts-ignore
                     pageContext.userAgent,
-                disable,
+                disable: stream === false ? true : undefined,
             });
             pageContext.pageHtmlStream = pageHtmlStream;
             pageHtml = pageHtmlStream;

package/dist/integration/styles.css

@@ -1,4 +1,4 @@
-/* For components/Loading.tsx */
+/* For integration/Loading.tsx */
 @keyframes vike-react-shine {
   to {
     background-position-x: -200%;

package/dist/types/Config.d.ts

@@ -165,11 +165,17 @@ declare global {
              */
             reactStrictMode?: boolean;
             /**
-             * Server-side hook called right after rendering the page's root React component to HTML.
+             * Hook called right before rendering the page's root React component to HTML.
+             *
+             * https://vike.dev/onBeforeRenderHtml
+             */
+            onBeforeRenderHtml?: ((pageContext: PageContextServer) => void) | ImportString;
+            /**
+             * Hook called right after rendering the page's root React component to HTML.
              *
              * https://vike.dev/onAfterRenderHtml
              */
-            onAfterRenderHtml?: (pageContext: PageContextServer) => void;
+            onAfterRenderHtml?: ((pageContext: PageContextServer) => void) | ImportString;
             /**
              * Client-side hook called before the page is rendered.
              *
@@ -197,6 +203,7 @@ declare global {
             bodyHtmlEnd?: BodyHtmlBoundary[];
             bodyAttributes?: TagAttributes[];
             htmlAttributes?: TagAttributes[];
+            onBeforeRenderHtml?: Function[];
             onAfterRenderHtml?: Function[];
             onBeforeRenderClient?: Function[];
             onAfterRenderClient?: Function[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vike-react",
-  "version": "0.5.7",
+  "version": "0.5.9",
   "repository": "https://github.com/vikejs/vike-react",
   "type": "module",
   "exports": {
@@ -21,10 +21,10 @@
     "./clientOnly": "./dist/helpers/clientOnly.js",
     "./ClientOnly": "./dist/components/ClientOnly.js",
     ".": "./dist/index.js",
-    "./config": "./dist/+config.js",
+    "./config": "./dist/config.js",
     "./__internal/integration/onRenderHtml": "./dist/integration/onRenderHtml.js",
     "./__internal/integration/onRenderClient": "./dist/integration/onRenderClient.js",
-    "./__internal/components/Loading": "./dist/components/Loading.js"
+    "./__internal/integration/Loading": "./dist/integration/Loading.js"
   },
   "dependencies": {
     "react-streaming": "^0.3.42"
@@ -34,17 +34,9 @@
     "react-dom": ">=18.0.0",
     "vike": ">=0.4.182"
   },
-  "scripts": {
-    "dev": "tsc --watch",
-    "build": "rimraf dist/ && tsc && pnpm run build:css",
-    "build:css": "cp src/integration/styles.css dist/integration/styles.css",
-    "release": "release-me patch",
-    "release:minor": "release-me minor",
-    "release:commit": "release-me commit"
-  },
   "devDependencies": {
     "@biomejs/biome": "^1.6.4",
-    "@brillout/release-me": "^0.3.8",
+    "@brillout/release-me": "^0.4.2",
     "@types/node": "^20.11.17",
     "@types/react": "^18.2.55",
     "@types/react-dom": "^18.2.19",
@@ -53,7 +45,7 @@
     "react-streaming": "^0.3.43",
     "rimraf": "^5.0.5",
     "typescript": "^5.5.4",
-    "vike": "^0.4.191",
+    "vike": "^0.4.203",
     "vite": "^5.4.0"
   },
   "typesVersions": {
@@ -83,7 +75,7 @@
         "./dist/index.d.ts"
       ],
       "config": [
-        "./dist/+config.d.ts"
+        "./dist/config.d.ts"
       ],
       "__/internal/integration/onRenderHtml": [
         "./dist/integration/onRenderHtml.d.ts"
@@ -101,5 +93,13 @@
   "license": "MIT",
   "keywords": [
     "react"
-  ]
-}
+  ],
+  "scripts": {
+    "dev": "tsc --watch",
+    "build": "rimraf dist/ && tsc && pnpm run build:css",
+    "build:css": "cp src/integration/styles.css dist/integration/styles.css",
+    "release": "release-me patch",
+    "release:minor": "release-me minor",
+    "release:commit": "release-me commit"
+  }
+}