@viewfly/router 3.0.0-alpha.8 → 3.0.0

package/dist/link.d.ts

@@ -5,7 +5,7 @@ export interface LinkProps extends Props {
     active?: string;
     exact?: boolean;
     queryParams?: QueryParams;
-    fragment?: string;
+    hash?: string;
     tag?: string;
     [key: string]: any;
 }

package/dist/providers/_api.d.ts

@@ -1,3 +1,4 @@
 export * from './navigator';
 export * from './router';
+export * from './routes';
 export * from './url-parser';

package/dist/providers/navigator.d.ts

@@ -10,24 +10,28 @@ export declare abstract class Navigator {
     protected constructor(baseUrl: string);
     abstract onUrlChanged: Observable<void>;
     abstract get pathname(): string;
-    abstract to(pathName: string, relative: Router, queryParams?: QueryParams, fragment?: string): boolean;
-    abstract replace(pathName: string, relative: Router, queryParams?: QueryParams, fragment?: string): boolean;
-    abstract join(pathName: string, relative: Router, queryParams?: QueryParams, fragment?: string): string;
+    abstract to(pathName: string, relative: Router, queryParams?: QueryParams, hash?: string | null): boolean;
+    abstract replace(pathName: string, relative: Router, queryParams?: QueryParams, hash?: string | null): boolean;
+    abstract join(pathName: string, relative: Router, queryParams?: QueryParams, hash?: string | null): string;
     abstract back(): void;
     abstract forward(): void;
     abstract go(offset: number): void;
+    /** 当前一次由 Router 触发的地址变更已被对应页面接受 */
+    abstract confirmNavigation(): void;
+    /** 当前一次由 Router 触发的地址变更被页面守卫拒绝，需要回滚地址栏 */
+    abstract cancelNavigation(): void;
     abstract destroy(): void;
 }
 export interface UrlFormatParams {
     queryParams?: QueryParams;
-    fragment?: string;
+    hash?: string | null;
 }
 export declare function formatUrl(pathname: string, urlFormatParams: UrlFormatParams): string;
 export declare function formatQueryParams(queryParams: QueryParams): string;
 export interface NavigatorParams {
     pathname: string;
     queryParams: QueryParams;
-    fragment: string | null;
+    hash: string | null;
 }
 export interface NavigatorHooks {
     beforeEach?(currentParams: NavigatorParams, nextParams: NavigatorParams, next: () => void): void;
@@ -36,6 +40,7 @@ export interface NavigatorHooks {
 export declare class BrowserNavigator extends Navigator {
     private hooks;
     onUrlChanged: Observable<void>;
+    private pendingNavigation;
     /** 挂载在 location 上的路径前缀；'' 或 '/' 表示站点根，不做剥离 */
     private get basePathPrefix();
     get pathname(): string;
@@ -44,13 +49,22 @@ export declare class BrowserNavigator extends Navigator {
     private urlChangeEvent;
     private subscription;
     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;
+    to(pathName: string, relative: Router, queryParams?: QueryParams, hash?: string | null): boolean;
+    replace(pathName: string, relative: Router, queryParams?: QueryParams, hash?: string | null): boolean;
+    join(pathname: string, relative: Router, queryParams?: QueryParams, hash?: string | null): string;
     back(): void;
     forward(): void;
     go(offset: number): void;
+    confirmNavigation(): void;
+    cancelNavigation(): void;
     destroy(): void;
     private runHooks;
-    private getUrlTree;
+    private stripBaseFromLocationPathname;
+    /**
+     * 按与 `history.pushState` / `replaceState` 写入会话的 URL 解析 urlTree（与传入 `join` 的相对路径一致）。
+     * History 更新后若仍仅从 `Location` 读路径，可能与实际会话 URL 不一致（如 Location 与 document 的同步时序、部分宿主环境）。
+     */
+    private readUrlTreeFromHistoryHref;
+    private readUrlTreeFromLocation;
+    private getCurrentUrl;
 }

package/dist/providers/query-encoding.d.ts

@@ -0,0 +1,3 @@
+/** 查询串组件：写入 URL 时 encode，从 URL 解析出对象时 decode（与常见路由约定一致）。 */
+export declare function encodeQueryParamComponent(value: string): string;
+export declare function decodeQueryParamComponent(value: string): string;

package/dist/providers/router.d.ts

@@ -1,28 +1,44 @@
 import { Observable } from '@tanbo/stream';
-import { ComponentSetup } from '@viewfly/core';
-import { Navigator, NavigatorParams, QueryParams } from './navigator';
-export interface RouteConfig {
-    path: string;
-    component?: ComponentSetup;
-    asyncComponent?: () => Promise<ComponentSetup>;
-    beforeEach?(): boolean | Promise<boolean>;
-    afterEach?(): void;
-    redirectTo?: string | ((path: string) => string | NavigatorParams);
-}
+import { Navigator, QueryParams } from './navigator';
+import { Params, Route } from './routes';
 export declare class Router {
     private navigator;
     parent: Router | null;
     onRefresh: Observable<void>;
+    private lastResolvedParams;
+    /** 当前重定向链上已解析过的 path 段（规范化后）；非重定向成功匹配后清空 */
+    private redirectTrail;
+    private static readonly maxRedirectHops;
+    /** 当前层最近一次匹配所消费的 URL 段数（默认 1，保持历史行为） */
+    private consumedSegments;
+    private routeParams;
+    /**
+     * 本次 `resolve` 命中的 `route.path` 上的动态段（供子 Router、`canActivate`、`redirectTo`）。
+     * 与 `params` 按层隔离（对齐 Angular）：有 `parent` 时 `params` 只表示本层注入域，不由子级匹配覆盖。
+     */
+    lastResolvePathParams: Params;
     get deep(): number;
+    private get remainingPaths();
     get path(): string;
+    get params(): Params;
+    setParams(params: Params): void;
     private refreshEvent;
     constructor(navigator: Navigator, parent: Router | null);
-    navigateTo(path: string, params?: QueryParams, fragment?: string | null): void;
-    replaceTo(path: string, params?: QueryParams): void;
+    navigateTo(path: string, queryParams?: QueryParams, hash?: string | null): void;
+    replaceTo(path: string, queryParams?: QueryParams, hash?: string | null): void;
     refresh(): void;
-    consumeConfig(routes: RouteConfig[]): RouteConfig | null;
+    resolve(routes: Route[]): Route | null;
     back(): void;
     forward(): void;
     go(offset: number): void;
+    private clearRedirectTrail;
+    private getNavigatorParams;
+    private cloneNavigatorParams;
+    private beginRedirectResolution;
+    private assertRedirectTarget;
+    private splitRoutePath;
+    /** 单段路由：`user` | `:id` | `:id?`（`?` 仅表示可选；整条 path 里 `:…?` 只允许出现在最后一段，由 matchRoutePath 校验） */
+    private parseRouteSegment;
+    private matchRoutePath;
     private matchRoute;
 }

package/dist/providers/routes.d.ts

@@ -0,0 +1,32 @@
+import { ComponentSetup, InjectionToken } from '@viewfly/core';
+import { NavigatorParams } from './navigator';
+import { Router } from './router';
+/** URL path 上由 `:param` 解析得到的键值（与查询串 `queryParams` 区分） */
+export type Params = Record<string, string>;
+export interface CanActivateContext {
+    to: NavigatorParams;
+    from: NavigatorParams | null;
+    router: Router;
+    params: Params;
+}
+export interface RedirectContext {
+    to: NavigatorParams;
+    from: NavigatorParams | null;
+    router: Router;
+    params: Params;
+}
+export interface NamedRouteComponent {
+    name: string;
+    component?: ComponentSetup;
+    asyncComponent?: () => Promise<ComponentSetup>;
+}
+export interface Route {
+    path: string;
+    component?: ComponentSetup;
+    children?: Route[] | (() => Promise<Route[]>);
+    namedComponents?: NamedRouteComponent[];
+    asyncComponent?: () => Promise<ComponentSetup>;
+    canActivate?(context: CanActivateContext): boolean | Promise<boolean>;
+    redirectTo?: string | ((context: RedirectContext) => string | NavigatorParams);
+}
+export declare const Routes: InjectionToken<Route[]>;

package/dist/providers/url-parser.d.ts

@@ -7,7 +7,7 @@ export interface UrlChildPath {
 }
 export interface UrlQuery {
     type: 'query';
-    params: UrlQueryParams;
+    queryParams: UrlQueryParams;
 }
 export interface UrlQueryParams {
     [key: string]: string | string[];

package/dist/router-module.d.ts

@@ -1,10 +1,16 @@
 import { Application, Module } from '@viewfly/core';
 import { NavigatorHooks } from './providers/navigator';
+import { Route } from './providers/routes';
+export interface RouterConfig {
+    baseUrl?: string;
+    routes?: Route[];
+    hooks?: NavigatorHooks;
+}
 export declare class RouterModule implements Module {
-    baseUrl: string;
+    config: RouterConfig;
     private subscription;
     private navigator;
-    constructor(baseUrl?: string, hooks?: NavigatorHooks);
+    constructor(config: RouterConfig);
     setup(app: Application): void;
     onDestroy(): void;
 }

package/dist/router-outlet.d.ts

@@ -1,6 +1,5 @@
 import { Props } from '@viewfly/core';
-import { RouteConfig } from './providers/_api';
 export interface RouterOutletProps extends Props {
-    config: RouteConfig[];
+    name?: string;
 }
 export declare function RouterOutlet(props: RouterOutletProps): () => import("@viewfly/core").JSX.Element;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@viewfly/router",
-  "version": "3.0.0-alpha.8",
+  "version": "3.0.0",
   "description": "A routing library based on the Viewfly framework that can be run in the browser or Nodejs background.",
   "main": "./dist/index.js",
   "module": "./dist/index.esm.js",
@@ -19,7 +19,7 @@
   "keywords": [],
   "dependencies": {
     "@tanbo/stream": "^1.2.4",
-    "@viewfly/core": "^3.0.0-alpha.8",
+    "@viewfly/core": "^3.0.0",
     "url": "^0.11.4"
   },
   "devDependencies": {