@iyulab/router 0.15.1 → 0.15.2

package/dist/types/RouteConfig.d.ts

@@ -1,151 +0,0 @@
-import { RouteContext, FallbackRouteContext } from './RouteContext';
-/**
- * 공통 라우트 속성
- */
-interface BaseRouteConfig {
-    /**
-     * 라우터에서 사용하는 식별자
-     */
-    id?: string;
-    /**
-     * 브라우저의 타이틀이 설정에 따라 변경됩니다.
-     */
-    title?: string;
-    /**
-     * 라우터 경로는 string 또는 URLPattern을 사용할 수 있습니다.
-     * string일 경우 자동으로 URLPattern으로 변환됩니다.
-     * @default '/'
-     * @example
-     * - "/user/:id/:name"
-     * - "/user/:id/:name?"
-     * - "/user/:id/:name*"
-     * - "/user/:id/:name+"
-     * @link
-     * https://developer.mozilla.org/en-US/docs/Web/API/URLPattern
-     */
-    path?: string | URLPattern;
-    /**
-     * 라우트 정보를 받아 렌더링 결과를 반환합니다.
-     * @param ctx 현재 라우팅 정보 및, 진행 상태 콜백을 포함하는 Context 객체가 인자로 전달됩니다.
-     * @example
-     * ```typescript
-     * const route = {
-     *    path: '/user:id',
-     *    render: async (ctx) => {
-     *      // 사용자 정보를 비동기로 가져오는 예시
-     *      const userId = ctx.params.id;
-     *      ctx.progress(30);
-     *      const userData = await fetchUserData(userId);
-     *      ctx.progress(70);
-     *      return html`<user-profile .data=${userData}></user-profile>`;
-     *   }
-     * }
-     * ```
-     * @remarks
-     * `render`는 Lit `TemplateResult`, `HTMLElement`, **또는 React 엘리먼트**를 반환할 수 있습니다.
-     * React 엘리먼트를 직접 반환하면 내부 `<u-outlet>`이 `createRoot`/`root.unmount()`를
-     * 자동으로 관리합니다 — React 루트를 직접 만들어 컨테이너 `HTMLElement`로 감싸 반환하면
-     * 이 자동 해제 지점을 우회하게 되어 라우트 전환마다 unmount가 호출되지 않는 누수가 생깁니다.
-     * @example
-     * ```tsx
-     * const route = {
-     *   path: '/users/:id',
-     *   render: (ctx) => <UserProfilePage userId={ctx.params.id} />, // React 엘리먼트를 직접 반환
-     * };
-     * ```
-     */
-    render?: (ctx: RouteContext) => Promise<unknown> | unknown;
-    /**
-     * 이 라우트 진입 전에 호출되는 enter 함수입니다.
-     * - `string` 반환: 해당 경로로 redirect
-     * - `false` 반환: 네비게이션 취소
-     * - `true` 반환: 통과
-     * @example
-     * ```typescript
-     * { path: '/admin', enter: (ctx) => ctx.metadata.role === 'admin' || '/forbidden' }
-     * ```
-     */
-    enter?: (ctx: RouteContext) => Promise<string | boolean> | string | boolean;
-    /**
-     * 이 라우트의 콘텐츠를 **언제 새로 만들 것인가**를 정하는 식별 키입니다.
-     *
-     * 네비게이션마다 `key(ctx)`를 계산해 직전 값과 비교합니다.
-     * - 키가 **바뀌면** 기존 콘텐츠를 내리고 새로 마운트합니다.
-     * - 키가 **같으면** 콘텐츠를 유지한 채 `render(ctx)`의 결과로 **제자리 갱신**합니다 —
-     *   Lit 템플릿은 같은 파트에 다시 렌더(DOM·요소 상태 유지, 바인딩만 갱신), React 엘리먼트는
-     *   같은 root에 다시 렌더(컴포넌트 상태 유지, props만 갱신), `HTMLElement`는 기존 인스턴스를
-     *   그대로 둡니다(조정할 수단이 없습니다). 새 `ctx`는 따로 전달되지 않고 `render(ctx)`를
-     *   통해 도달합니다.
-     *
-     * 기본값: 자식 라우트가 없으면 `ctx => ctx.href`(URL이 조금이라도 바뀌면 새로), 자식 라우트가
-     * 있으면 상수(레이아웃은 유지하고 자식만 바뀝니다).
-     *
-     * @example
-     * ```typescript
-     * // 쿼리스트링만 바뀌면 페이지를 유지하고 prop만 갱신 — 목록 상태·스크롤이 살아남습니다
-     * { path: '/orders', key: ctx => ctx.pathname,
-     *   render: ctx => html`<orders-page .selectedId=${ctx.query.get('id')}></orders-page>` }
-     * // params가 바뀌어도 유지
-     * { path: '/orders/:id', key: () => 'orders', render: ctx => html`...` }
-     * ```
-     */
-    key?: (ctx: RouteContext) => string;
-    /**
-     * 경로 매칭시 대소문자 구분 여부
-     * @default false
-     */
-    ignoreCase?: boolean;
-    /**
-     * 라우트에 연결할 메타데이터
-     * - 인증, SEO, 분석 등의 용도로 사용할 수 있습니다.
-     * @example
-     * ```typescript
-     * { path: '/admin', metadata: { requiresAuth: true, role: 'admin' } }
-     * ```
-     */
-    metadata?: Record<string, unknown>;
-}
-interface IndexRouteConfig extends BaseRouteConfig {
-    /**
-     * 현재 경로의 인덱스 라우트임을 나타냅니다.
-     * - 인덱스 라우트는 부모 경로와 동일한 경로를 가지며, path는 자동으로 설정됩니다.
-     */
-    index: true;
-}
-interface NonIndexRouteConfig extends BaseRouteConfig {
-    /**
-     * 인덱스 라우트가 아님을 나타냅니다.
-     */
-    index?: false;
-    /**
-     * 하위 라우트 설정, 재귀적으로 RouteConfig 배열을 가질 수 있습니다.
-     * - 하위 라우트가 있는 경우, 부모 라우트의 경로를 기준으로 매칭됩니다.
-     */
-    children?: RouteConfig[];
-}
-export type RouteConfig = IndexRouteConfig | NonIndexRouteConfig;
-export interface FallbackRouteConfig {
-    /**
-     * 브라우저의 타이틀이 설정에 따라 변경됩니다.
-     */
-    title?: string;
-    /**
-     * 라우팅 실패 시 표시할 렌더링 결과를 반환합니다.
-     * - 오류가 발생할 경우 또는 렌더링 결과가 false일 경우 호출됩니다.
-     * @param ctx 현재 라우팅 정보 및 오류 정보를 포함하는 Context 객체가 인자로 전달됩니다.
-     * @example
-     * ```typescript
-     * const fallbackRoute = {
-     *    title: 'Not Found',
-     *    render: (ctx) => {
-     *      if (ctx.error) {
-     *        return html`<error-page .error=${ctx.error}></error-page>`;
-     *      }
-     *      return html`<not-found-page></not-found-page>`;
-     *    }
-     * }
-     * ```
-     */
-    render?: (ctx: FallbackRouteContext) => Promise<unknown> | unknown;
-}
-export {};

