vike-solid 0.2.0 → 0.2.2

package/README.md

@@ -1,12 +1,11 @@
-[<img src="https://avatars.githubusercontent.com/u/86403530?s=200&v=4" align="right" width="64" height="64">](https://vike.dev)
+[<img src="https://vike.dev/vike-readme.svg" align="right" height="90">](https://vike.dev)
 [![npm version](https://img.shields.io/npm/v/vike-solid)](https://www.npmjs.com/package/vike-solid)
 
 # `vike-solid`
 
-SolidJS integration for [Vike](https://github.com/vikejs/vike/issues/736) (using the
-[V1 design](https://vike.dev/migration/v1-design)).
+SolidJS integration for [Vike](https://github.com/vikejs/vike) (using the [V1 design](https://vike.dev/migration/v1-design)).
 
 > [!NOTE]  
 > For integrations with React and Vue, see the other [`vike-*` packages](https://vike.dev/vike-packages).
 
-See [examples/](https://github.com/magne4000/vike-solid/tree/main/examples).
+See [examples/](https://github.com/vikejs/vike-solid/tree/main/examples).

package/dist/+config.js

@@ -1,5 +1,3 @@
-// We purposely define the ConfigVikeSolid interface in this file: that way we ensure it's always applied whenever the user `import vikeSolid from 'vike-solid'`
-
 // Depending on the value of `config.meta.ssr`, set other config options' `env`
 // accordingly.
 // See https://vike.dev/meta#modify-existing-configurations
@@ -23,8 +21,14 @@ const toggleSsrRelatedConfig = ({
   };
 };
 var _config = {
-  onRenderHtml: "import:vike-solid/renderer/onRenderHtml",
-  onRenderClient: "import:vike-solid/renderer/onRenderClient",
+  onRenderHtml: "import:vike-solid/renderer/onRenderHtml:onRenderHtml",
+  onRenderClient: "import:vike-solid/renderer/onRenderClient:onRenderClient",
+  // 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"],
   clientRouting: true,
   hydrationCanBeAborted: true,
@@ -41,6 +45,9 @@ var _config = {
     description: {
       env: "server-only"
     },
+    favicon: {
+      env: "server-only"
+    },
     lang: {
       env: "server-only"
     },
@@ -51,4 +58,6 @@ var _config = {
   }
 };
 
+// We purposely define the ConfigVikeSolid interface in this file: that way we ensure it's always applied whenever the user `import vikeSolid from 'vike-solid'`
+
 export { _config as default };

package/dist/+onRenderClient.js

@@ -1,18 +1,21 @@
 import { createComponent, Dynamic, mergeProps, memo, hydrate, render } from 'solid-js/web';
-import { P as PageContextProvider, u as usePageContext } from './usePageContext-a90cda5a.js';
+import { P as PageContextProvider, u as usePageContext } from './usePageContext-gFteWsFt.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.
+ */
 function getTitle(pageContext) {
-  if (typeof pageContext.title === "string") {
+  if (pageContext.title !== undefined) {
     return pageContext.title;
   }
-  if (pageContext.title) {
-    throw new Error("pageContext.title should be a string");
+  const titleConfig = pageContext.configEntries.title?.[0];
+  if (!titleConfig) {
+    return null;
   }
-  const {
-    title
-  } = pageContext.config;
+  const title = titleConfig.configValue;
   if (typeof title === "string") {
     return title;
   }
@@ -21,7 +24,7 @@ function getTitle(pageContext) {
   }
   const {
     configDefinedAt
-  } = pageContext.configEntries.title[0];
+  } = titleConfig;
   if (typeof title === "function") {
     const val = title(pageContext);
     if (typeof val === "string") {
@@ -70,10 +73,11 @@ function Passthrough(props) {
   return memo(() => props.children);
 }
 
+// https://vike.dev/onRenderClient
 const [pageContextStore, setPageContext] = createStore({});
 let dispose;
 let rendered = false;
-async function onRenderClient(pageContext) {
+const onRenderClient = async pageContext => {
   if (!rendered) {
     // Dispose to prevent duplicate pages when navigating.
     if (dispose) dispose();
@@ -92,6 +96,6 @@ async function onRenderClient(pageContext) {
   if (title !== null) {
     document.title = title;
   }
-}
+};
 
-export { onRenderClient as default };
+export { onRenderClient };

package/dist/+onRenderHtml.js

@@ -1,18 +1,21 @@
 import { createComponent, Dynamic, mergeProps, renderToString, renderToStream, generateHydrationScript } from 'solid-js/web';
 import { escapeInject, stampPipe, dangerouslySkipEscape } from 'vike/server';
-import { P as PageContextProvider, u as usePageContext } from './usePageContext-a90cda5a.js';
+import { P as PageContextProvider, u as usePageContext } from './usePageContext-gFteWsFt.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.
+ */
 function getTitle(pageContext) {
-  if (typeof pageContext.title === "string") {
+  if (pageContext.title !== undefined) {
     return pageContext.title;
   }
-  if (pageContext.title) {
-    throw new Error("pageContext.title should be a string");
+  const titleConfig = pageContext.configEntries.title?.[0];
+  if (!titleConfig) {
+    return null;
   }
-  const {
-    title
-  } = pageContext.config;
+  const title = titleConfig.configValue;
   if (typeof title === "string") {
     return title;
   }
@@ -21,7 +24,7 @@ function getTitle(pageContext) {
   }
   const {
     configDefinedAt
-  } = pageContext.configEntries.title[0];
+  } = titleConfig;
   if (typeof title === "function") {
     const val = title(pageContext);
     if (typeof val === "string") {
@@ -70,7 +73,7 @@ function Passthrough(props) {
   return props.children;
 }
 
-async function onRenderHtml(pageContext) {
+const onRenderHtml = async pageContext => {
   const title = getTitle(pageContext);
   const titleTag = !title ? "" : escapeInject`<title>${title}</title>`;
   const {
@@ -84,6 +87,8 @@ async function onRenderHtml(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
@@ -96,6 +101,7 @@ async function onRenderHtml(pageContext) {
       <head>
         <meta charset="UTF-8" />
         ${titleTag}
+        ${faviconTag}
         ${descriptionTag}
         ${dangerouslySkipEscape(headHtml)}
         ${dangerouslySkipEscape(generateHydrationScript())}
@@ -104,9 +110,7 @@ async function onRenderHtml(pageContext) {
         <div id="page-view">${pipe}</div>
       </body>
     </html>`;
-  return {
-    documentHtml
-  };
-}
+  return documentHtml;
+};
 
-export { onRenderHtml as default };
+export { onRenderHtml };

package/dist/{build-4b79b655.js → build-CLDbE5Ld.js}

@@ -1,5 +1,5 @@
 import { build } from 'vite';
-import { c as config } from './vite.config-2b9e1d28.js';
+import { c as config } from './vite.config-xLAJ7-PR.js';
 import 'vite-plugin-solid';
 import 'vike/plugin';
 

package/dist/components/usePageContext.d.ts

@@ -1,42 +1,6 @@
-import * as vike_dist_esm_shared_types from 'vike/dist/esm/shared/types';
-import * as vike_dist_esm_shared_addUrlComputedProps from 'vike/dist/esm/shared/addUrlComputedProps';
-import * as vike_dist_esm_shared_getPageFiles_getExports from 'vike/dist/esm/shared/getPageFiles/getExports';
-import * as vike_dist_esm_shared_page_configs_Config_PageContextConfig from 'vike/dist/esm/shared/page-configs/Config/PageContextConfig';
+import { PageContext } from 'vike/types';
 
 /** Access the pageContext from any SolidJS component */
-declare function usePageContext(): (Partial<{
-    Page: unknown;
-    routeParams: Record<string, string>;
-    config: vike_dist_esm_shared_page_configs_Config_PageContextConfig.PageContextConfig;
-    configEntries: vike_dist_esm_shared_getPageFiles_getExports.ConfigEntries;
-    exports: Record<string, unknown>;
-    exportsAll: vike_dist_esm_shared_getPageFiles_getExports.ExportsAll;
-    urlOriginal: string;
-    is404: boolean | null;
-    isClientSideNavigation: boolean;
-    abortReason?: unknown;
-    abortStatusCode?: undefined;
-    errorWhileRendering?: unknown;
-    url: string;
-    pageExports: Record<string, unknown>;
-}> & Pick<{
-    Page: unknown;
-    routeParams: Record<string, string>;
-    config: vike_dist_esm_shared_page_configs_Config_PageContextConfig.PageContextConfig;
-    configEntries: vike_dist_esm_shared_getPageFiles_getExports.ConfigEntries;
-    exports: Record<string, unknown>;
-    exportsAll: vike_dist_esm_shared_getPageFiles_getExports.ExportsAll;
-    urlOriginal: string;
-    is404: boolean | null;
-    isClientSideNavigation: boolean;
-    abortReason?: unknown;
-    abortStatusCode?: undefined;
-    errorWhileRendering?: unknown;
-    url: string;
-    pageExports: Record<string, unknown>;
-}, "Page" | "pageExports" | "config" | "configEntries" | "exports" | "exportsAll" | "abortReason"> & {
-    isHydration: boolean;
-    isBackwardNavigation: boolean | null;
-} & vike_dist_esm_shared_addUrlComputedProps.PageContextUrlComputedPropsClient & Vike.PageContext) | vike_dist_esm_shared_types.PageContextServer;
+declare function usePageContext(): PageContext;
 
 export { usePageContext };

package/dist/{dev-dfbf584d.js → dev-WJHjvirM.js}

@@ -1,5 +1,5 @@
 import { createServer } from 'vite';
-import { c as config } from './vite.config-2b9e1d28.js';
+import { c as config } from './vite.config-xLAJ7-PR.js';
 import 'vite-plugin-solid';
 import 'vike/plugin';
 

package/dist/index.js

@@ -3,13 +3,13 @@ const cmd = parseCliArgs();
 cli();
 async function cli() {
   if (cmd === "dev") {
-    await import('./dev-dfbf584d.js');
+    await import('./dev-WJHjvirM.js');
   }
   if (cmd === "build") {
-    await import('./build-4b79b655.js');
+    await import('./build-CLDbE5Ld.js');
   }
   if (cmd === "preview") {
-    await import('./preview-535a0307.js');
+    await import('./preview-Bir7ASwQ.js');
   }
 }
 function parseCliArgs() {

package/dist/{preview-535a0307.js → preview-Bir7ASwQ.js}

@@ -1,5 +1,5 @@
 import { preview } from 'vite';
-import { c as config } from './vite.config-2b9e1d28.js';
+import { c as config } from './vite.config-xLAJ7-PR.js';
 import 'vite-plugin-solid';
 import 'vike/plugin';
 

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

@@ -6,16 +6,18 @@ type PageProps = Record<string, unknown>;
 declare global {
     namespace Vike {
         interface PageContext {
-            Page: Page;
-            pageProps: Record<string, unknown>;
+            Page?: Page;
+            /** Properties of the page's root Solid component. */
+            pageProps?: Record<string, unknown>;
+            /** &lt;title>${title}&lt;/title> - has precedence over the config */
             title?: string;
         }
     }
 }
 
 declare const _default: {
-    onRenderHtml: "import:vike-solid/renderer/onRenderHtml";
-    onRenderClient: "import:vike-solid/renderer/onRenderClient";
+    onRenderHtml: "import:vike-solid/renderer/onRenderHtml:onRenderHtml";
+    onRenderClient: "import:vike-solid/renderer/onRenderClient:onRenderClient";
     passToClient: string[];
     clientRouting: true;
     hydrationCanBeAborted: true;
@@ -32,6 +34,9 @@ declare const _default: {
         description: {
             env: "server-only";
         };
+        favicon: {
+            env: "server-only";
+        };
         lang: {
             env: "server-only";
         };
@@ -50,6 +55,7 @@ declare global {
             Layout?: Component;
             title?: string | ((pageContext: PageContext) => string);
             description?: string;
+            favicon?: string;
             /**
              * @default 'en'
              */

package/dist/usePageContext.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vike-solid",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "type": "module",
   "exports": {
     ".": "./dist/+config.js",
@@ -10,29 +10,29 @@
     "./renderer/onRenderClient": "./dist/+onRenderClient.js"
   },
   "dependencies": {
-    "vite-plugin-solid": "^2.7.0"
+    "vite-plugin-solid": "^2.7.2"
   },
   "peerDependencies": {
-    "solid-js": "^1.7.12",
-    "vite": "^4.4.9",
-    "vike": "^0.4.142"
+    "solid-js": "^1.8.3",
+    "vite": "^4.5.0",
+    "vike": "^0.4.144"
   },
   "devDependencies": {
-    "@babel/core": "^7.22.20",
-    "@babel/preset-env": "^7.22.20",
-    "@babel/preset-typescript": "^7.22.15",
-    "@rollup/plugin-babel": "^6.0.3",
-    "@rollup/plugin-node-resolve": "^15.2.1",
+    "@babel/core": "^7.23.2",
+    "@babel/preset-env": "^7.23.2",
+    "@babel/preset-typescript": "^7.23.2",
+    "@rollup/plugin-babel": "^6.0.4",
+    "@rollup/plugin-node-resolve": "^15.2.3",
     "@types/node": "^18.17.4",
-    "babel-preset-solid": "^1.7.12",
+    "babel-preset-solid": "^1.8.2",
     "bumpp": "^9.2.0",
-    "rollup": "^3.29.2",
-    "rollup-plugin-dts": "^6.0.2",
-    "solid-js": "^1.7.12",
+    "rollup": "^4.1.4",
+    "rollup-plugin-dts": "^6.1.0",
+    "solid-js": "^1.8.3",
     "tslib": "^2.6.2",
     "typescript": "^5.2.2",
-    "vite": "^4.4.9",
-    "vike": "^0.4.142"
+    "vite": "^4.5.0",
+    "vike": "^0.4.144"
   },
   "typesVersions": {
     "*": {
@@ -57,7 +57,7 @@
   "bin": "./cli/entry.js",
   "main": "dist/+config.js",
   "types": "dist/renderer/+config.d.ts",
-  "repository": "github:magne4000/vike-solid",
+  "repository": "github:vikejs/vike-solid",
   "license": "MIT",
   "scripts": {
     "dev": "rollup -c rollup.config.js --watch",