create-vike 0.0.320 → 0.0.322

package/boilerplate-vue-ts/pages/star-wars/index/+data.ts

@@ -0,0 +1,37 @@
+// https://vike.dev/data
+export { data }
+export type Data = Awaited<ReturnType<typeof data>>
+
+// The node-fetch package (which only works on the server-side) can be used since
+// this file always runs on the server-side, see https://vike.dev/data#server-side
+import fetch from 'node-fetch'
+import type { MovieDetails, Movie } from '../types'
+import type { PageContextServer } from 'vike/types'
+
+const data = async (pageContext: PageContextServer) => {
+  await sleep(700) // Simulate slow network
+
+  const response = await fetch('https://brillout.github.io/star-wars/api/films.json')
+  const moviesData = (await response.json()) as MovieDetails[]
+
+  // We remove data we don't need because the data is passed to the client; we should
+  // minimize what is sent over the network.
+  const movies = minimize(moviesData)
+
+  return {
+    movies,
+    // The page's <title>
+    title: `${movies.length} Star Wars Movies`
+  }
+}
+
+function minimize(movies: MovieDetails[]): Movie[] {
+  return movies.map((movie) => {
+    const { title, release_date, id } = movie
+    return { title, release_date, id }
+  })
+}
+
+function sleep(milliseconds: number) {
+  return new Promise((r) => setTimeout(r, milliseconds))
+}

package/boilerplate-vue-ts/pages/star-wars/types.ts

@@ -0,0 +1,12 @@
+export type Movie = {
+  id: string
+  title: string
+  release_date: string
+}
+export type MovieDetails = {
+  id: string
+  title: string
+  release_date: string
+  director: string
+  producer: string
+}

package/boilerplate-vue-ts/renderer/+config.h.ts

@@ -2,10 +2,18 @@ import type { Config } from 'vike/types'
 
 // https://vike.dev/config
 export default {
-  /* To enable Client-side Routing:
+  // https://vike.dev/clientRouting
   clientRouting: true,
-  // !! WARNING !! Before doing so, read https://vike.dev/clientRouting */
-
-  // See https://vike.dev/data-fetching
-  passToClient: ['pageProps', 'urlPathname']
+  // https://vike.dev/meta
+  meta: {
+    // Define new setting 'title'
+    title: {
+      env: { server: true, client: true }
+    },
+    // Define new setting 'description'
+    description: {
+      env: { server: true }
+    }
+  },
+  hydrationCanBeAborted: true
 } satisfies Config

package/boilerplate-vue-ts/renderer/+onPageTransitionEnd.ts

@@ -0,0 +1,9 @@
+// https://vike.dev/onPageTransitionEnd
+export { onPageTransitionEnd }
+
+import type { OnPageTransitionEndAsync } from 'vike/types'
+
+const onPageTransitionEnd: OnPageTransitionEndAsync = async (): ReturnType<OnPageTransitionEndAsync> => {
+  console.log('Page transition end')
+  document.querySelector('body')!.classList.remove('page-is-transitioning')
+}

package/boilerplate-vue-ts/renderer/+onPageTransitionStart.ts

@@ -0,0 +1,9 @@
+// https://vike.dev/onPageTransitionStart
+export { onPageTransitionStart }
+
+import type { OnPageTransitionStartAsync } from 'vike/types'
+
+const onPageTransitionStart: OnPageTransitionStartAsync = async (): ReturnType<OnPageTransitionStartAsync> => {
+  console.log('Page transition start')
+  document.querySelector('body')!.classList.add('page-is-transitioning')
+}

package/boilerplate-vue-ts/renderer/+onRenderClient.ts

@@ -2,13 +2,20 @@
 export { onRenderClient }
 
 import { createApp } from './app'
+import { getPageTitle } from './getPageTitle'
 import type { OnRenderClientAsync } from 'vike/types'
 
-// This onRenderClient() hook only supports SSR, see https://vike.dev/render-modes for how to modify onRenderClient()
-// to support SPA
+let app: ReturnType<typeof createApp>
 const onRenderClient: OnRenderClientAsync = async (pageContext): ReturnType<OnRenderClientAsync> => {
-  const { Page, pageProps } = pageContext
-  if (!Page) throw new Error('Client-side render() hook expects pageContext.Page to be defined')
-  const app = createApp(Page, pageProps, pageContext)
-  app.mount('#app')
+  // This onRenderClient() hook only supports SSR, see https://vike.dev/render-modes for how to modify onRenderClient()
+  // to support SPA
+  if (!pageContext.Page) throw new Error('My onRenderClient() hook expects pageContext.Page to be defined')
+
+  if (!app) {
+    app = createApp(pageContext)
+    app.mount('#app')
+  } else {
+    app.changePage(pageContext)
+  }
+  document.title = getPageTitle(pageContext)
 }

