@iyulab/router 0.6.1 → 0.7.0

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>;
 }
 
 /**
@@ -145,10 +154,14 @@ export declare class OutletMissingError extends RouteError {
     constructor();
 }
 
+/** 렌더링 옵션 */
 declare interface RenderOption {
+    /** 교차 렌더링 방지 ID */
     id?: string;
+    /** 강제 렌더링 여부 */
     force?: boolean;
-    content: RenderResult;
+    /** 렌더링할 값 */
+    value: RenderResult;
 }
 
 export declare type RenderResult = HTMLElement | ReactElement | TemplateResult<1> | false;
@@ -233,6 +246,11 @@ export declare interface RouteContext {
      * @param value 진행 상태 값 (0~100)
      */
     progress: (value: number) => void;
+    /**
+     * 매칭된 라우트 체인의 병합된 메타데이터
+     * - 부모 라우트에서 자식 라우트 순서로 병합됩니다.
+     */
+    meta: Record<string, unknown>;
 }
 
 /**
@@ -297,7 +315,7 @@ export declare class RouteProgressEvent extends RouteEvent {
 }
 
 /**
- * `lit-element`, `react`를 지원하는 클라이언트 사이드 라우터
+ * `lit-element`, `react`를 지원하는 SPA 클라이언트 라우터 객체입니다.
  */
 export declare class Router {
     private readonly _rootElement;
@@ -375,66 +393,69 @@ export declare class ULink extends LitElement {
     /** 외부 링크 여부 */
     private isExternal;
     /**
-     * a 태그 target을 지원하고 싶으면 열어두는게 좋습니다.
-     * - _blank 등을 쓰면 무조건 브라우저 기본 동작을 따르도록 처리합니다.
+     * 링크 대상 target 속성
+     *
+     * - `_self`: 현재 창에서 링크 열기 (기본값)
+     * - `_blank`: 새 탭/창에서 링크 열기
+     * - `_parent`: 부모 프레임에서 링크 열기
+     * - `_top`: 최상위 프레임에서 링크 열기
      */
     target?: string;
     /**
-     * - 속성을 정의하지 않으면 basepath로 이동합니다.
+     * 링크 대상 URL, 다음 사항에 따라 SPA 라우팅 또는 브라우저 네비게이션이 결정됩니다.
+     *
+     * - 속성을 정의하지 않으면 설정에서 지정한 `basepath`로 SPA 라우팅합니다.
      * - http(s)로 시작하면 외부 링크로 간주하고 브라우저 네비게이션을 사용합니다.
-     * - 절대경로(/...)일 경우 basepath로 시작하면 SPA 라우팅 대상이 될 수 있습니다.
-     * - 상대경로는 (basepath + 상대경로)로 SPA 라우팅 대상이 될 수 있습니다.
-     * - ?로 시작하면 현재 pathname에 쿼리스트링을 붙여 SPA 라우팅합니다.
-     * - #으로 시작하면 현재 URL에 해시만 바꾸고(브라우저 기본) 동작합니다.
+     * - 절대경로(/...)의 경우 `basepath`로 시작하면 SPA 라우팅합니다, 이외 브라우저 네비게이션을 사용합니다.
+     * - 상대경로는 (basepath + 상대경로)로 결합하여 SPA 라우팅합니다.
+     * - ?로 시작하면 현재 경로에 쿼리스트링을 추가하여 SPA 라우팅합니다.
+     * - #으로 시작하면 브라우저 기본 동작을 사용합니다.
      */
     href?: string;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
     protected willUpdate(changedProperties: PropertyValues): void;
     render(): TemplateResult_2<1>;
-    /** basepath를 state에서 꺼내는 헬퍼 */
-    private getBasepath;
     /** a 태그에 주입할 href 값을 계산합니다. */
-    private computeHref;
+    private compute;
     /**
-     * 클릭 가로채기 규칙
+     * 클릭 가로채기 핸들러
      * - 좌클릭(0) + 보조키 없음(ctrl/meta/shift/alt 없음) + target이 _self일 때만 SPA 라우팅 고려
      * - 그 외(중클릭/우클릭/보조키/target=_blank 등)는 브라우저 기본 동작 유지
      */
-    private handleAnchorClick;
+    private handleClick;
     /** 클라이언트 라우팅을 위해 popstate 이벤트를 발생시킵니다. */
     private dispatchPopstate;
+    /** basepath를 state에서 꺼내는 헬퍼 */
+    private getBasepath;
     static styles: CSSResult;
 }
 
 /**
- * 라우트 설정에 따라 LitElement 또는 React 컴포넌트를 렌더링합니다.
+ * LitElement 또는 React 컴포넌트를 렌더링해주는 웹컴포넌트 입니다.
  */
-export declare class UOutlet extends LitElement {
+export declare class UOutlet extends HTMLElement {
+    /** 교차 렌더링 방지 id */
     private routeId?;
-    private container?;
-    private content?;
-    /** 외부 스타일을 적용하기 위해 라이트 돔을사용 합니다. */
-    protected createRenderRoot(): this;
-    /** 컴포넌트가 DOM에 연결될 때 초기화 작업 수행 */
-    connectedCallback(): void;
-    render(): TemplateResult<1>;
+    /** 실제 렌더링 컨텐츠 */
+    private root?;
     /**
-     * render 함수의 결과를 렌더링합니다.
-     * - HTMLElement, ReactElement, TemplateResult를 모두 처리할 수 있습니다.
+     * 주어진 렌더링 옵션에 따라 컨텐츠를 렌더링합니다.
      */
-    renderContent({ id, content, force }: RenderOption): Promise<HTMLDivElement>;
+    render({ id, value, force }: RenderOption): void;
     /**
-     * 기존 DOM을 라이프 사이클에 맞게 제거합니다.
+     * 기존 DOM을 삭제하여, 초기 상태로 되돌립니다.
      */
-    clear(): void;
+    reset(): void;
 }
 
 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;
+  }
 }