@iyulab/router 0.6.2 → 0.7.1

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2025 iyulab
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+MIT License
+
+Copyright (c) 2025 iyulab
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.

package/README.md

@@ -1,149 +1,272 @@
-# @iyulab/router
-
-A modern, lightweight client-side router for web applications with support for both Lit and React components.
-
-## Features
-
-- 🚀 **Modern URLPattern-based routing** - Uses native URLPattern API for powerful path matching
-- 🔧 **Unified Framework Support** - Works with both Lit and React components using render functions
-- 📱 **Client-Side Navigation** - History API integration with browser back/forward support
-- 🎯 **Nested Routing** - Support for deeply nested route hierarchies with index and path routes
-- 📊 **Route Events** - Track navigation progress with route-begin, route-done, and route-error events
-- ⚠️ **Enhanced Error Handling** - Built-in ErrorPage component with improved styling
-
-## Installation
-
-```bash
-npm install @iyulab/router
-```
-
-## Quick Start
-
-### Basic Setup
-
-```typescript
-import { Router } from '@iyulab/router';
-import { html } from 'lit';
-
-const router = new Router({
-  basepath: '/',
-  routes: [
-    {
-      index: true,
-      render: () => html`<home-page></home-page>`
-    },
-    {
-      path: '/user/:id', // URLPattern route
-      render: (routeInfo) => html`<user-page .userId=${routeInfo.params.id}></user-page>`
-    }
-  ],
-});
-```
-
-### Mixed Framework Support
-
-```typescript
-import React from 'react';
-
-const routes = [
-  // Lit component
-  {
-    path: '/lit-page',
-    render: (routeInfo) => {
-      return html`<my-lit-component .routeInfo=${routeInfo}></my-lit-component>`
-    }
-  },
-  // React component
-  {
-    path: '/react-page',
-    render: (routeInfo) => {
-      return ( <MyComponent></MyComponent> )
-    }
-  },
-  // HTML element
-  {
-    path: '/element-page',
-    render: (routeInfo) => {
-      const element = document.createElement('my-element');
-      element.data = routeInfo.params;
-      return element;
-    }
-  }
-];
-```
-
-### Nested Routes
-
-```typescript
-import { RouteConfig } from '@iyulab/router';
-
-const routes: RouteConfig[] = [
-  {
-    path: '/dashboard',
-    render: () => html`<dashboard-layout><u-outlet></u-outlet></dashboard-layout>`,
-    children: [
-      {
-        index: true, // Matches '/dashboard'
-        render: () => html`<dashboard-home></dashboard-home>`
-      },
-      {
-        path: 'settings', // Matches '/dashboard/settings'
-        render: () => html`<dashboard-settings></dashboard-settings>`
-      }
-    ]
-  }
-];
-```
-
-## Usage Examples
-
-### Using with Lit Elements
-
-```typescript
-import { LitElement, html } from 'lit';
-import { customElement } from 'lit/decorators.js';
-
-import "@iyulab/router";
-
-@customElement('app-root')
-export class AppRoot extends LitElement {
-  render() {
-    return html`
-      <nav>
-        <u-link href="/">Home</u-link>
-        <u-link href="/about">About</u-link>
-        <u-link href="/user/123">User Profile</u-link>
-      </nav>
-      <main>
-        <u-outlet></u-outlet>
-      </main>
-    `;
-  }
-}
-```
-
-### Using with React Components
-
-```tsx
-import React from 'react';
-import { UOutlet, ULink } from '@iyulab/router/react';
-
-export function AppRoot() {
-  return (
-    <div>
-      <nav>
-        <ULink href="/">Home</ULink>
-        <ULink href="/about">About</ULink>
-        <ULink href="/user/123">User Profile</ULink>
-      </nav>
-      <main>
-        <UOutlet />
-      </main>
-    </div>
-  );
-}
-```
-
-## License
-
-MIT License - see [LICENSE](LICENSE) file for details.
+# @iyulab/router
+
+A modern, lightweight client-side router for web applications with support for both Lit and React components.
+
+## Features
+
+- 🚀 **Modern URLPattern-based routing** - Uses native URLPattern API for powerful path matching
+- 🔧 **Unified Framework Support** - Works with both Lit and React components using render functions
+- 📱 **Client-Side Navigation** - History API integration with browser back/forward support
+- 🎯 **Nested Routing** - Support for deeply nested route hierarchies with index and path routes
+- 📊 **Route Events** - Track navigation progress with route-begin, route-done, and route-error events
+- ⚠️ **Enhanced Error Handling** - Built-in ErrorPage component with improved styling
+
+## Installation
+
+```bash
+npm install @iyulab/router
+```
+
+## Quick Start
+
+### Basic Setup
+
+```typescript
+import { Router } from '@iyulab/router';
+import { html } from 'lit';
+
+const router = new Router({
+  basepath: '/',
+  routes: [
+    {
+      index: true,
+      render: () => html`<home-page></home-page>`
+    },
+    {
+      path: '/user/:id', // URLPattern route
+      render: (routeInfo) => html`<user-page .userId=${routeInfo.params.id}></user-page>`
+    }
+  ],
+});
+```
+
+### Mixed Framework Support
+
+```typescript
+import React from 'react';
+
+const routes = [
+  // Lit component
+  {
+    path: '/lit-page',
+    render: (routeInfo) => {
+      return html`<my-lit-component .routeInfo=${routeInfo}></my-lit-component>`
+    }
+  },
+  // React component
+  {
+    path: '/react-page',
+    render: (routeInfo) => {
+      return ( <MyComponent></MyComponent> )
+    }
+  },
+  // HTML element
+  {
+    path: '/element-page',
+    render: (routeInfo) => {
+      const element = document.createElement('my-element');
+      element.data = routeInfo.params;
+      return element;
+    }
+  }
+];
+```
+
+### Nested Routes
+
+```typescript
+import { RouteConfig } from '@iyulab/router';
+
+const routes: RouteConfig[] = [
+  {
+    path: '/dashboard',
+    render: () => html`<dashboard-layout><u-outlet></u-outlet></dashboard-layout>`,
+    children: [
+      {
+        index: true, // Matches '/dashboard'
+        render: () => html`<dashboard-home></dashboard-home>`
+      },
+      {
+        path: 'settings', // Matches '/dashboard/settings'
+        render: () => html`<dashboard-settings></dashboard-settings>`
+      }
+    ]
+  }
+];
+```
+
+## Usage Examples
+
+### Using with Lit Elements
+
+```typescript
+import { LitElement, html } from 'lit';
+import { customElement } from 'lit/decorators.js';
+
+import "@iyulab/router";
+
+@customElement('app-root')
+export class AppRoot extends LitElement {
+  render() {
+    return html`
+      <nav>
+        <u-link href="/">Home</u-link>
+        <u-link href="/about">About</u-link>
+        <u-link href="/user/123">User Profile</u-link>
+      </nav>
+      <main>
+        <u-outlet></u-outlet>
+      </main>
+    `;
+  }
+}
+```
+
+### Using with React Components
+
+```tsx
+import React from 'react';
+import { UOutlet, ULink } from '@iyulab/router/react';
+
+export function AppRoot() {
+  return (
+    <div>
+      <nav>
+        <ULink href="/">Home</ULink>
+        <ULink href="/about">About</ULink>
+        <ULink href="/user/123">User Profile</ULink>
+      </nav>
+      <main>
+        <UOutlet />
+      </main>
+    </div>
+  );
+}
+```
+
+## Error Handling
+
+The router provides comprehensive error handling through `FallbackRouteContext`. When a routing error occurs, the fallback render function receives a context with full error information:
+
+```typescript
+const router = new Router({
+  root: document.body,
+  basepath: '/',
+  routes: [...],
+  fallback: {
+    title: 'Error',
+    render: (ctx) => {
+      // ctx.error contains RouteError with code, message, and original error
+      const { code, message, original } = ctx.error;
+
+      if (code === 'NOT_FOUND') {
+        return html`<not-found-page .path=${ctx.pathname}></not-found-page>`;
+      }
+      if (code === 'CONTENT_LOAD_ERROR') {
+        return html`<error-page .message=${message}></error-page>`;
+      }
+      return html`<error-page .error=${ctx.error}></error-page>`;
+    }
+  }
+});
+```
+
+Error types:
+- `NotFoundError` — No matching route found (code: `NOT_FOUND`)
+- `ContentLoadError` — Route render function threw an error (code: `CONTENT_LOAD_ERROR`)
+- `ContentRenderError` — Outlet rendering failed (code: `CONTENT_RENDER_ERROR`)
+
+## Route Metadata
+
+Routes can carry arbitrary metadata via the `meta` field. When a route matches, metadata from the entire matched route chain is merged (parent → child order, child overrides parent):
+
+```typescript
+const router = new Router({
+  root: document.body,
+  basepath: '/',
+  routes: [
+    {
+      path: '/admin',
+      meta: { requiresAuth: true, layout: 'admin' },
+      render: (ctx) => {
+        // ctx.meta === { requiresAuth: true, layout: 'admin' }
+        return html`<admin-layout><u-outlet></u-outlet></admin-layout>`;
+      },
+      children: [
+        {
+          path: 'settings',
+          meta: { requiresAuth: true, role: 'superadmin' },
+          render: (ctx) => {
+            // ctx.meta === { requiresAuth: true, layout: 'admin', role: 'superadmin' }
+            return html`<admin-settings></admin-settings>`;
+          }
+        }
+      ]
+    }
+  ]
+});
+```
+
+Use cases: authentication guards, SEO tags, analytics tracking, layout selection, and more.
+
+## Route Events
+
+The router dispatches events on the `window` object during navigation:
+
+| Event | Type | Description |
+|-------|------|-------------|
+| `route-begin` | `RouteBeginEvent` | Fired when navigation starts |
+| `route-progress` | `RouteProgressEvent` | Fired during async loading (0–100) |
+| `route-done` | `RouteDoneEvent` | Fired when navigation completes successfully |
+| `route-error` | `RouteErrorEvent` | Fired when a routing error occurs |
+
+```typescript
+// Track navigation progress
+window.addEventListener('route-progress', (e: RouteProgressEvent) => {
+  progressBar.value = e.progress;
+});
+
+// Log navigation events
+window.addEventListener('route-begin', (e: RouteBeginEvent) => {
+  console.log('Navigating to:', e.context.pathname);
+});
+
+window.addEventListener('route-done', (e: RouteDoneEvent) => {
+  analytics.trackPageView(e.context.pathname);
+});
+
+window.addEventListener('route-error', (e: RouteErrorEvent) => {
+  errorTracker.report(e.error);
+});
+```
+
+## URL Parameters
+
+The router supports URLPattern-based parameter matching:
+
+```typescript
+const routes: RouteConfig[] = [
+  // Required parameter
+  { path: '/user/:id', render: (ctx) => html`<user-page .id=${ctx.params.id}></user-page>` },
+
+  // Optional parameter
+  { path: '/posts/:category?', render: (ctx) => {
+    const category = ctx.params.category || 'all';
+    return html`<posts-page .category=${category}></posts-page>`;
+  }},
+
+  // Wildcard (catch-all)
+  { path: '/docs/:path*', render: (ctx) => html`<docs-page .path=${ctx.params.path}></docs-page>` },
+
+  // Multiple parameters
+  { path: '/org/:orgId/repo/:repoId', render: (ctx) => {
+    return html`<repo-page .orgId=${ctx.params.orgId} .repoId=${ctx.params.repoId}></repo-page>`;
+  }}
+];
+```
+
+When URL parameters change (e.g., navigating from `/user/1` to `/user/2`), leaf routes (without children) automatically re-render since `force` defaults to `true`. For parent routes with children, set `force: true` explicitly if re-rendering is needed on parameter changes.
+
+## License
+
+MIT License - see [LICENSE](LICENSE) file for details.