package/dist/types/RouteContext.d.ts

@@ -1,85 +0,0 @@
-import { RouteError } from './RouteError';
-/**
- * 라우터 정보
- */
-export interface RouteContext {
-    /**
-     * 전체 URL 정보
-     * - 도메인 이름을 포함한 URL의 전체 경로입니다.
-     * @example https://www.iyulab.com/home/user/1?name=iyu#profile
-     */
-    href: string;
-    /**
-     * URL 도메인 이름
-     * - URL의 도메인 이름입니다.
-     * @example https://www.iyulab.com
-     */
-    origin: string;
-    /**
-     * 라우터 URL 기본 경로
-     * - 라우터의 현재 basepath입니다.
-     * @example
-     * if basepath is /app/:id
-     * set basepath to /app/123
-     */
-    basepath: string;
-    /**
-     * 라우터 URL 전체 경로
-     * - 도메인 이름을 제외한 URL의 전체 경로입니다.
-     * @example /home/user/1?name=iyu#profile
-     */
-    path: string;
-    /**
-     * 라우터 URL 절대 경로
-     * - 쿼리스트링과 해시를 제외한 URL 경로입니다.
-     * @example /home/user/1
-     */
-    pathname: string;
-    /**
-     * 라우터 URL 파라미터
-     * - URLPattern을 사용하여 파싱된 파라미터입니다.
-     * @example 만약 URL이 /user/:id/:name 일경우
-     * ```typescript
-     * const id = params.id;
-     * const name = params.name;
-     * ```
-     */
-    params: {
-        [key: string]: string | undefined;
-    };
-    /**
-     * 라우터 URL 쿼리스트링
-     * - URLSearchParams를 사용하여 파싱된 쿼리스트링입니다.
-     * @example 만약 URL이 ?page=1&size=10 일경우
-     * ```typescript
-     * const page = query.get('page');
-     * const size = query.get('size');
-     * ```
-     */
-    query: URLSearchParams;
-    /**
-     * 라우터 URL 해시
-     * - URL의 해시값입니다. 해시값은 하나만 사용할 수 있습니다.
-     * - #profile#user 두개 이상의 해시값은 하나로 취급합니다.
-     * @example #profile
-     */
-    hash?: string;
-    /**
-     * 현재 라우팅의 진행 상태를 업데이트하여, window 객체의 'route-progress' 이벤트를 트리거합니다.
-     * 여러 라우팅이 호출되는 경우, 가장 최근의 라우팅의 진행 상태만 반영되며, 나머지는 무시됩니다.
-     * @param value 진행 상태 값 (0~100)
-     */
-    progress: (value: number) => void;
-    /**
-     * 매칭된 라우트 체인의 병합된 메타데이터
-     * - 부모 라우트에서 자식 라우트 순서로 병합됩니다.
-     */
-    metadata: Record<string, unknown>;
-}
-export interface FallbackRouteContext extends RouteContext {
-    /**
-     * 라우팅 에러 정보
-     * - 라우팅 중 발생한 에러 정보를 포함합니다.
-     */
-    error: RouteError;
-}

