vike-solid 0.2.6 → 0.2.8

package/LICENSE.md

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2023-present Joël Charles
+
+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

@@ -3,7 +3,7 @@
 
 # `vike-solid`
 
-SolidJS integration for [Vike](https://github.com/vikejs/vike) (using the [V1 design](https://vike.dev/migration/v1-design)).
+SolidJS integration for [Vike](https://github.com/vikejs/vike).
 
 > [!NOTE]  
 > For integrations with React and Vue, see the other [`vike-*` packages](https://vike.dev/vike-packages).

package/dist/+config.js

@@ -28,6 +28,8 @@ 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
@@ -75,6 +77,11 @@ var _config = {
         config: true
       },
       effect: toggleSsrRelatedConfig
+    },
+    stream: {
+      env: {
+        server: true
+      }
     }
   }
 };

package/dist/+onRenderClient.js

@@ -1,13 +1,20 @@
 import { createComponent, Dynamic, mergeProps, memo, hydrate, render } from 'solid-js/web';
-import { P as PageContextProvider, u as usePageContext } from './usePageContext-gFteWsFt.js';
+import { P as PageContextProvider, u as usePageContext } from './PageContextProvider-OTjP33FZ.js';
 import { createStore, reconcile } from 'solid-js/store';
 import 'solid-js';
 
 /**
  * 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;
   }
@@ -63,6 +70,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;

package/dist/+onRenderHtml.js

@@ -1,13 +1,20 @@
 import { createComponent, Dynamic, mergeProps, renderToString, renderToStream, generateHydrationScript } from 'solid-js/web';
-import { version, escapeInject, stampPipe, dangerouslySkipEscape } from 'vike/server';
-import { P as PageContextProvider, u as usePageContext } from './usePageContext-gFteWsFt.js';
+import { version, escapeInject, dangerouslySkipEscape, stampPipe } from 'vike/server';
+import { P as PageContextProvider, u as usePageContext } from './PageContextProvider-OTjP33FZ.js';
 import 'solid-js';
 
 /**
  * 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;
   }
@@ -63,6 +70,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;
@@ -75,12 +83,15 @@ function Passthrough(props) {
 
 checkVikeVersion();
 const onRenderHtml = async pageContext => {
-  const title = getTitle(pageContext);
-  const titleTag = !title ? "" : escapeInject`<title>${title}</title>`;
   const {
+    stream,
+    favicon,
     description
   } = pageContext.config;
-  const descriptionTag = !description ? "" : escapeInject`<meta name="description" content="${description}" />`;
+  const title = getTitle(pageContext);
+  const titleTag = !title ? "" : escapeInject`<title>${title}</title>`;
+  const faviconTag = !favicon ? '' : escapeInject`<link rel="icon" href="${favicon}" />`;
+  const descriptionTag = !description ? '' : escapeInject`<meta name="description" content="${description}" />`;
   const Head = pageContext.config.Head || (() => []);
   const headHtml = renderToString(() => createComponent(PageContextProvider, {
     pageContext: pageContext,
@@ -88,14 +99,15 @@ const onRenderHtml = async pageContext => {
       return createComponent(Head, {});
     }
   }));
-  const favicon = pageContext.config.favicon;
-  const faviconTag = !favicon ? '' : escapeInject`<link rel="icon" href="${favicon}" />`;
-  const {
-    pipe
-  } = renderToStream(() => !pageContext.Page ? [] // the ssr config flag is false
-  : getPageElement(pageContext));
-  // const asString = renderToString(() => page);
-  stampPipe(pipe, "node-stream");
+  let pageView = '';
+  if (!!pageContext.Page) {
+    if (!stream) {
+      pageView = dangerouslySkipEscape(renderToString(() => getPageElement(pageContext)));
+    } else {
+      pageView = renderToStream(() => getPageElement(pageContext)).pipe;
+      stampPipe(pageView, "node-stream");
+    }
+  }
   const lang = pageContext.config.lang || "en";
   const documentHtml = escapeInject`<!DOCTYPE html>
     <html lang='${lang}'>
@@ -108,7 +120,7 @@ const onRenderHtml = async pageContext => {
         ${dangerouslySkipEscape(generateHydrationScript())}
       </head>
       <body>
-        <div id="page-view">${pipe}</div>
+        <div id="page-view">${pageView}</div>
       </body>
       <!-- built with https://github.com/vikejs/vike-solid -->
     </html>`;

package/dist/{usePageContext-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/ClientOnly.d.ts

@@ -1,4 +1,4 @@
-import { Component, JSX, createSignal } from 'solid-js';
+import { Component, JSX } from 'solid-js';
 
 declare function ClientOnly<T>(props: {
     load: () => Promise<{
@@ -6,7 +6,6 @@ declare function ClientOnly<T>(props: {
     } | Component<T>>;
     children: (Component: Component<T>) => JSX.Element;
     fallback: JSX.Element;
-    deps?: Parameters<typeof createSignal>[1];
 }): JSX.Element;
 
 export { ClientOnly };

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,14 @@ 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;
+            data?: {
+                /** &lt;title>${title}&lt;/title> - set by data() hook, has precedence over the onBeforeRender() hook */
+                title?: string;
+            };
         }
     }
 }