package/dist/index.d.ts

@@ -60,6 +60,15 @@ declare interface BaseRouteConfig {
      * @default false
      */
     ignoreCase?: boolean;
+    /**
+     * 라우트에 연결할 메타데이터
+     * - 인증, SEO, 분석 등의 용도로 사용할 수 있습니다.
+     * @example
+     * ```typescript
+     * { path: '/admin', meta: { requiresAuth: true, role: 'admin' } }
+     * ```
+     */
+    meta?: Record<string, unknown>;
 }
 
 /**
@@ -237,6 +246,11 @@ export declare interface RouteContext {
      * @param value 진행 상태 값 (0~100)
      */
     progress: (value: number) => void;
+    /**
+     * 매칭된 라우트 체인의 병합된 메타데이터
+     * - 부모 라우트에서 자식 라우트 순서로 병합됩니다.
+     */
+    meta: Record<string, unknown>;
 }
 
 /**
@@ -437,11 +451,11 @@ export declare class UOutlet extends HTMLElement {
 
 export { }
 
-declare global {
-  interface WindowEventMap {
-    'route-begin': RouteBeginEvent;
-    'route-progress': RouteProgressEvent;
-    'route-done': RouteDoneEvent;
-    'route-error': RouteErrorEvent;
-  }
+declare global {
+  interface WindowEventMap {
+    'route-begin': RouteBeginEvent;
+    'route-progress': RouteProgressEvent;
+    'route-done': RouteDoneEvent;
+    'route-error': RouteErrorEvent;
+  }
 }

package/dist/index.js

@@ -1,5 +1,5 @@
-import { a as absolutePath, i as isExternalUrl, p as parseUrl } from "./share-6Zs4TunA.js";
-import { b, U } from "./share-6Zs4TunA.js";
+import { a as absolutePath, i as isExternalUrl, p as parseUrl } from "./share-B5lysqp2.js";
+import { b, U } from "./share-B5lysqp2.js";
 import { css, LitElement, html } from "lit";
 import { property, customElement } from "lit/decorators.js";
 class RouteError extends Error {
@@ -190,6 +190,7 @@ function getRandomID() {
 }
 function findOutlet(element) {
   if (!element) return void 0;
+  if (element.tagName === "U-OUTLET") return element;
   let outlet = void 0;
   if (element.shadowRoot) {
     outlet = element.shadowRoot.querySelector("u-outlet");
@@ -222,7 +223,9 @@ async function waitOutlet(element, timeout = 1e4) {
     if (outlet) return outlet;
     await new Promise((r) => setTimeout(r, 50));
   }
-  throw new Error("Timed out waiting for u-outlet.");
+  throw new Error(
+    `Timed out waiting for <u-outlet> inside <${element.tagName.toLowerCase()}>. Ensure that the router root element contains a <u-outlet> child.`
+  );
 }
 function findAnchorFrom(event) {
   const targets = event.composedPath() || [];
@@ -370,6 +373,11 @@ class Router {
       if (lastRoute && lastRoute.path instanceof URLPattern) {
         context.params = lastRoute.path.exec({ pathname: context.pathname })?.pathname.groups || {};
       }
+      const mergedMeta = {};
+      for (const route of routes) {
+        if (route.meta) Object.assign(mergedMeta, route.meta);
+      }
+      context.meta = mergedMeta;
       this._context = context;
       outlet = findOutletOrThrow(this._rootElement);
       let title = void 0;

package/dist/react.js

@@ -1,6 +1,6 @@
 import React from "react";
 import { createComponent } from "@lit/react";
-import { b as ULink$1, U as UOutlet$1 } from "./share-6Zs4TunA.js";
+import { b as ULink$1, U as UOutlet$1 } from "./share-B5lysqp2.js";
 const ULink = createComponent({
   react: React,
   tagName: "u-link",

package/dist/{share-6Zs4TunA.js → share-B5lysqp2.js}

@@ -78,7 +78,8 @@ function parseUrl(url, basepath) {
     hash: urlObj.hash,
     params: {},
     progress: () => {
-    }
+    },
+    meta: {}
   };
 }
 function absolutePath(...paths) {

package/package.json

@@ -1,56 +1,56 @@
-{
-  "name": "@iyulab/router",
-  "version": "0.6.2",
-  "description": "A modern client-side router for web applications with support for Lit and React components",
-  "keywords": [
-    "lit",
-    "react",
-    "router",
-    "routing",
-    "spa",
-    "navigation",
-    "client-side"
-  ],
-  "license": "MIT",
-  "author": "iyulab",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/iyulab/node-router.git"
-  },
-  "files": [
-    "dist",
-    "package.json",
-    "README.md",
-    "LICENSE"
-  ],
-  "type": "module",
-  "types": "dist/index.d.ts",
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js"
-    },
-    "./react": {
-      "types": "./dist/react.d.ts",
-      "import": "./dist/react.js"
-    }
-  },
-  "scripts": {
-    "test": "vite",
-    "build": "vite build"
-  },
-  "dependencies": {
-    "@lit/react": "^1.0.8",
-    "lit": "^3.3.2",
-    "react": "^19.2.3",
-    "react-dom": "^19.2.3"
-  },
-  "devDependencies": {
-    "@types/node": "^25.0.9",
-    "@types/react": "^19.2.9",
-    "@types/react-dom": "^19.2.3",
-    "typescript": "^5.9.3",
-    "vite": "^7.3.1",
-    "vite-plugin-dts": "^4.5.4"
-  }
-}
+{
+  "name": "@iyulab/router",
+  "version": "0.7.1",
+  "description": "A modern client-side router for web applications with support for Lit and React components",
+  "keywords": [
+    "lit",
+    "react",
+    "router",
+    "routing",
+    "spa",
+    "navigation",
+    "client-side"
+  ],
+  "license": "MIT",
+  "author": "iyulab",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/iyulab/node-router.git"
+  },
+  "files": [
+    "dist",
+    "package.json",
+    "README.md",
+    "LICENSE"
+  ],
+  "type": "module",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./src/index.d.ts",
+      "import": "./src/index.js"
+    },
+    "./react": {
+      "types": "./dist/react.d.ts",
+      "import": "./dist/react.js"
+    }
+  },
+  "scripts": {
+    "test": "vite",
+    "build": "vite build"
+  },
+  "dependencies": {
+    "@lit/react": "^1.0.8",
+    "lit": "^3.3.2",
+    "react": "^19.2.3",
+    "react-dom": "^19.2.3"
+  },
+  "devDependencies": {
+    "@types/node": "^25.0.9",
+    "@types/react": "^19.2.9",
+    "@types/react-dom": "^19.2.3",
+    "typescript": "^5.9.3",
+    "vite": "^7.3.1",
+    "vite-plugin-dts": "^4.5.4"
+  }
+}