Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 | 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x | import type { IncomingMessage, ServerResponse } from 'node:http';
import type { MatchFunction } from 'path-to-regexp';
import type { Route } from './route';
import type { Router } from './router';
// Re-export Route type for backward compatibility
export type { Route };
// ============================================================================
// Utility types
// ============================================================================
export type Awaitable<T> = T | Promise<T>;
// ============================================================================
// Core enums
// ============================================================================
export enum RouterMode {
history = 'history',
memory = 'memory'
}
export enum RouteType {
push = 'push',
replace = 'replace',
restartApp = 'restartApp',
go = 'go',
forward = 'forward',
back = 'back',
unknown = 'unknown',
pushWindow = 'pushWindow',
replaceWindow = 'replaceWindow',
pushLayer = 'pushLayer'
}
// ============================================================================
// Hook function types
// ============================================================================
export type RouteConfirmHookResult =
| void
| false
| RouteLocationInput
| RouteHandleHook;
export type RouteConfirmHook = (
to: Route,
from: Route | null,
router: Router
) => Awaitable<RouteConfirmHookResult>;
export type RouteVerifyHook = (
to: Route,
from: Route | null,
router: Router
) => Awaitable<boolean>;
export type RouteHandleHook = (
to: Route,
from: Route | null,
router: Router
) => Awaitable<RouteHandleResult>;
export type RouteNotifyHook = (
to: Route,
from: Route | null,
router: Router
) => void;
// ============================================================================
// Basic data types
// ============================================================================
export type RouteMeta = Record<string | symbol, unknown>;
export type RouteState = Record<string, unknown>;
export type RouteHandleResult = unknown | null | void;
/**
* Route matching type
* - 'route': Route-level matching, compare if route configurations are the same
* - 'exact': Exact matching, compare if paths are exactly the same
* - 'include': Include matching, check if current path contains target path
*/
export type RouteMatchType = 'route' | 'exact' | 'include';
// ============================================================================
// Route location and config types
// ============================================================================
export interface RouteLocation {
path?: string;
url?: string | URL;
params?: Record<string, string>;
query?: Record<string, string | undefined>;
queryArray?: Record<string, string[] | undefined>;
hash?: string;
state?: RouteState;
/** When `true`, maintains current scroll position after navigation (default behavior scrolls to top) */
keepScrollPosition?: boolean;
statusCode?: number | null;
layer?: RouteLayerOptions | null;
confirm?: RouteConfirmHook | null;
}
export type RouteLocationInput = RouteLocation | string;
export interface RouteConfig {
/** Pass a URL-encoded path */
path: string;
component?: unknown;
children?: RouteConfig[];
redirect?: RouteLocationInput | RouteConfirmHook;
meta?: RouteMeta;
app?: string | RouterMicroAppCallback;
asyncComponent?: () => Promise<unknown>;
beforeEnter?: RouteConfirmHook;
beforeUpdate?: RouteConfirmHook;
beforeLeave?: RouteConfirmHook;
/** Mark this route as only effective in layer mode */
layer?: boolean;
/**
* Require an index child route to match the parent path
*
* When set to `true`, the parent route will not match its own path
* if no child route matches. The parent route requires a `path: ''`
* index child route to match the parent path itself.
*
* - `requireIndex: false` (default): If no child route matches,
* the matcher falls back to matching the parent route itself
* - `requireIndex: true`: If no child route matches, the parent
* route is skipped entirely (no fallback to self-match)
*
* @default false
*
* @example
* ```typescript
* // requireIndex: true - /A won't match without index child
* {
* path: '/A',
* requireIndex: true,
* children: [
* { path: '', component: IndexComponent }, // /A matches this
* { path: 'a', component: AComponent } // /A/a matches this
* ]
* }
*
* // Default behavior - /A matches even without index child
* {
* path: '/A',
* children: [
* { path: 'a', component: AComponent } // /A/a matches, /A also matches (parent self)
* ]
* }
* ```
*/
requireIndex?: boolean;
/**
* Route override function for hybrid app development
*
* Note: Override is not executed during initial route loading
*
* @param to Target route
* @param from Source route
* @returns Function to execute instead of default routing, or void for default
*
* @example
* ```typescript
* override: (to, from) => {
* if (isInApp()) {
* return () => JSBridge.openNative();
* }
* }
* ```
*/
override?: RouteConfirmHook;
}
export interface RouteParsedConfig extends RouteConfig {
/** Require an index child route to match the parent path (always has a value after parsing) */
requireIndex: boolean;
compilePath: string;
children: RouteParsedConfig[];
match: MatchFunction;
compile: (params?: Record<string, string>) => string;
}
export interface RouteMatchResult {
readonly matches: readonly RouteParsedConfig[];
readonly params: Record<string, string | string[]>;
}
export type RouteMatcher = (
to: URL,
base: URL,
cb?: (item: RouteParsedConfig) => boolean
) => RouteMatchResult;
/**
* Route constructor options interface
*/
export interface RouteOptions {
/** Router parsed options */
options?: RouterParsedOptions;
/** Route type */
toType?: RouteType;
/** Target route location */
toInput?: RouteLocationInput;
/** Source URL */
from?: URL | null;
}
// ============================================================================
// Router Layer types
// ============================================================================
export interface RouteLayerOptions {
/**
* Layer zIndex value
* If not set, will automatically use incremental layer value (1000 + increment)
*/
zIndex?: number;
/**
* Hook function to determine layer keep-alive behavior before route closure
* Determines whether the layer should remain open during navigation
* - 'exact': Keep layer alive only when navigating to the exact initial path (default)
* - 'include': Keep layer alive when navigating to paths that start with the initial path
* - function: Custom logic to determine if the layer should be kept alive
* @default 'exact'
* @example
* ```typescript
* // Default behavior - keep only when navigating back to initial path
* keepAlive: 'exact'
*
* // Keep layer alive for all sub-paths (paths starting with the initial path)
* keepAlive: 'include'
*
* // Custom logic
* keepAlive: (to, from, router) => to.query.keepLayer === 'true'
* ```
*/
keepAlive?: 'exact' | 'include' | RouteVerifyHook;
/**
* @deprecated Use keepAlive instead
* Verification hook function before route closure
* @returns Return true to allow closure, false to prevent closure
*/
shouldClose?: RouteVerifyHook;
/**
* Whether to automatically record route history
* @default true
*/
autoPush?: boolean;
/**
* Route navigation mode control
* - When autoPush is true:
* - true: Use push mode (add new history record)
* - false: Use replace mode (replace current history record)
* @default true
*/
push?: boolean;
/**
* Router options for creating the layer instance
* These options will be merged with the default router configuration
*/
routerOptions?: RouterLayerOptions;
}
export type RouteLayerResult =
| { type: 'close'; route: Route }
| { type: 'push'; route: Route }
| { type: 'success'; route: Route; data?: any };
/**
* Router options for creating layer instances
* Excludes handler functions and layer fields which are handled internally by createLayer
*/
export type RouterLayerOptions = Omit<
RouterOptions,
'handleBackBoundary' | 'handleLayerClose' | 'layer'
>;
// ============================================================================
// Router MicroApp types
// ============================================================================
export interface RouterMicroAppOptions {
mount: (el: HTMLElement) => void;
unmount: () => void;
renderToString?: () => Awaitable<string>;
}
export type RouterMicroAppCallback = (router: Router) => RouterMicroAppOptions;
export type RouterMicroApp =
| Record<string, RouterMicroAppCallback | undefined>
| RouterMicroAppCallback;
// ============================================================================
// Router core types
// ============================================================================
export interface RouterOptions {
/**
* Application mounting container
* - Can be a DOM selector string (e.g., '#app', '.container', '[data-mount]')
* - Can be an HTMLElement object
* - Defaults to '#root'
*
* @example
* ```typescript
* // Using ID selector
* new Router({ root: '#my-app' })
*
* // Using class selector
* new Router({ root: '.app-container' })
*
* // Using attribute selector
* new Router({ root: '[data-router-mount]' })
*
* // Passing DOM element directly
* const element = document.getElementById('app');
* new Router({ root: element })
* ```
*/
root?: string | HTMLElement;
context?: Record<string | symbol, unknown>;
data?: Record<string | symbol, unknown>;
routes?: RouteConfig[];
mode?: RouterMode;
/** Optional in browser, but required on server side */
base?: URL;
req?: IncomingMessage | null;
res?: ServerResponse | null;
apps?: RouterMicroApp;
normalizeURL?: (to: URL, from: URL | null) => URL;
fallback?: RouteHandleHook;
nextTick?: () => Awaitable<void>;
rootStyle?: Partial<CSSStyleDeclaration> | false | null;
layer?: boolean;
zIndex?: number;
handleBackBoundary?: (router: Router) => void;
handleLayerClose?: (router: Router, data?: any) => void;
}
export interface RouterParsedOptions extends Readonly<Required<RouterOptions>> {
readonly compiledRoutes: readonly RouteParsedConfig[];
readonly matcher: RouteMatcher;
}
// ============================================================================
// RouterLink types
// ============================================================================
/**
* Router link navigation types
*/
export type RouterLinkType =
| 'push'
| 'replace'
| 'pushWindow'
| 'replaceWindow'
| 'pushLayer';
/**
* Router link attributes generated by the source code
*/
export interface RouterLinkAttributes {
// Always generated
href: string;
class: string;
// Conditionally generated
target?: '_blank';
rel?: string;
}
/**
* Framework-agnostic link configuration interface
*/
export interface RouterLinkProps {
to: RouteLocationInput;
type?: RouterLinkType;
/**
* @deprecated Use type='replace' instead
*/
replace?: boolean;
exact?: RouteMatchType;
activeClass?: string;
event?: string | string[];
tag?: string;
layerOptions?: RouteLayerOptions;
/**
* Hook function called before navigation occurs
* @param event - The DOM event that triggered the navigation
* @param eventName - The name of the event that triggered navigation
*
* Can prevent default event to block the default navigation handling logic.
* Call event.preventDefault() to stop the navigation from proceeding.
*/
beforeNavigate?: (event: Event, eventName: string) => void;
}
/**
* Framework-agnostic link resolution result
*/
export interface RouterLinkResolved {
// Basic information
route: Route;
type: RouterLinkType;
isActive: boolean;
isExactActive: boolean;
isExternal: boolean;
tag: string;
// Element attributes
attributes: RouterLinkAttributes;
// Navigation function
navigate: (e: Event) => Promise<void>;
// Event handling
createEventHandlers: (
format?: (eventType: string) => string
) => Record<string, (e: Event) => Promise<void>>;
}
|