package/dist/types/RouteError.d.ts

@@ -1,52 +0,0 @@
-/**
- * 라우팅 에러 정보
- */
-export declare class RouteError extends Error {
-    /**
-     * 에러 코드
-     * - HTTP 상태 코드 또는 커스텀 에러 코드
-     * @example 404, 500, 'ROUTE_NOT_FOUND'
-     */
-    code: number | string;
-    /**
-     * 원본 에러 객체
-     * - 원본 Error 객체 또는 예외 정보
-     */
-    original?: Error | any;
-    /**
-     * 에러 발생 시간
-     * - 에러가 발생한 시간 (ISO 8601 형식)
-     */
-    timestamp: string;
-    constructor(code: number | string, message: string, original?: Error | any);
-}
-/**
- * 페이지를 찾을 수 없을 때 발생하는 에러
- */
-export declare class NotFoundError extends RouteError {
-    constructor(path: string, original?: Error | any);
-}
-/**
- * enter 가드가 false를 반환하여 접근이 거부되었을 때 발생하는 에러
- */
-export declare class AccessDeniedError extends RouteError {
-    constructor(path: string);
-}
-/**
- * u-outlet 요소를 찾을 수 없을 때 발생하는 에러
- */
-export declare class OutletMissingError extends RouteError {
-    constructor();
-}
-/**
- * 컨텐츠 로드시 나타나는 에러
- */
-export declare class ContentLoadError extends RouteError {
-    constructor(original?: Error | any);
-}
-/**
- * 컨텐츠 렌더링시 발생하는 에러
- */
-export declare class ContentRenderError extends RouteError {
-    constructor(original?: Error | any);
-}

