@viewfly/router 2.0.0-alpha.1 → 2.0.0-alpha.4

package/bundles/index.d.ts

@@ -1,29 +1,68 @@
-import * as _viewfly_core_jsx_runtime from '@viewfly/core/jsx-runtime';
-import { ComponentSetup, Props, Module, Application } from '@viewfly/core';
 import { Observable } from '@tanbo/stream';
+import { ComponentSetup, Props, Module, Application } from '@viewfly/core';
+import * as _viewfly_core_jsx_runtime from '@viewfly/core/jsx-runtime';
+
+interface UrlRelativePath {
+    type: 'toParent';
+}
+interface UrlChildPath {
+    type: 'toChild';
+    value: string;
+}
+interface UrlQuery {
+    type: 'query';
+    params: UrlQueryParams;
+}
+interface UrlQueryParams {
+    [key: string]: string | string[];
+}
+interface UrlHash {
+    type: 'hash';
+    value: string;
+}
+type UrlToken = UrlRelativePath | UrlChildPath | UrlQuery | UrlHash;
+interface UrlTree {
+    paths: string[];
+    queryParams: UrlQueryParams;
+    hash: string | null;
+}
+declare class UrlParser {
+    private index;
+    private url;
+    private tokens;
+    parse(url: string): UrlTree;
+    private readHash;
+    private readQuery;
+    private readQueryValue;
+    private readQueryKey;
+    private readPath;
+    private not;
+    private peek;
+    private ignore;
+}
+
+declare function useQueryParams<T extends UrlQueryParams>(): T;
 
 interface RouteConfig {
     path: string;
     component?: ComponentSetup;
     asyncComponent?: () => Promise<ComponentSetup>;
     beforeEach?(): boolean | Promise<boolean>;
+    afterEach?(): void;
+    redirectTo?: string | ((path: string) => string | NavigatorParams);
 }
 declare class Router {
     private navigator;
     parent: Router | null;
-    path: string;
     onRefresh: Observable<void>;
-    get pathname(): string;
-    get beforePath(): string;
+    get deep(): number;
+    get path(): string;
     private refreshEvent;
-    constructor(navigator: Navigator, parent: Router | null, path: string);
-    navigateTo(path: string, params?: QueryParams, fragment?: string): void;
+    constructor(navigator: Navigator, parent: Router | null);
+    navigateTo(path: string, params?: QueryParams, fragment?: string | null): void;
     replaceTo(path: string, params?: QueryParams): void;
-    refresh(path: string): void;
-    consumeConfig(routes: RouteConfig[]): {
-        remainingPath: string;
-        routeConfig: RouteConfig;
-    } | null;
+    refresh(): void;
+    consumeConfig(routes: RouteConfig[]): RouteConfig | null;
     back(): void;
     forward(): void;
     go(offset: number): void;
@@ -35,6 +74,7 @@ interface QueryParams {
 }
 declare abstract class Navigator {
     baseUrl: string;
+    abstract urlTree: UrlTree;
     protected constructor(baseUrl: string);
     abstract onUrlChanged: Observable<void>;
     abstract get pathname(): string;
@@ -52,12 +92,24 @@ interface UrlFormatParams {
 }
 declare function formatUrl(pathname: string, urlFormatParams: UrlFormatParams): string;
 declare function formatQueryParams(queryParams: QueryParams): string;
+interface NavigatorParams {
+    pathname: string;
+    queryParams: QueryParams;
+    fragment: string | null;
+}
+interface NavigatorHooks {
+    beforeEach?(currentParams: NavigatorParams, nextParams: NavigatorParams, next: () => void): void;
+    afterEach?(params: NavigatorParams): void;
+}
 declare class BrowserNavigator extends Navigator {
+    private hooks;
     onUrlChanged: Observable<void>;
     get pathname(): string;
+    private urlParser;
+    urlTree: UrlTree;
     private urlChangeEvent;
     private subscription;
-    constructor(baseUrl: string);
+    constructor(baseUrl: string, hooks?: NavigatorHooks);
     to(pathName: string, relative: Router, queryParams?: QueryParams, fragment?: string): boolean;
     replace(pathName: string, relative: Router, queryParams?: QueryParams, fragment?: string): boolean;
     join(pathname: string, relative: Router, queryParams?: QueryParams, fragment?: string): string;
@@ -65,6 +117,8 @@ declare class BrowserNavigator extends Navigator {
     forward(): void;
     go(offset: number): void;
     destroy(): void;
+    private runHooks;
+    private getUrlTree;
 }
 
 interface LinkProps extends Props {
@@ -78,18 +132,18 @@ interface LinkProps extends Props {
 }
 declare function Link(props: LinkProps): () => _viewfly_core_jsx_runtime.JSX.Element;
 
-interface RouterOutletProps extends Props {
-    config: RouteConfig[];
-}
-declare function RouterOutlet(props: RouterOutletProps): () => _viewfly_core_jsx_runtime.JSX.Element;
-
 declare class RouterModule implements Module {
     baseUrl: string;
     private subscription;
     private navigator;
-    constructor(baseUrl?: string);
+    constructor(baseUrl?: string, hooks?: NavigatorHooks);
     setup(app: Application): void;
     onDestroy(): void;
 }
 
-export { BrowserNavigator, Link, type LinkProps, Navigator, type QueryParams, type RouteConfig, Router, RouterModule, RouterOutlet, type RouterOutletProps, type UrlFormatParams, formatQueryParams, formatUrl };
+interface RouterOutletProps extends Props {
+    config: RouteConfig[];
+}
+declare function RouterOutlet(props: RouterOutletProps): () => _viewfly_core_jsx_runtime.JSX.Element;
+
+export { BrowserNavigator, Link, type LinkProps, Navigator, type NavigatorHooks, type NavigatorParams, type QueryParams, type RouteConfig, Router, RouterModule, RouterOutlet, type RouterOutletProps, type UrlChildPath, type UrlFormatParams, type UrlHash, UrlParser, type UrlQuery, type UrlQueryParams, type UrlRelativePath, type UrlToken, type UrlTree, formatQueryParams, formatUrl, useQueryParams };