@iyulab/router 0.5.2 → 0.6.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,163 +1,149 @@
-# @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
-- 🔗 **Smart Link Component** - Automatic external link detection and handling
-- 📊 **Route Events** - Track navigation progress with route-begin, route-done, and route-error events
-- 🎨 **Flexible Outlet System** - Unified rendering with renderContent method
-- 🌐 **Global Route Access** - Access current route information anywhere via `window.route`
-- 🔄 **Force Re-rendering** - Control component re-rendering on route changes
-- ⚠️ **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({
-  root: document.getElementById('app')!,
-  basepath: '/app',
-  routes: [
-    {
-      index: true,
-      render: () => html`<home-page></home-page>`
-    },
-    {
-      path: '/user/:id',
-      render: (routeInfo) => html`<user-page .userId=${routeInfo.params.id}></user-page>`
-    }
-  ]
-});
-
-// Start routing
-router.go(window.location.href);
-```
-
-### Nested Routes
-
-```typescript
-const routes = [
-  {
-    path: '/dashboard',
-    render: () => html`<dashboard-layout><u-outlet></u-outlet></dashboard-layout>`,
-    children: [
-      {
-        index: true, // Matches /dashboard exactly
-        render: () => html`<dashboard-home></dashboard-home>`
-      },
-      {
-        path: 'settings',
-        render: () => html`<dashboard-settings></dashboard-settings>`
-      }
-    ]
-  }
-];
-```
-
-### Mixed Framework Support
-
-```typescript
-import React from 'react';
-
-const routes = [
-  // Lit component
-  {
-    path: '/lit-page',
-    render: (routeInfo) => html`<my-lit-component .routeInfo=${routeInfo}></my-lit-component>`
-  },
-  // React component
-  {
-    path: '/react-page',
-    render: (routeInfo) => React.createElement(MyReactComponent, { routeInfo })
-  },
-  // HTML element
-  {
-    path: '/element-page',
-    render: (routeInfo) => {
-      const element = document.createElement('my-element');
-      element.data = routeInfo.params;
-      return element;
-    }
-  }
-];
-```
-
-## Usage Examples
-
-### Using with Lit Components
-
-```typescript
-import { LitElement, html } from 'lit';
-import { customElement } from 'lit/decorators.js';
-
-@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 { Outlet, Link } from '@iyulab/router';
-
-export function AppRoot() {
-  return (
-    <div>
-      <nav>
-        <Link href="/">Home</Link>
-        <Link href="/about">About</Link>
-        <Link href="/user/123">User Profile</Link>
-      </nav>
-      <main>
-        <Outlet />
-      </main>
-    </div>
-  );
-}
-```
-
-## Browser Support
-
-- **URLPattern API**: Required for routing functionality
-- **Modern browsers**: Chrome 95+, Firefox 106+, Safari 16.4+
-- **Polyfill**: Consider using [urlpattern-polyfill](https://www.npmjs.com/package/urlpattern-polyfill) for older browsers
-
-## Contributing
-
-1. Fork the repository
-2. Create your feature branch (`git checkout -b feature/amazing-feature`)
-3. Commit your changes (`git commit -m 'Add some amazing feature'`)
-4. Push to the branch (`git push origin feature/amazing-feature`)
-5. Open a Pull Request
-
-## License
-
+# @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
+- 🔗 **Smart Link Component** - Automatic external link detection and handling
+- 📊 **Route Events** - Track navigation progress with route-begin, route-done, and route-error events
+- 🎨 **Flexible Outlet System** - Unified rendering with renderContent method
+- 🌐 **Global Route Access** - Access current route information anywhere via `window.route`
+- 🔄 **Force Re-rendering** - Control component re-rendering on route changes
+- ⚠️ **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({
+  root: document.getElementById('app')!,
+  basepath: '/app',
+  routes: [
+    {
+      index: true,
+      render: () => html`<home-page></home-page>`
+    },
+    {
+      path: '/user/:id',
+      render: (routeInfo) => html`<user-page .userId=${routeInfo.params.id}></user-page>`
+    }
+  ]
+});
+
+// Start routing
+router.go(window.location.href);
+```
+
+### Nested Routes
+
+```typescript
+const routes = [
+  {
+    path: '/dashboard',
+    render: () => html`<dashboard-layout><u-outlet></u-outlet></dashboard-layout>`,
+    children: [
+      {
+        index: true, // Matches /dashboard exactly
+        render: () => html`<dashboard-home></dashboard-home>`
+      },
+      {
+        path: 'settings',
+        render: () => html`<dashboard-settings></dashboard-settings>`
+      }
+    ]
+  }
+];
+```
+
+### Mixed Framework Support
+
+```typescript
+import React from 'react';
+
+const routes = [
+  // Lit component
+  {
+    path: '/lit-page',
+    render: (routeInfo) => html`<my-lit-component .routeInfo=${routeInfo}></my-lit-component>`
+  },
+  // React component
+  {
+    path: '/react-page',
+    render: (routeInfo) => React.createElement(MyReactComponent, { routeInfo })
+  },
+  // HTML element
+  {
+    path: '/element-page',
+    render: (routeInfo) => {
+      const element = document.createElement('my-element');
+      element.data = routeInfo.params;
+      return element;
+    }
+  }
+];
+```
+
+## Usage Examples
+
+### Using with Lit Components
+
+```typescript
+import { LitElement, html } from 'lit';
+import { customElement } from 'lit/decorators.js';
+
+@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.

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { CSSResult } from 'lit';
 import { LitElement } from 'lit';
+import { PropertyValues } from 'lit';
 import { ReactElement } from 'react';
-import { ReactWebComponent } from '@lit/react';
 import { TemplateResult } from 'lit';
 import { TemplateResult as TemplateResult_2 } from 'lit-html';
 
@@ -26,7 +26,6 @@ declare interface BaseRouteConfig {
      * - "/user/:id/:name?"
      * - "/user/:id/:name*"
      * - "/user/:id/:name+"
-     * - "/user/:id/:name{1,3}"
      * @link
      * https://developer.mozilla.org/en-US/docs/Web/API/URLPattern
      */
@@ -56,6 +55,11 @@ declare interface BaseRouteConfig {
      * - true로 설정하면 기존 렌더링을 무시하고 새로 렌더링합니다.
      */
     force?: boolean;
+    /**
+     * 경로 매칭시 대소문자 구분 여부
+     * @default false
+     */
+    ignoreCase?: boolean;
 }
 
 /**
@@ -115,47 +119,6 @@ declare interface IndexRouteConfig extends BaseRouteConfig {
     index: true;
 }
 
-/**
- * - 클라이언트 라우팅을 지원하는 링크 엘리먼트입니다.
- * - 내부 링크는 클라이언트 라우팅을 수행하고, 외부 링크는 새로운 페이지로 이동합니다.
- * - 마우스 중간 버튼 클릭 또는 Ctrl 키를 누르면 새로운 탭에서 엽니다.
- */
-export declare class Link extends LitElement {
-    /** 외부 링크 여부 */
-    private isExternal;
-    /** a 태그의 href 속성 및 새로운 페이지로 이동할 때 사용될 링크입니다. */
-    anchorHref: string;
-    /**
-     * - 속성을 정의하지 않으면 basepath로 이동합니다.
-     * - http 로 시작하면 새로운 페이지를 로드합니다.
-     * - 절대경로일 경우 basepath로 시작하면 클라이언트 라우팅을 합니다. 그렇지 않으면 새로운 페이지를 로드합니다.
-     * - 상대경로로 시작하면 (현재의 basepath + 상대경로)로 클라이언트 라우팅을 합니다.
-     * - ?로 시작하면 현재 경로에 쿼리스트링을 추가하고, 클라이언트 라우팅을 합니다.
-     * - #으로 시작하면 현재 경로에 해시를 추가하고, hashchange 이벤트를 발생시킵니다.
-     */
-    href?: string;
-    connectedCallback(): void;
-    disconnectedCallback(): void;
-    protected updated(changedProperties: any): Promise<void>;
-    render(): TemplateResult_2<1>;
-    /**
-     * 링크 엘리먼트의 마우스 이벤트 핸들러
-     * - 새로운 탭에서 열기: 마우스 중간 버튼 또는 Ctrl 키를 누릅니다.
-     * - 새로운 페이지로 이동: http로 시작하거나 절대경로일 경우 새로운 페이지로 이동합니다.
-     * - 클라이언트 라우팅: 상대경로로 시작하면 클라이언트 라우팅을 합니다.
-     */
-    private handleMouseDown;
-    /** 클라이언트 라우팅을 위해 popstate 이벤트를 발생시킵니다. */
-    private dispatchPopstate;
-    /** 클라이언트 라우팅을 위해 hashchange 이벤트를 발생시킵니다. */
-    private dispatchHashchange;
-    /** 기본 a 태그의 클릭 이벤트를 막습니다. */
-    private preventClickEvent;
-    /** a 태그에 주입할 href 값을 계산합니다. */
-    private getAnchorHref;
-    static styles: CSSResult;
-}
-
 declare interface NonIndexRouteConfig extends BaseRouteConfig {
     /**
      * 인덱스 라우트가 아님을 나타냅니다.
@@ -175,28 +138,6 @@ export declare class NotFoundError extends RouteError {
     constructor(path: string, original?: Error | any);
 }
 
-/**
- * 라우트 아웃렛 컴포넌트
- * 라우트 설정에 따라 LitElement 또는 React 컴포넌트를 렌더링합니다.
- */
-export declare class Outlet extends LitElement {
-    private routeId?;
-    private container?;
-    private content?;
-    /** 쉐도우를 사용하지 않고, 직접 렌더링합니다. */
-    protected createRenderRoot(): this;
-    render(): TemplateResult<1>;
-    /**
-     * render 함수의 결과를 렌더링합니다.
-     * - HTMLElement, ReactElement, TemplateResult를 모두 처리할 수 있습니다.
-     */
-    renderContent({ id, content, force }: RenderOption): Promise<HTMLDivElement>;
-    /**
-     * 기존 DOM을 라이프 사이클에 맞게 제거합니다.
-     */
-    clear(): void;
-}
-
 /**
  * u-outlet 요소를 찾을 수 없을 때 발생하는 에러
  */
@@ -356,7 +297,7 @@ export declare class RouteProgressEvent extends RouteEvent {
 }
 
 /**
- * `lit-element`와 `react-component` 기반의 클라이언트 사이드 라우터
+ * `lit-element`, `react`를 지원하는 클라이언트 사이드 라우터
  */
 export declare class Router {
     private readonly _rootElement;
@@ -425,22 +366,75 @@ export declare interface RouterConfig {
     initialLoad?: boolean;
 }
 
-export declare const ULink: ReactWebComponent<Link, {}>;
+/**
+ * - 클라이언트 라우팅을 지원하는 링크 엘리먼트입니다.
+ * - 내부 링크는 클라이언트 라우팅을 수행하고, 외부 링크는 브라우저 기본 네비게이션을 사용합니다.
+ * - Ctrl/Meta/Shift/Alt, 중클릭/우클릭 등은 브라우저 기본 동작(새 탭, 컨텍스트 메뉴 등)을 그대로 유지합니다.
+ */
+export declare class ULink extends LitElement {
+    /** 외부 링크 여부 */
+    private isExternal;
+    /** a 태그에 주입할 href 값 */
+    computedHref: string;
+    /**
+     * a 태그 target을 지원하고 싶으면 열어두는게 좋습니다.
+     * - _blank 등을 쓰면 무조건 브라우저 기본 동작을 따르도록 처리합니다.
+     */
+    target?: string;
+    /**
+     * - 속성을 정의하지 않으면 basepath로 이동합니다.
+     * - http(s)로 시작하면 외부 링크로 간주하고 브라우저 네비게이션을 사용합니다.
+     * - 절대경로(/...)일 경우 basepath로 시작하면 SPA 라우팅 대상이 될 수 있습니다.
+     * - 상대경로는 (basepath + 상대경로)로 SPA 라우팅 대상이 될 수 있습니다.
+     * - ?로 시작하면 현재 pathname에 쿼리스트링을 붙여 SPA 라우팅합니다.
+     * - #으로 시작하면 현재 URL에 해시만 바꾸고(브라우저 기본) 동작합니다.
+     */
+    href?: string;
+    protected willUpdate(changedProperties: PropertyValues): void;
+    render(): TemplateResult_2<1>;
+    /** basepath를 state에서 꺼내는 헬퍼 */
+    private getBasepath;
+    /** a 태그에 주입할 href 값을 계산합니다. */
+    private computeHref;
+    /**
+     * 클릭 가로채기 규칙
+     * - 좌클릭(0) + 보조키 없음(ctrl/meta/shift/alt 없음) + target이 _self일 때만 SPA 라우팅 고려
+     * - 그 외(중클릭/우클릭/보조키/target=_blank 등)는 브라우저 기본 동작 유지
+     */
+    private handleAnchorClick;
+    /** 클라이언트 라우팅을 위해 popstate 이벤트를 발생시킵니다. */
+    private dispatchPopstate;
+    static styles: CSSResult;
+}
 
-export declare const UOutlet: ReactWebComponent<Outlet, {}>;
+/**
+ * 라우트 설정에 따라 LitElement 또는 React 컴포넌트를 렌더링합니다.
+ */
+export declare class UOutlet extends LitElement {
+    private routeId?;
+    private container?;
+    private content?;
+    /** 외부 스타일을 적용하기 위해 라이트 돔을사용 합니다. */
+    protected createRenderRoot(): this;
+    render(): TemplateResult<1>;
+    /**
+     * render 함수의 결과를 렌더링합니다.
+     * - HTMLElement, ReactElement, TemplateResult를 모두 처리할 수 있습니다.
+     */
+    renderContent({ id, content, force }: RenderOption): Promise<HTMLDivElement>;
+    /**
+     * 기존 DOM을 라이프 사이클에 맞게 제거합니다.
+     */
+    clear(): void;
+}
 
 export { }
 
-declare global {
-  interface WindowEventMap {
-    'route-begin': RouteBeginEvent;
-    'route-progress': RouteProgressEvent;
-    'route-done': RouteDoneEvent;
-    'route-error': RouteErrorEvent;
-  }
-
-  interface HTMLElementTagNameMap {
-    'u-link': Link;
-    'u-outlet': Outlet;
-  }
+declare global {
+  interface WindowEventMap {
+    'route-begin': RouteBeginEvent;
+    'route-progress': RouteProgressEvent;
+    'route-done': RouteDoneEvent;
+    'route-error': RouteErrorEvent;
+  }
 }