package/boilerplate-vue-ts/renderer/+onRenderHtml.ts

@@ -7,20 +7,20 @@ import { escapeInject, dangerouslySkipEscape } from 'vike/server'
 import { createApp } from './app'
 import logoUrl from './logo.svg'
 import type { OnRenderHtmlAsync } from 'vike/types'
+import { getPageTitle } from './getPageTitle'
 
 const onRenderHtml: OnRenderHtmlAsync = async (pageContext): ReturnType<OnRenderHtmlAsync> => {
-  const { Page, pageProps } = pageContext
   // This onRenderHtml() hook only supports SSR, see https://vike.dev/render-modes for how to modify
   // onRenderHtml() to support SPA
-  if (!Page) throw new Error('My render() hook expects pageContext.Page to be defined')
-  const app = createApp(Page, pageProps, pageContext)
+  if (!pageContext.Page) throw new Error('My render() hook expects pageContext.Page to be defined')
+
+  const app = createApp(pageContext)
 
   const appHtml = await renderToString(app)
 
-  // See https://vike.dev/head
-  const { documentProps } = pageContext.exports
-  const title = (documentProps && documentProps.title) || 'Vite SSR app'
-  const desc = (documentProps && documentProps.description) || 'App using Vite + Vike'
+  // https://vike.dev/head
+  const title = getPageTitle(pageContext)
+  const desc = pageContext.data?.description || pageContext.config.description || 'Demo of using Vike'
 
   const documentHtml = escapeInject`<!DOCTYPE html>
     <html lang="en">
@@ -39,7 +39,7 @@ const onRenderHtml: OnRenderHtmlAsync = async (pageContext): ReturnType<OnRender
   return {
     documentHtml,
     pageContext: {
-      // We can add some `pageContext` here, which is useful if we want to do page redirection https://vike.dev/page-redirection
+      // We can add custom pageContext properties here, see https://vike.dev/pageContext#custom
     }
   }
 }

package/boilerplate-vue-ts/renderer/Link.vue

@@ -1,17 +1,25 @@
 <template>
-  <a :class="{ active: pageContext.urlPathname === $attrs.href }">
+  <a :class="{ active: isActive }">
     <slot />
   </a>
 </template>
 <style scoped>
 a {
-  padding: 3px 10px;
+  padding: 2px 10px;
+  margin-left: -10px;
 }
 a.active {
   background-color: #eee;
 }
 </style>
 <script lang="ts" setup>
+import { useAttrs, computed } from 'vue'
 import { usePageContext } from './usePageContext'
+
 const pageContext = usePageContext()
+const { href } = useAttrs() as { href: string }
+const isActive = computed(() => {
+  const { urlPathname } = pageContext
+  return href === '/' ? urlPathname === href : urlPathname.startsWith(href)
+})
 </script>

package/boilerplate-vue-ts/renderer/PageShell.vue

@@ -1,54 +1,52 @@
 <template>
-  <div class="layout">
-    <div class="navigation">
-      <a href="/" class="logo">
+  <div id="page-container">
+    <div id="sidebar">
+      <a href="/" id="logo-container">
         <img src="./logo.svg" height="64" width="64" alt="logo" />
       </a>
-      <Link href="/">Home</Link>
+      <Link href="/">Welcome</Link>
       <Link href="/about">About</Link>
+      <Link href="/star-wars">Data Fetching</Link>
     </div>
-    <div class="content"><slot /></div>
+    <div id="page-content"><slot /></div>
   </div>
 </template>
 
 <script lang="ts" setup>
 import Link from './Link.vue'
+import './css/index.css'
 </script>
 
 <style>
-body {
-  margin: 0;
-  font-family: sans-serif;
+#sidebar a {
+  padding: 2px 10px;
+  margin-left: -10px;
 }
-* {
-  box-sizing: border-box;
-}
-a {
-  text-decoration: none;
+#sidebar a.is-active {
+  background-color: #eee;
 }
 </style>
 
 <style scoped>
-.layout {
+#page-container {
   display: flex;
   max-width: 900px;
   margin: auto;
 }
-.content {
+#page-content {
   padding: 20px;
-  border-left: 2px solid #eee;
   padding-bottom: 50px;
   min-height: 100vh;
 }
-.navigation {
+#sidebar {
   padding: 20px;
   flex-shrink: 0;
   display: flex;
   flex-direction: column;
-  align-items: center;
   line-height: 1.8em;
+  border-right: 2px solid #eee;
 }
-.logo {
+#logo-container {
   margin-top: 20px;
   margin-bottom: 10px;
 }

package/boilerplate-vue-ts/renderer/app.ts

@@ -1,30 +1,59 @@
-import { createSSRApp, defineComponent, h } from 'vue'
+export { createApp }
+
+import { createSSRApp, defineComponent, h, markRaw, reactive } from 'vue'
 import PageShell from './PageShell.vue'
+import type { Component } from './types'
 import { setPageContext } from './usePageContext'
 import type { PageContext } from 'vike/types'
-import type { Component, PageProps } from './types'
 
-export { createApp }
+function createApp(pageContext: PageContext) {
+  const { Page } = pageContext
 
-function createApp(Page: Component, pageProps: PageProps | undefined, pageContext: PageContext) {
-  const PageWithLayout = defineComponent({
+  let rootComponent: Component & { Page: Component }
+  const PageWithShell = defineComponent({
+    data: () => ({
+      Page: markRaw(Page)
+    }),
+    created() {
+      rootComponent = this
+    },
     render() {
       return h(
         PageShell,
         {},
         {
-          default() {
-            return h(Page, pageProps || {})
+          default: () => {
+            return h(this.Page)
           }
         }
       )
     }
   })
 
-  const app = createSSRApp(PageWithLayout)
+  const app = createSSRApp(PageWithShell)
+
+  // We use `app.changePage()` to do Client Routing, see `+onRenderClient.ts`
+  objectAssign(app, {
+    changePage: (pageContext: PageContext) => {
+      Object.assign(pageContextReactive, pageContext)
+      rootComponent.Page = markRaw(pageContext.Page)
+    }
+  })
+
+  // When doing Client Routing, we mutate pageContext (see usage of `app.changePage()` in `+onRenderClient.ts`).
+  // We therefore use a reactive pageContext.
+  const pageContextReactive = reactive(pageContext)
 
   // Make pageContext available from any Vue component
-  setPageContext(app, pageContext)
+  setPageContext(app, pageContextReactive)
 
   return app
 }
+
+// Same as `Object.assign()` but with type inference
+function objectAssign<Obj extends object, ObjAddendum>(
+  obj: Obj,
+  objAddendum: ObjAddendum
+): asserts obj is Obj & ObjAddendum {
+  Object.assign(obj, objAddendum)
+}

package/boilerplate-vue-ts/renderer/css/code.css

@@ -0,0 +1,6 @@
+code {
+  font-family: monospace;
+  background-color: #eaeaea;
+  padding: 3px 5px;
+  border-radius: 4px;
+}

package/boilerplate-vue-ts/renderer/css/index.css

@@ -0,0 +1,4 @@
+@import './reset.css';
+@import './links.css';
+@import './code.css';
+@import './page-transition-loading-animation.css';

package/boilerplate-vue-ts/renderer/css/links.css

@@ -0,0 +1,3 @@
+a {
+  text-decoration: none;
+}

package/boilerplate-vue-ts/renderer/css/page-transition-loading-animation/loading.svg

@@ -0,0 +1,5 @@
+<svg version="1.1" id="L9" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px" viewBox="0 0 100 100" enable-background="new 0 0 0 0" xml:space="preserve">
+    <path fill="#aaa" d="M73,50c0-12.7-10.3-23-23-23S27,37.3,27,50 M30.9,50c0-10.5,8.5-19.1,19.1-19.1S69.1,39.5,69.1,50">
+      <animateTransform attributeName="transform" attributeType="XML" type="rotate" dur="1s" from="0 50 50" to="360 50 50" repeatCount="indefinite"></animateTransform>
+  </path>
+</svg>

package/boilerplate-vue-ts/renderer/css/page-transition-loading-animation.css

@@ -0,0 +1,26 @@
+#page-container {
+  position: relative;
+  width: 100%;
+}
+#page-container::before {
+  content: '';
+  position: absolute;
+  width: 100%;
+  height: 100%;
+  z-index: 999;
+  background: no-repeat url('./page-transition-loading-animation/loading.svg');
+  background-size: 100px;
+  background-position: center center;
+  pointer-events: none;
+  opacity: 0;
+}
+body.page-is-transitioning #page-container::before {
+  opacity: 1;
+}
+#page-content,
+#page-container::before {
+  transition: opacity 0.5s ease-in-out;
+}
+body.page-is-transitioning #page-content {
+  opacity: 0.17;
+}

package/boilerplate-vue-ts/renderer/css/reset.css

@@ -0,0 +1,7 @@
+body {
+  margin: 0;
+  font-family: sans-serif;
+}
+* {
+  box-sizing: border-box;
+}

package/boilerplate-vue-ts/renderer/getPageTitle.ts

@@ -0,0 +1,14 @@
+export { getPageTitle }
+
+import type { PageContext } from 'vike/types'
+
+function getPageTitle(pageContext: PageContext): string {
+  const title =
+    // Title defined dynamically by data()
+    pageContext.data?.title ||
+    // Title defined statically by /pages/some-page/+title.js (or by `export default { title }` in /pages/some-page/+config.js)
+    // The setting 'pageContext.config.title' is a custom setting we defined at ./+config.ts
+    pageContext.config.title ||
+    'Vike Demo'
+  return title
+}

package/boilerplate-vue-ts/renderer/types.ts

@@ -1,25 +1,29 @@
-export type { PageProps }
 export type { Component }
 
+import type { ComponentPublicInstance } from 'vue'
+
+type Component = ComponentPublicInstance // https://stackoverflow.com/questions/63985658/how-to-type-vue-instance-out-of-definecomponent-in-vue-3/63986086#63986086
+type Page = Component
+
 // https://vike.dev/pageContext#typescript
 declare global {
   namespace Vike {
     interface PageContext {
       Page: Page
-      pageProps?: PageProps
-      urlPathname: string
-      exports: {
-        documentProps?: {
-          title?: string
-          description?: string
-        }
+      data?: {
+        /** Value for <title> defined dynmically by by /pages/some-page/+data.js */
+        title?: string
+        /** Value for <meta name="description"> defined dynmically */
+        description?: string
+      }
+      config: {
+        /** Value for <title> defined statically by /pages/some-page/+title.js (or by `export default { title }` in /pages/some-page/+config.js) */
+        title?: string
+        /** Value for <meta name="description"> defined statically */
+        description?: string
       }
+      /** https://vike.dev/render */
+      abortReason?: string
     }
   }
 }
-
-import type { ComponentPublicInstance } from 'vue'
-
-type Component = ComponentPublicInstance // https://stackoverflow.com/questions/63985658/how-to-type-vue-instance-out-of-definecomponent-in-vue-3/63986086#63986086
-type Page = Component
-type PageProps = {}

package/boilerplate-vue-ts/renderer/useData.ts

@@ -0,0 +1,11 @@
+// https://vike.dev/useData
+export { useData }
+
+import { type ComputedRef, computed } from 'vue'
+import { usePageContext } from './usePageContext'
+
+/** https://vike.dev/useData */
+function useData<Data>(): ComputedRef<Data> {
+  const data = computed(() => (usePageContext() as { data: Data }).data)
+  return data
+}

package/boilerplate-vue-ts/renderer/usePageContext.ts

@@ -1,15 +1,14 @@
-// `usePageContext` allows us to access `pageContext` in any Vue component.
-// See https://vike.dev/pageContext-anywhere
+// https://vike.dev/usePageContext
+export { usePageContext }
+export { setPageContext }
 
 import { inject } from 'vue'
 import type { App, InjectionKey } from 'vue'
-import { PageContext } from 'vike/types'
-
-export { usePageContext }
-export { setPageContext }
+import type { PageContext } from 'vike/types'
 
 const key: InjectionKey<PageContext> = Symbol()
 
+/** https://vike.dev/usePageContext */
 function usePageContext() {
   const pageContext = inject(key)
   if (!pageContext) throw new Error('setPageContext() not called in parent')

package/boilerplate-vue-ts/server/index.ts

@@ -55,6 +55,9 @@ async function startServer() {
       urlOriginal: req.originalUrl
     }
     const pageContext = await renderPage(pageContextInit)
+    if (pageContext.errorWhileRendering) {
+      // Install error tracking here, see https://vike.dev/errors
+    }
     const { httpResponse } = pageContext
     if (!httpResponse) {
       return next()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-vike",
-  "version": "0.0.320",
+  "version": "0.0.322",
   "license": "MIT",
   "bin": {
     "create-vike": "index.js"