@emkodev/emroute 1.0.3 → 1.6.0

package/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2024, emko.dev
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -1,22 +1,157 @@
-# @emkodev/emroute
+<p align="center">
+  <img src="doc/logo-full.png" alt="emroute" width="197" height="40">
+</p>
 
-File-based router with triple rendering (SPA, SSR HTML, SSR Markdown). Zero dependencies.
+<p align="center">
+  File-based router with triple rendering. Zero dependencies.
+</p>
 
-## Install
+---
 
-This package is published on [JSR](https://jsr.io/@emkodev/emroute):
+Every route renders three ways from the same component: as a **Single Page App**
+in the browser, as **server-rendered HTML**, and as **plain Markdown**. No
+separate API layer needed — prefix any route with `/md/` and get text that LLMs,
+scripts, and `curl` can consume directly.
+
+```
+GET /projects/42          → SPA (hydrated in browser)
+GET /html/projects/42     → pre-rendered HTML
+GET /md/projects/42       → plain Markdown
+```
+
+## Install
 
 ```bash
-# Deno
-deno add jsr:@emkodev/emroute
+bun add @emkodev/emroute
+```
+
+> emroute ships TypeScript source. Your toolchain must handle `.ts` imports
+> (Bun, tsx, esbuild, etc.).
+
+For markdown rendering, add [@emkodev/emkoma](doc/08c-setup-emkoma.md) (built
+for emroute) or bring your own — [marked](doc/08a-setup-marked.md) and
+[markdown-it](doc/08b-setup-markdown-it.md) both work.
 
-# Node.js / Bun
-npx jsr add @emkodev/emroute
+## How It Works
+
+<p align="center">
+  <img src="doc/diagram-full.png" alt="emroute architecture" width="480" height="480">
+</p>
+
+One component, three rendering paths:
+
+<p align="center">
+  <img src="doc/diagram-flow-spa.png" alt="SPA flow" width="320" height="320">
+  <img src="doc/diagram-flow-ssr-html.png" alt="SSR HTML flow" width="320" height="320">
+  <img src="doc/diagram-flow-ssr-md.png" alt="SSR Markdown flow" width="320" height="320">
+</p>
+
+The SPA and SSR HTML flows both call `renderHTML()` — same output, different
+delivery. The SSR Markdown flow calls `renderMarkdown()` instead, bypassing
+HTML entirely for plain text output.
+
+Routes are files. The filesystem is the config.
+
+```
+routes/
+  index.page.md              → /
+  about.page.html            → /about
+  projects.page.md           → /projects
+  projects/
+    [id].page.ts             → /projects/:id
+    [id]/
+      tasks.page.ts          → /projects/:id/tasks
+  404.page.html              → not found
+  index.error.ts             → root error handler
 ```
 
+A route can be a `.md` file, an `.html` template, a `.ts` component, or a
+combination. When a `.page.ts` exists, it controls data fetching and rendering.
+When it doesn't, the framework renders the `.html` or `.md` file directly.
+
+```ts
+import { PageComponent } from '@emkodev/emroute';
+
+class ProjectPage extends PageComponent<{ id: string }, ProjectData> {
+  override readonly name = 'project';
+
+  override async getData({ params }: this['DataArgs']) {
+    const res = await fetch(`/api/projects/${params.id}`);
+    return res.json();
+  }
+
+  override renderHTML({ data, params, context }: this['RenderArgs']) {
+    // context.files.html has the companion .page.html template if it exists
+    const template = context.files?.html ?? `<h1>${data.name}</h1>`;
+    return template.replaceAll('{{id}}', params.id) + '<router-slot></router-slot>';
+  }
+
+  override renderMarkdown({ data, context }: this['RenderArgs']) {
+    // context.files.md has the companion .page.md content if it exists
+    return context.files?.md ?? `# ${data.name}\n\nStatus: ${data.status}`;
+  }
+}
+
+export default new ProjectPage();
+```
+
+## Features
+
+- **File-based routing** with dynamic segments (`[id]`), catch-all directories, and nested layouts via `<router-slot>`. Routes follow REST conventions: exact routes are terminal resources, catch-all directories own their namespace
+- **Triple rendering** — SPA, SSR HTML, SSR Markdown from one component
+- **Companion files** — `.page.html`, `.page.md`, `.page.css` loaded automatically and passed through context
+- **Widgets** — interactive islands with their own data lifecycle, error handling, and optional file companions (`.html`, `.md`, `.css`). Auto-discovered from a `widgets/` directory or registered manually. `this.element` gives opt-in DOM access in the browser. `<widget-foo lazy>` defers loading until visible via `IntersectionObserver`
+- **View Transitions** — SPA route changes animate via `document.startViewTransition()`. Progressive enhancement with CSS-only customization
+- **Scoped CSS** — companion `.widget.css` files auto-wrapped in `@scope (widget-{name}) { ... }`
+- **Shadow DOM** — unified Declarative Shadow DOM architecture for SSR and SPA. Widgets render into shadow roots for true CSS encapsulation and Web Components spec compliance
+- **SSR hydration** — server-rendered HTML adopted by the SPA without re-rendering. Widgets can implement `hydrate(args)` to attach event listeners after SSR adoption, receiving `{ data, params, context }`
+- **Error boundaries** — scoped error handlers per route prefix, plus status pages (`404.page.html`) and a root fallback
+- **Extensible context** — inject app-level services (RPC clients, auth, feature flags) into every component via `extendContext` on the router. Type-safe access through module augmentation or a per-component generic
+- **Declarative overlays** — popovers, modals, and toasts with zero JS via Invoker Commands API and CSS keyframe animations. Programmatic API available for dynamic content
+- **Zero dependencies** — native APIs only (URLPattern, custom elements, Navigation API). No framework runtime, no virtual DOM, no build-time magic
+- **Pluggable markdown** — `<mark-down>` custom element with a swappable parser interface; bring your own renderer
+- **Redirects** — declarative `.redirect.ts` files with 301/302 support
+- **Configurable base paths** — `/html/` and `/md/` prefixes are configurable via `BasePath`
+- **SPA modes** — `'root'` (default), `'leaf'`, `'none'`, or `'only'` to control how the server handles non-file requests and SSR endpoints
+- **Sitemap generation** — opt-in `sitemap.xml` from the routes manifest with support for dynamic route enumerators
+- **Dev server** — zero-config: auto-generates `main.ts`, `index.html`, and route/widget manifests. File watcher with hot reload and bundle serving
+
+## Why Bun?
+
+emroute 1.5.x shipped on JSR (Deno's registry). Starting with 1.6.0, emroute
+publishes to npm and targets Bun as the primary runtime.
+
+**TL;DR:** JSR's design freezes the entire module graph at publish time. This
+breaks dynamic `import()` of consumer dependencies, peer dependency
+deduplication, and runtime resolution of package entry points for bundling — all
+things a framework with plugin architecture needs. The npm/`node_modules` model
+handles them with zero friction.
+
+Full analysis with documentation and issue references:
+[ADR-0017 — Move to Bun ecosystem](doc/architecture/ADR-0017-move-to-bun-ecosystem.md).
+
+## Getting Started
+
+See [Setup](doc/01-setup.md) and [First Route](doc/02-first-route.md).
+
 ## Documentation
 
-- [GitHub](https://github.com/vedokme/emroute)
-- [JSR](https://jsr.io/@emkodev/emroute)
-- [Quick start](https://jsr.io/@emkodev/emroute/doc/quick-start.md)
-- [Guide](https://jsr.io/@emkodev/emroute/doc/guide.md)
+- [Setup](doc/01-setup.md) — install and create a server
+- [First route](doc/02-first-route.md) — create your first page
+- [Pages](doc/03-pages.md) — page components, companion files, data fetching
+- [Routing](doc/04-routing.md) — dynamic segments, catch-all, redirects
+- [Nesting](doc/05-nesting.md) — layouts, slots, passthrough pages, tips and tricks
+- [Widgets](doc/06-widgets.md) — interactive islands with data lifecycle
+- [Server](doc/07-server.md) — `createEmrouteServer`, composition, static files
+- [Markdown renderers](doc/08-markdown-renderer.md) — pluggable parser interface and setup
+- [Runtime](doc/09-runtime.md) — abstract runtime, BunFsRuntime, BunSqliteRuntime
+- [SPA modes](doc/10-spa-mode.md) — none, leaf, root, only
+- [Error handling](doc/11-error-handling.md) — widget errors, boundaries, status pages
+- [Shadow DOM](doc/12-shadow-dom.md) — unified architecture, SSR hydration
+- [Hono integration](doc/13-hono.md) — using emroute with Hono
+
+### For contributors and architects
+
+- [Architectural decisions](doc/architecture/) — ADR-0001 through ADR-0017
+
+<img src="doc/logo-full.png" alt="emroute" width="197" height="40">

package/package.json

@@ -1,14 +1,10 @@
 {
   "name": "@emkodev/emroute",
-  "version": "1.0.3",
+  "version": "1.6.0",
   "description": "File-based router with triple rendering (SPA, SSR HTML, SSR Markdown). Zero dependencies.",
   "license": "BSD-3-Clause",
   "author": "emko.dev",
-  "homepage": "https://jsr.io/@emkodev/emroute",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/vedokme/emroute.git"
-  },
+  "type": "module",
   "keywords": [
     "router",
     "routing",
@@ -16,7 +12,52 @@
     "ssr",
     "file-based",
     "framework",
+    "bun",
     "typescript",
     "markdown"
-  ]
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/vedokme/emroute.git"
+  },
+  "files": [
+    "src/",
+    "server/*.ts",
+    "runtime/",
+    "LICENSE",
+    "README.md"
+  ],
+  "exports": {
+    ".": "./src/index.ts",
+    "./spa": "./src/renderer/spa/mod.ts",
+    "./overlay": "./src/overlay/mod.ts",
+    "./ssr/html": "./src/renderer/ssr/html.renderer.ts",
+    "./ssr/md": "./src/renderer/ssr/md.renderer.ts",
+    "./server": "./server/emroute.server.ts",
+    "./runtime": "./runtime/abstract.runtime.ts",
+    "./runtime/sitemap": "./runtime/sitemap.generator.ts",
+    "./runtime/bun/fs": "./runtime/bun/fs/bun-fs.runtime.ts",
+    "./runtime/bun/sqlite": "./runtime/bun/sqlite/bun-sqlite.runtime.ts"
+  },
+  "devDependencies": {
+    "@eslint/js": "^10.0.1",
+    "@types/bun": "^1.3.9",
+    "esbuild": "^0.27.3",
+    "eslint": "^10.0.2",
+    "playwright": "^1.58.2",
+    "typescript-eslint": "^8.56.1"
+  },
+  "scripts": {
+    "check": "bun x tsc --noEmit",
+    "test": "bun test test/unit",
+    "test:unit": "bun test test/unit",
+    "test:integration": "bun test test/integration",
+    "test:browser": "bun test test/browser",
+    "test:browser:none": "bun test test/browser/none",
+    "test:browser:leaf": "bun test test/browser/leaf",
+    "test:browser:root": "bun test test/browser/root",
+    "test:browser:only": "bun test test/browser/only",
+    "lint": "eslint .",
+    "dev": "echo 'Use a custom server.ts — see doc/01-setup.md'"
+  }
 }