qual: add hook types

Aligning with * vikejs/vike#1180 * vikejs/vike#1181 * vikejs/vike#1191 * vikejs/vike#1201
vikejs · Oct 23, 2023 · 532ae32 · 532ae32
1 parent 0581094
commit 532ae32
Show file tree

Hide file tree

Showing 9 changed files with 47 additions and 65 deletions.
diff --git a/examples/basic/package.json b/examples/basic/package.json
@@ -11,7 +11,7 @@
     "node-fetch": "^3.3.2",
     "solid-js": "^1.7.11",
     "vike-solid": "workspace:*",
-    "vike": "^0.4.142"
+    "vike": "^0.4.144"
   },
   "devDependencies": {
     "typescript": "^5.1.6"

diff --git a/examples/basic/pages/star-wars/@id/+onBeforeRender.ts b/examples/basic/pages/star-wars/@id/+onBeforeRender.ts
@@ -1,11 +1,14 @@
-export default onBeforeRender;
+// https://vike.dev/onBeforeRender
+export { onBeforeRender };
 
 import fetch from "cross-fetch";
-import type { PageContext } from "vike/types";
+import type { OnBeforeRenderAsync } from "vike/types";
 import { filterMovieData } from "../filterMovieData";
 import type { MovieDetails } from "../types";
 
-async function onBeforeRender(pageContext: PageContext) {
+const onBeforeRender: OnBeforeRenderAsync = async (
+  pageContext
+): ReturnType<OnBeforeRenderAsync> => {
   const response = await fetch(
     `https://star-wars.brillout.com/api/films/${pageContext.routeParams?.id}.json`
   );
@@ -26,4 +29,4 @@ async function onBeforeRender(pageContext: PageContext) {
       title,
     },
   };
-}
+};
diff --git a/examples/basic/pages/star-wars/index/+onBeforeRender.ts b/examples/basic/pages/star-wars/index/+onBeforeRender.ts
@@ -1,12 +1,16 @@
-export default onBeforeRender;
+// https://vike.dev/onBeforeRender
+export { onBeforeRender };
 
 import fetch from "node-fetch";
 //import { filterMovieData } from '../filterMovieData'
 import type { Movie, MovieDetails } from "../types";
+import type { OnBeforeRenderAsync } from "vike/types";
 
 // export { prerender }
 
-async function onBeforeRender() {
+const onBeforeRender: OnBeforeRenderAsync = async (
+  pageContext
+): ReturnType<OnBeforeRenderAsync> => {
   const movies = await getStarWarsMovies();
   return {
     pageContext: {

diff --git a/examples/ssr-spa/package.json b/examples/ssr-spa/package.json
@@ -9,7 +9,7 @@
   "dependencies": {
     "solid-js": "^1.7.11",
     "vike-solid": "workspace:*",
-    "vike": "^0.4.142"
+    "vike": "^0.4.144"
   },
   "devDependencies": {
     "typescript": "^5.1.6"

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/vike-solid/package.json b/vike-solid/package.json
@@ -20,7 +20,7 @@
   "peerDependencies": {
     "solid-js": "^1.8.3",
     "vite": "^4.5.0",
-    "vike": "^0.4.143"
+    "vike": "^0.4.144"
   },
   "devDependencies": {
     "@babel/core": "^7.23.2",
@@ -37,7 +37,7 @@
     "tslib": "^2.6.2",
     "typescript": "^5.2.2",
     "vite": "^4.5.0",
-    "vike": "^0.4.143"
+    "vike": "^0.4.144"
   },
   "typesVersions": {
     "*": {

diff --git a/vike-solid/renderer/+config.ts b/vike-solid/renderer/+config.ts
@@ -27,8 +27,8 @@ const toggleSsrRelatedConfig: ConfigEffect = ({
 };
 
 export 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: ["pageProps", "title"],
   clientRouting: true,
   hydrationCanBeAborted: true,

diff --git a/vike-solid/renderer/+onRenderClient.tsx b/vike-solid/renderer/+onRenderClient.tsx
@@ -1,8 +1,9 @@
-export default onRenderClient;
+// https://vike.dev/onRenderClient
+export { onRenderClient };
 
 import { hydrate, render } from "solid-js/web";
 import { getTitle } from "./getTitle";
-import type { PageContextClient } from "vike/types";
+import type { OnRenderClientAsync, PageContextClient } from "vike/types";
 import { getPageElement } from "./getPageElement";
 import { createStore, reconcile } from "solid-js/store";
 
@@ -13,7 +14,9 @@ const [pageContextStore, setPageContext] = createStore<PageContextClient>(
 let dispose: () => void;
 let rendered = false;
 
-async function onRenderClient(pageContext: PageContextClient) {
+const onRenderClient: OnRenderClientAsync = async (
+  pageContext
+): ReturnType<OnRenderClientAsync> => {
   if (!rendered) {
     // Dispose to prevent duplicate pages when navigating.
     if (dispose) dispose();

diff --git a/vike-solid/renderer/+onRenderHtml.tsx b/vike-solid/renderer/+onRenderHtml.tsx
@@ -1,12 +1,20 @@
-export default onRenderHtml;
-import { generateHydrationScript, renderToStream, renderToString } from "solid-js/web";
+// https://vike.dev/onRenderHtml
+export { onRenderHtml };
+
+import {
+  generateHydrationScript,
+  renderToStream,
+  renderToString,
+} from "solid-js/web";
 import { dangerouslySkipEscape, escapeInject, stampPipe } from "vike/server";
 import { getTitle } from "./getTitle";
 import { getPageElement } from "./getPageElement";
-import type { PageContext } from "vike/types";
+import type { OnRenderHtmlAsync } from "vike/types";
 import { PageContextProvider } from "./PageContextProvider";
 
-async function onRenderHtml(pageContext: PageContext) {
+const onRenderHtml: OnRenderHtmlAsync = async (
+  pageContext
+): ReturnType<OnRenderHtmlAsync> => {
   const title = getTitle(pageContext);
   const titleTag = !title ? "" : escapeInject`<title>${title}</title>`;
 
@@ -52,7 +60,5 @@ async function onRenderHtml(pageContext: PageContext) {
       </body>
     </html>`;
 
-  return {
-    documentHtml,
-  };
-}
+  return documentHtml;
+};