vike-lite 1.9.1 → 1.10.1

package/README.md

@@ -1,39 +1,51 @@
 # vike-lite
 
+A lightweight, fast, and minimal framework for Server-Side Rendering (SSR) and Static Site Generation (SSG) inspired by [Vike](https://vike.dev).
+
 ### ⚙️ Install
-| Package Manager | Command
-| - | -
-| **npm** | `npm install -D vike-lite`
-| **yarn** | `yarn add -D vike-lite`
-| **pnpm** | `pnpm add -D vike-lite`
+Install `vike-lite`
+```sh
+# npm
+npm install -D vike-lite
+
+# pnpm
+pnpm add -D vike-lite
+
+# yarn
+yarn add -D vike-lite
+```
 
 ### 📖 Usage
-Add Vite plugin
+Add the `vike-lite` plugin to your `vite.config`.
 
 ```ts
 // vite.config.ts
-import type { UserConfig } from 'vite'
 import vikeLite from 'vike-lite/vite'
+import type { UserConfig } from 'vite'
 
 export default {
   plugins: [
     vikeLite({
-      pagesDir = 'pages', // Default
-      serverEntry = 'server/index', // Default
-      apiPrefix = '/api',  // Default
-      prerender = false // Default
+      pagesDir: 'pages',           // Default: Directory containing your pages
+      serverEntry: 'server/index', // Default: Custom server entry file
+      apiPrefix: '/api',           // Default: Prefix to bypass SSR for API routes
+      prerender: false             // Default: Enable SSG globally
     })
   ]
 } satisfies UserConfig
 ```
 
-### 🪝 Hooks
+### 🖥️ Server Integration
+
+#### `renderPage()`
+If you want to use a custom server (like Hono, Express, or Fastify), you can use the renderPage utility to handle your frontend routes.
+
+Here is an example using Hono:
 
-#### renderPage
 ```ts
 // /server/index.ts
-import { cors } from 'hono/cors'
 import { Hono } from 'hono'
+import { cors } from 'hono/cors'
 import { renderPage } from 'vike-lite/server'
 
 import apiRoutes from './apiRoutes'
@@ -44,14 +56,17 @@ if (process.env.NODE_ENV === 'production') {
   app.use(cors())
 }
 
+// 1. Handle API routes first
 app.route('/api', apiRoutes)
 
-// Catch-all remaining requests (pages) using custom rendering
+// 2. Catch-all remaining requests and pass them to vike-lite
 app.get('*', async (c, next) => {
   const response = await renderPage(c.req.raw)
+  // If vike-lite successfully renders a page, return it. Otherwise, continue.
   return response ?? next()
 })
 
+// 3. Error Handling
 app.onError((error, c) => {
   console.error(error)
   return c.json({ error: 'Internal Server Error' }, 500)
@@ -60,18 +75,13 @@ app.onError((error, c) => {
 export default app
 ```
 
-> Note: if you don't use a custom server (loaded by the `serverEntry` option), a default server is bundled. In PROD the server is started as follow:
-```ts
+>💡 **Note on Default Server:** if you don't need a custom backend and skip the `serverEntry` option, `vike-lite` bundles a default server for you out of the box. In production, it will be automatically started via an auto-generated entry point:
+
+```mjs
 // startServer.mjs
 import './dist/server/index.mjs'
 ```
 
-### 🫶 Contribution
-Clone
-```sh
-git clone https://github.com/node-ecosystem/vike-lite.git
-```
-
 ---
 
 This project is licensed under the [MIT License](../../LICENSE).

package/dist/client/router.d.mts

@@ -7,5 +7,6 @@
 declare function navigate(url: string, options?: {
   keepScrollPosition?: boolean;
 }): void;
+declare const reload: () => Promise<void>;
 //#endregion
-export { navigate };
+export { navigate, reload };

package/dist/client/router.mjs

@@ -9,8 +9,13 @@ function navigate(url, options) {
 	if (typeof globalThis === "undefined") throw new Error("navigate() can only be called on the client side.");
 	let finalUrl = url;
 	if (finalUrl.startsWith("/")) finalUrl = (BASE_URL.endsWith("/") ? BASE_URL.slice(0, -1) : BASE_URL) + (finalUrl === "/" ? "" : finalUrl);
-	globalThis.history.pushState(null, "", finalUrl);
+	globalThis.history.pushState({ triggeredBy: "vike-lite" }, "", finalUrl);
 	globalThis.dispatchEvent(new CustomEvent("vike-navigate", { detail: { keepScrollPosition: options?.keepScrollPosition } }));
 }
+const reload = () => {
+	return new Promise((resolve) => {
+		globalThis.dispatchEvent(new CustomEvent("vike-reload", { detail: { resolve } }));
+	});
+};
 //#endregion
-export { navigate };
+export { navigate, reload };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vike-lite",
-  "version": "1.9.1",
+  "version": "1.10.1",
   "license": "MIT",
   "type": "module",
   "module": "./dist/index.mjs",