vike-react 0.4.10 → 0.4.12

package/dist/+config.d.ts

@@ -2,6 +2,9 @@ import { ssrEffect } from './renderer/ssrEffect.js';
 import './types/index.js';
 declare const _default: {
     name: string;
+    require: {
+        vike: string;
+    };
     onRenderHtml: "import:vike-react/renderer/onRenderHtml:onRenderHtml";
     onRenderClient: "import:vike-react/renderer/onRenderClient:onRenderClient";
     passToClient: string[];
@@ -48,7 +51,7 @@ declare const _default: {
                 server: true;
             };
         };
-        _streamIsRequied: {
+        streamIsRequired: {
             env: {
                 server: true;
             };
@@ -80,6 +83,11 @@ declare const _default: {
                 config: true;
             };
         };
+        require: {
+            env: {
+                config: true;
+            };
+        };
         reactStrictMode: {
             env: {
                 client: true;

package/dist/+config.js

@@ -4,6 +4,9 @@ import { ssrEffect } from './renderer/ssrEffect.js';
 import './types/index.js';
 export default {
     name: 'vike-react',
+    require: {
+        vike: '>=0.4.173'
+    },
     // https://vike.dev/onRenderHtml
     onRenderHtml: 'import:vike-react/renderer/onRenderHtml:onRenderHtml',
     // https://vike.dev/onRenderClient
@@ -39,7 +42,7 @@ export default {
         stream: {
             env: { server: true }
         },
-        _streamIsRequied: {
+        streamIsRequired: {
             env: { server: true }
         },
         onBeforeRenderClient: {
@@ -54,10 +57,14 @@ export default {
         Wrapper: {
             env: { client: true, server: true }
         },
-        // Vike already defines the setting 'name', but we redundantly define it here for older Vike versions (otherwise older Vike versions will complain that 'name` is an unknown config).
+        // Vike already defines the setting 'name', but we redundantly define it here for older Vike versions (otherwise older Vike versions will complain that 'name` is an unknown config). TODO/eventually: remove this once <=0.4.172 versions become rare (also because we use the `require` setting starting from `0.4.173`).
         name: {
             env: { config: true }
         },
+        // Vike already defines the setting 'require', but we redundantly define it here for older Vike versions (otherwise older Vike versions will complain that 'require` is an unknown config). TODO/eventually: remove this once <=0.4.172 versions become rare (also because we use the `require` setting starting from `0.4.173`).
+        require: {
+            env: { config: true }
+        },
         reactStrictMode: {
             env: { client: true, server: true }
         }

package/dist/hooks/usePageContext.d.ts

@@ -6,5 +6,9 @@ declare function PageContextProvider({ pageContext, children }: {
     pageContext: PageContext;
     children: React.ReactNode;
 }): React.JSX.Element;
-/** Access the pageContext from any React component */
+/**
+ * Access `pageContext` from any React component.
+ *
+ * https://vike.dev/usePageContext
+ */
 declare function usePageContext(): PageContext;

package/dist/hooks/usePageContext.js

@@ -2,22 +2,20 @@ export { usePageContext };
 export { PageContextProvider };
 import React, { useContext } from 'react';
 import { getGlobalObject } from '../utils/getGlobalObject.js';
-import { assert } from '../utils/assert.js';
 const globalObject = getGlobalObject('PageContextProvider.ts', {
     reactContext: React.createContext(undefined)
 });
 function PageContextProvider({ pageContext, children }) {
-    assert(pageContext);
     const { reactContext } = globalObject;
     return React.createElement(reactContext.Provider, { value: pageContext }, children);
 }
-/** Access the pageContext from any React component */
+/**
+ * Access `pageContext` from any React component.
+ *
+ * https://vike.dev/usePageContext
+ */
 function usePageContext() {
     const { reactContext } = globalObject;
     const pageContext = useContext(reactContext);
-    /* React throws an error upon wrong hook usage, so I guess a nice error message isn't needed? And I guess we can therefore assume and assert pageContext to have been provided? Let's see if users report back an assert() failure.
-    if (!pageContext) throw new Error('<PageContextProvider> is needed for being able to use usePageContext()')
-    */
-    assert(pageContext);
     return pageContext;
 }

package/dist/renderer/onRenderHtml.js

@@ -28,15 +28,18 @@ const onRenderHtml = async (pageContext) => {
     }
     else {
         const page = getPageElement(pageContext);
-        const { stream, 
-        // @ts-expect-error
-        _streamIsRequied } = pageContext.config;
-        if (!stream && !_streamIsRequied) {
+        const { stream, streamIsRequired } = pageContext.config;
+        if (!stream && !streamIsRequired) {
             pageView = dangerouslySkipEscape(renderToString(page));
         }
         else {
             const disable = stream === false ? true : undefined;
-            pageView = await renderToStream(page, { userAgent: pageContext.userAgent, disable });
+            pageView = await renderToStream(page, {
+                userAgent: pageContext.headers?.['user-agent'] ||
+                    // Deprecated way of acccessing User Agent header. Eventually remove it.
+                    pageContext.userAgent,
+                disable
+            });
         }
     }
     const documentHtml = escapeInject `<!DOCTYPE html>
@@ -53,6 +56,8 @@ const onRenderHtml = async (pageContext) => {
     </html>`;
     return documentHtml;
 };
+// We don't need this anymore starting from vike@0.4.173 which added the `require` setting.
+// TODO/eventually: remove this once <=0.4.172 versions become rare.
 function checkVikeVersion() {
     if (version) {
         const versionParts = version.split('.').map((s) => parseInt(s, 10));
@@ -60,10 +65,11 @@ function checkVikeVersion() {
             return;
         if (versionParts[1] > 4)
             return;
-        if (versionParts[2] >= 147)
+        if (versionParts[2] >= 173)
             return;
     }
-    throw new Error('Update Vike to 0.4.147 or above');
+    // We can leave it 0.4.173 until we entirely remove checkVikeVersion() (because starting vike@0.4.173 we use the new `require` setting).
+    throw new Error('Update Vike to 0.4.173 or above');
 }
 // Used by:
 // - react-streaming (to improve error messages, see https://github.com/brillout/react-streaming/blob/70c168de1e97b9c4385a4c3002b5013f1e406341/src/utils/isVikeReactApp.ts#L4)

package/dist/types/Config.d.ts

@@ -1,7 +1,7 @@
 import type { PageContextClient } from 'vike/types';
 declare global {
-    namespace VikePackages {
-        interface ConfigVikeReact {
+    namespace Vike {
+        interface Config {
             /** The page's root React component */
             Page?: () => React.ReactNode;
             /** React element rendered and appended into <head></head> */
@@ -54,6 +54,12 @@ declare global {
              *
              */
             stream?: boolean;
+            /**
+             * Whether the existence of the React SSR stream is required (some integrations require it).
+             *
+             * HTML Streaming can still be disabled: the SSR stream is awaited and converted to a string.
+             */
+            streamIsRequired?: boolean;
             /**
              * Whether to use `<StrictMode>`.
              *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vike-react",
-  "version": "0.4.10",
+  "version": "0.4.12",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -21,14 +21,14 @@
     "release:commit": "release-me commit"
   },
   "peerDependencies": {
-    "react": "18.x.x",
-    "react-dom": "18.x.x",
-    "vike": "^0.4.160",
-    "vite": "^4.3.8 || ^5.0.10"
+    "react": ">=18.0.0",
+    "react-dom": ">=18.0.0",
+    "vike": ">=0.4.173",
+    "vite": ">=4.3.8"
   },
   "devDependencies": {
     "@biomejs/biome": "^1.6.4",
-    "@brillout/release-me": "^0.3.4",
+    "@brillout/release-me": "^0.3.8",
     "@types/node": "^20.11.17",
     "@types/react": "^18.2.55",
     "@types/react-dom": "^18.2.19",
@@ -36,7 +36,7 @@
     "react-dom": "^18.2.0",
     "rimraf": "^5.0.5",
     "typescript": "^5.3.3",
-    "vike": "^0.4.168"
+    "vike": "^0.4.173"
   },
   "dependencies": {
     "react-streaming": "^0.3.27"

package/dist/utils/assert.d.ts

@@ -1 +0,0 @@
-export declare function assert(condition: unknown): asserts condition;

package/dist/utils/assert.js

@@ -1,5 +0,0 @@
-export function assert(condition) {
-    if (condition)
-        return;
-    throw new Error('You stumbled upon a vike-react bug. Go to https://github.com/vikejs/vike-react/issues/new and copy-paste this error. A maintainer will fix the bug (usually under 24 hours).');
-}