@@ -60,14 +64,22 @@ declare const _default: {
             };
             effect: ConfigEffect;
         };
+        stream: {
+            env: {
+                server: true;
+            };
+        };
     };
 };
 
 declare global {
     namespace VikePackages {
         interface ConfigVikeSolid {
+            /** The page's root Solid component */
+            Page?: Component;
             /** Solid element renderer and appended into <head></head> */
             Head?: Component;
+            /** A component, usually common to several pages, that wraps the root component `Page` */
             Layout?: Component;
             title?: string | ((pageContext: PageContext) => string);
             description?: string;
@@ -88,8 +100,13 @@ declare global {
              *
              */
             ssr?: boolean;
-            /** The page's root Solid component */
-            Page?: Component;
+            /**
+             * Whether to stream the page's HTML. Requires Server-Side Rendering (`ssr: true`).
+             *
+             * @default false
+             *
+             */
+            stream?: boolean;
         }
     }
 }

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 './usePageContext-gFteWsFt.js';
+export { u as usePageContext } from './PageContextProvider-OTjP33FZ.js';
 import 'solid-js/web';
 import 'solid-js';

package/package.json

@@ -1,36 +1,37 @@
 {
   "name": "vike-solid",
-  "version": "0.2.6",
+  "version": "0.2.8",
   "type": "module",
   "dependencies": {
-    "vite-plugin-solid": "^2.7.2"
+    "vite-plugin-solid": "^2.8.0"
   },
   "peerDependencies": {
-    "solid-js": "^1.8.6",
+    "solid-js": "^1.8.7",
     "vite": "^4.4 || ^5.0.2",
-    "vike": "^0.4.147"
+    "vike": "^0.4.152"
   },
   "devDependencies": {
-    "@babel/core": "^7.23.3",
-    "@babel/preset-env": "^7.23.3",
+    "@babel/core": "^7.23.7",
+    "@babel/preset-env": "^7.23.7",
     "@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",
-    "bumpp": "^9.2.0",
-    "rollup": "^4.6.0",
+    "bumpp": "^9.2.1",
+    "rollup": "^4.9.2",
     "rollup-plugin-dts": "^6.1.0",
-    "solid-js": "^1.8.6",
+    "solid-js": "^1.8.7",
     "tslib": "^2.6.2",
-    "typescript": "^5.3.2",
-    "vite": "^5.0.2",
-    "vike": "^0.4.147"
+    "typescript": "^5.3.3",
+    "vite": "^5.0.10",
+    "vike": "^0.4.153"
   },
   "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"
       ]