@intent-framework/router 0.1.0-alpha.2 → 0.1.0-alpha.5

package/README.md

@@ -5,55 +5,81 @@ Typed route definitions and navigation for Intent.
 ## Install
 
 ```sh
-pnpm add @intent-framework/core@0.1.0-alpha.1 @intent-framework/router@0.1.0-alpha.1
+pnpm add @intent-framework/core @intent-framework/router
 ```
 
 ```sh
-npm install @intent-framework/core@0.1.0-alpha.1 @intent-framework/router@0.1.0-alpha.1
+npm install @intent-framework/core @intent-framework/router
 ```
 
-## What it provides
+## Quick reference
 
-- `createRouter()` — typed, immutable route builder
-- `.route(name, path, screen)` — register a route with typed params
-- `.match(pathname)` — match a pathname to a route + screen
-- `.path(name, params)` — generate a typed path string
-- `RouterServices` — typed navigation service for screens and actions
-- `renderRouter()` integration lives in `@intent-framework/dom`
-
-## Minimal example
+### `createRouter()`
 
 ```ts
 import { createRouter } from "@intent-framework/router"
 
-type AppServices = {
-  navigate: (name: string) => void
-}
-
-const router = createRouter<AppServices>()
+const router = createRouter()
   .route("home", "/", HomeScreen)
-  .route("team", "/team/:teamId", TeamScreen)
-  .route("invite", "/team/:teamId/invite", InviteScreen)
+  .route("team", "/teams/:teamId", TeamScreen)
+```
+
+| Method | Description |
+|--------|-------------|
+| `.route(name, path, screen)` | Register a route with typed params |
+| `.match(pathname)` | Match a pathname → `{ found, name, params, screen }` |
+| `.path(name, params?)` | Generate a typed path string |
+| `.routes()` | List all registered route definitions |
+
+### Typed navigation
+
+```ts
+import type { RouterServices, RoutesFromPaths, RouterNavigate, RouteContext } from "@intent-framework/router"
+
+const appPaths = { home: "/", team: "/teams/:teamId" } as const
+type AppRoutes = RoutesFromPaths<typeof appPaths>
 
-const match = router.match("/team/abc123")
-if (match.found) {
-  console.log(match.name, match.params) // "team", { teamId: "abc123" }
-}
+// Typed navigate function
+type Navigate = RouterNavigate<AppRoutes>
+// (name: "home") => void
+// (name: "team", params: { teamId: string }) => void
 
-const path = router.path("team", { teamId: "abc123" })
-console.log(path) // "/team/abc123"
+// Full services with navigate + extras
+type AppServices = RouterServices<AppRoutes, {
+  route: RouteContext<AppRoutes>
+  analytics: { track(event: string): void }
+}>
 ```
 
+### DOM rendering
+
+```ts
+import { renderRouter } from "@intent-framework/dom"
+
+renderRouter(router, {
+  target: document.getElementById("root")!,
+  notFound: NotFoundScreen,
+  services: { /* custom services */ },
+})
+```
+
+`renderRouter()` injects `navigate` (and `route` when matched) into screen services, listens for `popstate` to handle back/forward, and cleans up on `dispose()`.
+
+## Guide
+
+See [docs/Router.md](../../docs/Router.md) for the full router guide covering typed navigation, route params, services, popstate behavior, renderRouter options, and current non-goals.
+
 ## Where this fits
 
 Router provides typed route definitions and navigation for Intent screens. Use `@intent-framework/dom`'s `renderRouter()` to materialize navigation into the DOM. The router does not own the product model — it maps paths to screens.
 
 ## Learn more
 
+- [Router guide](../../docs/Router.md) — comprehensive guide
 - [Root README](../../README.md) — project overview and philosophy
 - [MVP Checkpoint](../../docs/MVP-Checkpoint.md) — current implementation boundaries
 - [Web basic example](../../examples/web-basic) — full demo with routing, resources, and diagnostics
 
 ## Status
 
-Experimental alpha. Version `0.1.0-alpha.1`. APIs may change. Not recommended for production use.
+Experimental alpha. APIs may change. Not recommended for production use.

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.1.0-alpha.2",
+  "version": "0.1.0-alpha.5",
   "description": "Typed route definitions and navigation for Intent",
   "license": "MIT",
   "repository": {
@@ -26,7 +26,7 @@
     "dist"
   ],
   "dependencies": {
-    "@intent-framework/core": "0.1.0-alpha.2"
+    "@intent-framework/core": "^0.1.0-alpha.5"
   },
   "devDependencies": {
     "tsdown": "^0.3.0",