package/dist/types/RouteEvent.d.ts

@@ -1,54 +0,0 @@
-import { RouteContext } from './RouteContext';
-import { RouteError } from './RouteError';
-/** 라우터 이벤트 기본 클래스 */
-declare abstract class RouteEvent extends Event {
-    /** 라우팅 정보 */
-    readonly context: RouteContext;
-    /** 이벤트 발생 시간 */
-    readonly timestamp: string;
-    constructor(type: string, context: RouteContext, cancelable?: boolean);
-    /** 이벤트가 취소되었는지 확인 */
-    get cancelled(): boolean;
-    /** 이벤트 취소 */
-    cancel(): void;
-}
-/**
- * 라우트 시작 이벤트
- */
-export declare class RouteBeginEvent extends RouteEvent {
-    constructor(context: RouteContext);
-}
-/**
- * 라우트 진행 이벤트
- */
-export declare class RouteProgressEvent extends RouteEvent {
-    /** 진행 상태 값 (0~100) */
-    readonly progress: number;
-    constructor(context: RouteContext, progress: number);
-}
-/**
- * 라우트 완료 이벤트
- */
-export declare class RouteDoneEvent extends RouteEvent {
-    constructor(context: RouteContext);
-}
-/**
- * 라우트 에러 이벤트
- */
-export declare class RouteErrorEvent extends RouteEvent {
-    /** 에러 정보 */
-    readonly error: RouteError;
-    constructor(context: RouteContext, error: RouteError);
-}
-/**
- * 전역 WindowEventMap에 라우터 이벤트 타입
- */
-declare global {
-    interface WindowEventMap {
-        'route-begin': RouteBeginEvent;
-        'route-progress': RouteProgressEvent;
-        'route-done': RouteDoneEvent;
-        'route-error': RouteErrorEvent;
-    }
-}
-export {};

package/dist/types/RouterConfig.d.ts

@@ -1,52 +0,0 @@
-import { FallbackRouteConfig, RouteConfig } from './RouteConfig';
-import { RouteContext } from './RouteContext';
-/**
- * 라우터 설정
- */
-export interface RouterConfig {
-    /**
-   * 라우터가 연결될 최상위 엘리먼트
-   */
-    root: HTMLElement;
-    /**
-     * 라우터의 기본 경로
-     * - 라우터의 기본 경로는 URL의 시작점입니다.
-     * - URLPattern을 사용하여 경로를 탐색합니다.
-     * @default  '/'
-     */
-    basepath?: string;
-    /**
-     * 라우트 설정
-     * - 라우트는 URLPattern을 사용하여 경로를 탐색합니다.
-     * - 라우트는 렌더링할 엘리먼트 또는 컴포넌트를 지정합니다.
-     */
-    routes?: RouteConfig[];
-    /**
-     * 모든 라우트 전환 전에 호출되는 글로벌 enter 함수입니다.
-     * - `string` 반환: 해당 경로로 redirect
-     * - `false` 반환: 네비게이션 취소
-     * - `true` 반환: 통과
-     * @example
-     * ```typescript
-     * enter: async (ctx) => {
-     *   if (!isAuthenticated() && ctx.pathname !== '/login') return '/login';
-     * }
-     * ```
-     */
-    enter?: (ctx: RouteContext) => Promise<string | boolean> | string | boolean;
-    /**
-     * 라우트 매칭 실패 또는 오류 발생 시 대체 라우트 설정
-     * - 지정된 설정이 없을 경우, 기본 오류 페이지가 렌더링됩니다.
-     */
-    fallback?: FallbackRouteConfig;
-    /**
-     * `a` 태그 클릭 시 클라이언트 라우팅을 수행할지 여부를 설정합니다.
-     * @default true
-     */
-    useIntercept?: boolean;
-    /**
-     * 초기 로드 시 현재 URL로 라우팅을 자동으로 수행할지 여부를 설정합니다.
-     * @default true
-     */
-    initialLoad?: boolean;
-}