vike-solid 0.2.7 → 0.2.9

package/dist/+config.js

@@ -28,13 +28,15 @@ const toggleSsrRelatedConfig = ({
 var _config = {
   onRenderHtml: "import:vike-solid/renderer/onRenderHtml:onRenderHtml",
   onRenderClient: "import:vike-solid/renderer/onRenderClient:onRenderClient",
+  // TODO/next-major-release: remove pageProps (i.e. tell users to use data() instead of onBeforeRender() to fetch data)
+  // TODO/next-major-release: remove support for setting title over onBeforeRender()
   // A page can define an onBeforeRender() hook to be run on the server, which
   // can fetch data and return it as additional page context. Typically it will
   // return the page's root Solid component's props and additional data that can
   // be used by the renderers.
   // It is a cumulative config option, so a web app using vike-solid can extend
   // this list.
-  passToClient: ["pageProps", "title"],
+  passToClient: ["pageProps", "title", "lang"],
   clientRouting: true,
   hydrationCanBeAborted: true,
   meta: {
@@ -67,7 +69,8 @@ var _config = {
     },
     lang: {
       env: {
-        server: true
+        server: true,
+        client: true
       }
     },
     ssr: {

package/dist/+onRenderClient.js

@@ -1,13 +1,24 @@
 import { createComponent, Dynamic, mergeProps, memo, hydrate, render } from 'solid-js/web';
-import { P as PageContextProvider, u as usePageContext } from './PageContextProvider-gFteWsFt.js';
+import { P as PageContextProvider, u as usePageContext } from './PageContextProvider-OTjP33FZ.js';
 import { createStore, reconcile } from 'solid-js/store';
 import 'solid-js';
 
+function isCallable(thing) {
+  return thing instanceof Function || typeof thing === 'function';
+}
+
 /**
  * Get the page's title if defined, either from the additional data fetched by
- * the page's onBeforeRender() hook or from the config.
+ * the page's data() and onBeforeRender() hook or from the config.
  */
 function getTitle(pageContext) {
+  // from data() hook
+  if (pageContext.data?.title !== undefined) {
+    return pageContext.data.title;
+  }
+
+  // TODO/next-major-release: remove support for setting title over onBeforeRender()
+  // from onBeforeRender() hook
   if (pageContext.title !== undefined) {
     return pageContext.title;
   }
@@ -25,14 +36,12 @@ function getTitle(pageContext) {
   const {
     configDefinedAt
   } = titleConfig;
-  if (typeof title === "function") {
+  if (isCallable(title)) {
     const val = title(pageContext);
-    if (typeof val === "string") {
-      return val;
-    }
-    if (val) {
+    if (typeof val !== "string") {
       throw new Error(configDefinedAt + " should return a string");
     }
+    return val;
   }
   throw new Error(configDefinedAt + " should be a string or a function returning a string");
 }
@@ -63,6 +72,7 @@ function Layout(props) {
 }
 function Page() {
   const pageContext = usePageContext();
+  // TODO/next-major-release: remove pageProps (i.e. tell users to use data() instead of onBeforeRender() to fetch data)
   return createComponent(Dynamic, mergeProps({
     get component() {
       return pageContext.Page;
@@ -73,6 +83,39 @@ function Passthrough(props) {
   return memo(() => props.children);
 }
 
+/**
+ * Get the page's lang if defined, either from the config, the additional data fetched by
+ * the page's data() and onBeforeRender() hooks or from other hooks.
+ */
+function getLang(pageContext) {
+  // from onBeforeRoute() hook & other hooks, e.g. onPrerenderStart() hook
+  if (pageContext.lang !== undefined) {
+    return pageContext.lang;
+  }
+  const langConfig = pageContext.configEntries.lang?.[0];
+  if (!langConfig) {
+    return null;
+  }
+  const lang = langConfig.configValue;
+  if (typeof lang === 'string') {
+    return lang;
+  }
+  if (!lang) {
+    return null;
+  }
+  const {
+    configDefinedAt
+  } = langConfig;
+  if (isCallable(lang)) {
+    const val = lang(pageContext);
+    if (typeof val !== 'string') {
+      throw new Error(configDefinedAt + ' should return a string');
+    }
+    return val;
+  }
+  throw new Error(configDefinedAt + ' should be a string or a function returning a string');
+}
+
 // https://vike.dev/onRenderClient
 const [pageContextStore, setPageContext] = createStore({});
 let dispose;
@@ -101,7 +144,9 @@ const onRenderClient = async pageContext => {
     // previous page. It can even be null, in which case we should unset the
     // document title.
     const title = getTitle(pageContext);
+    const lang = getLang(pageContext) || 'en';
     document.title = title || "";
+    document.documentElement.lang = lang;
   }
 };
 

package/dist/+onRenderHtml.js

@@ -1,13 +1,24 @@
 import { createComponent, Dynamic, mergeProps, renderToString, renderToStream, generateHydrationScript } from 'solid-js/web';
 import { version, escapeInject, dangerouslySkipEscape, stampPipe } from 'vike/server';
-import { P as PageContextProvider, u as usePageContext } from './PageContextProvider-gFteWsFt.js';
+import { P as PageContextProvider, u as usePageContext } from './PageContextProvider-OTjP33FZ.js';
 import 'solid-js';
 
+function isCallable(thing) {
+  return thing instanceof Function || typeof thing === 'function';
+}
+
 /**
  * Get the page's title if defined, either from the additional data fetched by
- * the page's onBeforeRender() hook or from the config.
+ * the page's data() and onBeforeRender() hook or from the config.
  */
 function getTitle(pageContext) {
+  // from data() hook
+  if (pageContext.data?.title !== undefined) {
+    return pageContext.data.title;
+  }
+
+  // TODO/next-major-release: remove support for setting title over onBeforeRender()
+  // from onBeforeRender() hook
   if (pageContext.title !== undefined) {
     return pageContext.title;
   }
@@ -25,14 +36,12 @@ function getTitle(pageContext) {
   const {
     configDefinedAt
   } = titleConfig;
-  if (typeof title === "function") {
+  if (isCallable(title)) {
     const val = title(pageContext);
-    if (typeof val === "string") {
-      return val;
-    }
-    if (val) {
+    if (typeof val !== "string") {
       throw new Error(configDefinedAt + " should return a string");
     }
+    return val;
   }
   throw new Error(configDefinedAt + " should be a string or a function returning a string");
 }
@@ -63,6 +72,7 @@ function Layout(props) {
 }
 function Page() {
   const pageContext = usePageContext();
+  // TODO/next-major-release: remove pageProps (i.e. tell users to use data() instead of onBeforeRender() to fetch data)
   return createComponent(Dynamic, mergeProps({
     get component() {
       return pageContext.Page;
@@ -73,6 +83,39 @@ function Passthrough(props) {
   return props.children;
 }
 
+/**
+ * Get the page's lang if defined, either from the config, the additional data fetched by
+ * the page's data() and onBeforeRender() hooks or from other hooks.
+ */
+function getLang(pageContext) {
+  // from onBeforeRoute() hook & other hooks, e.g. onPrerenderStart() hook
+  if (pageContext.lang !== undefined) {
+    return pageContext.lang;
+  }
+  const langConfig = pageContext.configEntries.lang?.[0];
+  if (!langConfig) {
+    return null;
+  }
+  const lang = langConfig.configValue;
+  if (typeof lang === 'string') {
+    return lang;
+  }
+  if (!lang) {
+    return null;
+  }
+  const {
+    configDefinedAt
+  } = langConfig;
+  if (isCallable(lang)) {
+    const val = lang(pageContext);
+    if (typeof val !== 'string') {
+      throw new Error(configDefinedAt + ' should return a string');
+    }
+    return val;
+  }
+  throw new Error(configDefinedAt + ' should be a string or a function returning a string');
+}
+
 checkVikeVersion();
 const onRenderHtml = async pageContext => {
   const {
@@ -100,7 +143,7 @@ const onRenderHtml = async pageContext => {
       stampPipe(pageView, "node-stream");
     }
   }
-  const lang = pageContext.config.lang || "en";
+  const lang = getLang(pageContext) || "en";
   const documentHtml = escapeInject`<!DOCTYPE html>
     <html lang='${lang}'>
       <head>

package/dist/ClientOnly.js

@@ -1,7 +1,7 @@
 import { createComponent, Dynamic, ssr, ssrHydrationKey } from 'solid-js/web';
 import { createSignal, createEffect, Suspense, lazy } from 'solid-js';
 
-const _tmpl$ = ["<p", ">Error loading component.</p>"];
+var _tmpl$ = ["<p", ">Error loading component.</p>"];
 function ClientOnlyError() {
   return ssr(_tmpl$, ssrHydrationKey());
 }

package/dist/{PageContextProvider-gFteWsFt.js → PageContextProvider-OTjP33FZ.js}

@@ -32,5 +32,17 @@ function usePageContext() {
   if (!pageContext) throw new Error("<PageContextProvider> is needed for being able to use usePageContext()");
   return pageContext;
 }
+/** Access `pageContext.data` from any SolidJS component
+ *
+ * See
+ * - https://vike.dev/data
+ * - https://vike.dev/pageContext-anywhere
+ */
+function useData() {
+  const {
+    data
+  } = usePageContext();
+  return data;
+}
 
-export { PageContextProvider as P, usePageContext as u };
+export { PageContextProvider as P, useData as a, usePageContext as u };

package/dist/components/useData.d.ts

@@ -0,0 +1,2 @@
+export { a as useData } from '../useData-UNVtqljj.js';
+import 'vike/types';

package/dist/components/usePageContext.d.ts

@@ -1,6 +1,2 @@
-import { PageContext } from 'vike/types';
-
-/** Access the pageContext from any SolidJS component */
-declare function usePageContext(): PageContext;
-
-export { usePageContext };
+export { u as usePageContext } from '../useData-UNVtqljj.js';
+import 'vike/types';

package/dist/renderer/+config.d.ts

@@ -7,10 +7,15 @@ declare global {
     namespace Vike {
         interface PageContext {
             Page?: Page;
-            /** Properties of the page's root Solid component. */
+            /** Properties of the page's root Solid component - e.g. set by onBeforeRender() hook */
             pageProps?: Record<string, unknown>;
-            /** &lt;title>${title}&lt;/title> - has precedence over the config */
+            /** &lt;title>${title}&lt;/title> - set by onBeforeRender() hook, has precedence over the config */
             title?: string;
+            lang?: string;
+            data?: {
+                /** &lt;title>${title}&lt;/title> - set by data() hook, has precedence over the onBeforeRender() hook */
+                title?: string;
+            };
         }
     }
 }
@@ -52,6 +57,7 @@ declare const _default: {
         lang: {
             env: {
                 server: true;
+                client: true;
             };
         };
         ssr: {

package/dist/useData-UNVtqljj.d.ts

@@ -0,0 +1,13 @@
+import { PageContext } from 'vike/types';
+
+/** Access the pageContext from any SolidJS component */
+declare function usePageContext(): PageContext;
+/** Access `pageContext.data` from any SolidJS component
+ *
+ * See
+ * - https://vike.dev/data
+ * - https://vike.dev/pageContext-anywhere
+ */
+declare function useData<Data>(): Data;
+
+export { useData as a, usePageContext as u };

package/dist/useData.js

@@ -0,0 +1,3 @@
+export { a as useData } from './PageContextProvider-OTjP33FZ.js';
+import 'solid-js/web';
+import 'solid-js';

package/dist/usePageContext.js

@@ -1,3 +1,3 @@
-export { u as usePageContext } from './PageContextProvider-gFteWsFt.js';
+export { u as usePageContext } from './PageContextProvider-OTjP33FZ.js';
 import 'solid-js/web';
 import 'solid-js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vike-solid",
-  "version": "0.2.7",
+  "version": "0.2.9",
   "type": "module",
   "dependencies": {
     "vite-plugin-solid": "^2.8.0"
@@ -11,26 +11,27 @@
     "vike": "^0.4.152"
   },
   "devDependencies": {
-    "@babel/core": "^7.23.6",
-    "@babel/preset-env": "^7.23.6",
+    "@babel/core": "^7.23.7",
+    "@babel/preset-env": "^7.23.8",
     "@babel/preset-typescript": "^7.23.3",
     "@rollup/plugin-babel": "^6.0.4",
     "@rollup/plugin-node-resolve": "^15.2.3",
     "@types/node": "^18.17.4",
-    "babel-preset-solid": "^1.8.6",
+    "babel-preset-solid": "^1.8.9",
     "bumpp": "^9.2.1",
-    "rollup": "^4.9.1",
+    "rollup": "^4.9.5",
     "rollup-plugin-dts": "^6.1.0",
-    "solid-js": "^1.8.7",
+    "solid-js": "^1.8.11",
     "tslib": "^2.6.2",
     "typescript": "^5.3.3",
-    "vite": "^5.0.10",
-    "vike": "^0.4.152"
+    "vite": "^5.0.11",
+    "vike": "^0.4.156"
   },
   "exports": {
     ".": "./dist/+config.js",
     "./vite": "./dist/vite-plugin-vike-solid.js",
     "./usePageContext": "./dist/usePageContext.js",
+    "./useData": "./dist/useData.js",
     "./ClientOnly": "./dist/ClientOnly.js",
     "./renderer/onRenderHtml": "./dist/+onRenderHtml.js",
     "./renderer/onRenderClient": "./dist/+onRenderClient.js"
@@ -49,6 +50,9 @@
       "usePageContext": [
         "dist/components/usePageContext.d.ts"
       ],
+      "useData": [
+        "dist/components/useData.d.ts"
+      ],
       "ClientOnly": [
         "dist/components/ClientOnly.d.ts"
       ]