@wcstack/router 1.3.18 → 1.4.0

package/README.ja.md

@@ -2,9 +2,9 @@
 
 **もしルーティングがただのHTMLタグだったら？**
 
-アプリのナビゲーション構造をマークアップで定義する未来を妄想してみる。ネストされたルート、レイアウト、型付きパラメータ — すべてがネイティブなHTML要素として存在する。ルーター設定オブジェクトもJavaScriptの儀式も不要。タグが「どこに何を置くか」を語る。
+アプリのナビゲーション構造をマークアップだけで定義できる未来を想像してみてください。ネストされたルート、レイアウト、型付きパラメータ — これらすべてがネイティブなHTML要素として存在します。ルーター設定オブジェクトも、JavaScriptの煩雑な手続きも不要です。タグそのものが、「どこに何を配置するか」を明確に示します。
 
-それが `<wcs-router>`, `<wcs-route>` たちの探求するもの。CDN一発、依存ゼロ、構文はHTML。
+これこそが `<wcs-router>`, `<wcs-route>` が追求するコンセプトです。CDNからの読み込みのみで動作し、依存ライブラリはゼロ。構文はすべてHTMLです。
 
 ## 特徴
 

package/dist/index.d.ts

@@ -12,6 +12,17 @@ interface IWritableConfig {
     enableShadowRoot?: boolean;
     basenameFileExtensions?: string[];
 }
+type BuiltinParamTypes = "int" | "float" | "bool" | "uuid" | "slug" | "isoDate" | "any";
+interface IWcBindableProperty {
+    readonly name: string;
+    readonly event: string;
+    readonly getter?: (event: Event) => any;
+}
+interface IWcBindable {
+    readonly protocol: "wc-bindable";
+    readonly version: number;
+    readonly properties: IWcBindableProperty[];
+}
 
 /**
  * Initialize the router with optional configuration.
@@ -20,5 +31,128 @@ interface IWritableConfig {
  */
 declare function bootstrapRouter(config?: Partial<IWritableConfig>): void;
 
-export { bootstrapRouter };
-export type { IWritableConfig, IWritableTagNames };
+interface IRouteMatchResult {
+    routes: IRoute[];
+    params: Record<string, string>;
+    typedParams: Record<string, any>;
+    path: string;
+    lastPath: string;
+}
+type GuardHandler = (toPath: string, fromPath: string) => boolean | Promise<boolean>;
+type SegmentType = 'static' | 'param' | 'catch-all';
+interface ISegmentInfo {
+    type: SegmentType;
+    segmentText: string;
+    paramName: string | null;
+    pattern: RegExp;
+    isIndex?: boolean;
+    paramType?: BuiltinParamTypes;
+}
+interface IRouteChildContainer {
+    readonly routeChildNodes: IRoute[];
+}
+interface IRoute extends IRouteChildContainer {
+    readonly routeParentNode: IRoute | null;
+    readonly routerNode: IRouter;
+    readonly path: string;
+    readonly isRelative: boolean;
+    readonly absolutePath: string;
+    readonly uuid: string;
+    readonly placeHolder: Comment;
+    readonly childNodeArray: Node[];
+    readonly routes: IRoute[];
+    params: Record<string, string>;
+    typedParams: Record<string, any>;
+    readonly paramNames: string[];
+    readonly absoluteParamNames: string[];
+    readonly weight: number;
+    readonly absoluteWeight: number;
+    readonly childIndex: number;
+    readonly name: string;
+    readonly fullpath: string;
+    readonly segmentCount: number;
+    readonly absoluteSegmentCount: number;
+    readonly segmentInfos: ISegmentInfo[];
+    readonly absoluteSegmentInfos: ISegmentInfo[];
+    guardHandler: GuardHandler;
+    shouldChange(newParams: Record<string, string>): boolean;
+    guardCheck(matchResult: IRouteMatchResult): Promise<void>;
+    initialize(routerNode: IRouter, parentRouteNode: IRoute | null): void;
+    testAncestorNode(ancestorNode: IRoute): boolean;
+    setParams(params: Record<string, string>, typedParams: Record<string, any>): void;
+    clearParams(): void;
+}
+interface IRouter extends IRouteChildContainer {
+    readonly basename: string;
+    readonly outlet: IOutlet;
+    readonly template: HTMLTemplateElement;
+    fallbackRoute: IRoute | null;
+    path: string;
+    navigate(path: string): Promise<void>;
+}
+interface IOutlet {
+    routesNode: IRouter;
+    readonly rootNode: HTMLElement | ShadowRoot;
+    lastRoutes: IRoute[];
+}
+
+interface RouteParseOptions {
+    isIndex?: boolean;
+    isFallback?: boolean;
+    hasGuard?: boolean;
+    guardFallback?: string | null;
+    name?: string;
+}
+declare class RouteCore extends EventTarget {
+    static wcBindable: IWcBindable;
+    private _target;
+    private _parentCore;
+    private _path;
+    private _name;
+    private _isFallbackRoute;
+    private _segmentInfos;
+    private _absoluteSegmentInfos;
+    private _paramNames;
+    private _absoluteParamNames;
+    private _weight;
+    private _absoluteWeight;
+    private _segmentCount;
+    private _params;
+    private _typedParams;
+    private _active;
+    private _hasGuard;
+    private _guardHandler;
+    private _guardFallbackPath;
+    private _waitForSetGuardHandler;
+    private _resolveSetGuardHandler;
+    constructor(target?: EventTarget);
+    get parentCore(): RouteCore | null;
+    set parentCore(value: RouteCore | null);
+    get path(): string;
+    get name(): string;
+    get isFallbackRoute(): boolean;
+    get isRelative(): boolean;
+    get segmentInfos(): ISegmentInfo[];
+    private _checkParentCore;
+    get absolutePath(): string;
+    get absoluteSegmentInfos(): ISegmentInfo[];
+    get params(): Record<string, string>;
+    get typedParams(): Record<string, any>;
+    get active(): boolean;
+    get paramNames(): string[];
+    get absoluteParamNames(): string[];
+    get weight(): number;
+    get absoluteWeight(): number;
+    get segmentCount(): number;
+    get absoluteSegmentCount(): number;
+    parsePath(path: string, options?: RouteParseOptions): void;
+    setParams(params: Record<string, string>, typedParams: Record<string, any>): void;
+    clearParams(): void;
+    shouldChange(newParams: Record<string, string>): boolean;
+    get guardHandler(): GuardHandler;
+    set guardHandler(value: GuardHandler);
+    guardCheck(matchResult: IRouteMatchResult): Promise<void>;
+}
+
+export { RouteCore, bootstrapRouter };
+export type { IWritableConfig, IWritableTagNames, RouteParseOptions };