@real-router/core 0.35.1 → 0.36.0

package/dist/cjs/index.d-DDimDpYc.d.ts

@@ -0,0 +1,165 @@
+import { DefaultDependencies, Router as Router$1, Route, Options, Params, State, PluginFactory, Unsubscribe, SubscribeFn, NavigationOptions } from '@real-router/types';
+
+/**
+ * Router class with integrated namespace architecture.
+ *
+ * All functionality is provided by namespace classes:
+ * - OptionsNamespace: getOptions (immutable)
+ * - DependenciesStore: get/set/remove dependencies
+ * - EventEmitter: subscribe
+ * - StateNamespace: state storage (getState, setState, getPreviousState)
+ * - RoutesNamespace: route tree operations
+ * - RouteLifecycleNamespace: canActivate/canDeactivate guards
+ * - PluginsNamespace: plugin lifecycle
+ * - NavigationNamespace: navigate
+ * - RouterLifecycleNamespace: start, stop, isStarted
+ *
+ * @internal This class implementation is internal. Use createRouter() instead.
+ */
+declare class Router<Dependencies extends DefaultDependencies = DefaultDependencies> implements Router$1<Dependencies> {
+    #private;
+    [key: string]: unknown;
+    /**
+     * @param routes - Route definitions
+     * @param options - Router options
+     * @param dependencies - DI dependencies
+     */
+    constructor(routes?: Route<Dependencies>[], options?: Partial<Options>, dependencies?: Dependencies);
+    isActiveRoute(name: string, params?: Params, strictEquality?: boolean, ignoreQueryParams?: boolean): boolean;
+    buildPath(route: string, params?: Params): string;
+    getState<P extends Params = Params, MP extends Params = Params>(): State<P, MP> | undefined;
+    getPreviousState(): State | undefined;
+    areStatesEqual(state1: State | undefined, state2: State | undefined, ignoreQueryParams?: boolean): boolean;
+    shouldUpdateNode(nodeName: string): (toState: State, fromState?: State) => boolean;
+    isActive(): boolean;
+    start(startPath: string): Promise<State>;
+    stop(): this;
+    dispose(): void;
+    canNavigateTo(name: string, params?: Params): boolean;
+    usePlugin(...plugins: PluginFactory<Dependencies>[]): Unsubscribe;
+    subscribe(listener: SubscribeFn): Unsubscribe;
+    navigate(routeName: string, routeParams?: Params, options?: NavigationOptions): Promise<State>;
+    navigateToDefault(options?: NavigationOptions): Promise<State>;
+    navigateToNotFound(path?: string): State;
+}
+
+/**
+ * Path Matcher Type Definitions.
+ *
+ * Core types for path matching and parameter extraction.
+ *
+ * @module path-matcher/types
+ */
+/**
+ * Constraint pattern for a URL parameter.
+ */
+interface ConstraintPattern {
+    /**
+     * Compiled RegExp for validating the parameter value.
+     *
+     * @example /^(\d+)$/ for constraint "<\\d+>"
+     */
+    readonly pattern: RegExp;
+    /**
+     * Raw constraint string from the route pattern.
+     *
+     * @example "<\\d+>"
+     */
+    readonly constraint: string;
+}
+/**
+ * Parameter metadata extracted from a route path pattern.
+ */
+interface ParamMeta {
+    /**
+     * URL parameter names extracted from the path pattern.
+     *
+     * @example [":id", ":postId"] from "/users/:id/posts/:postId"
+     */
+    readonly urlParams: readonly string[];
+    /**
+     * Query parameter names extracted from the path pattern.
+     *
+     * @example ["q", "page"] from "/search?q&page"
+     */
+    readonly queryParams: readonly string[];
+    /**
+     * Splat parameter names extracted from the path pattern.
+     *
+     * @example ["path"] from "/files/*path"
+     */
+    readonly spatParams: readonly string[];
+    /**
+     * Map of parameter names to their type (url or query).
+     *
+     * @example { id: "url", q: "query" }
+     */
+    readonly paramTypeMap: Readonly<Record<string, "url" | "query">>;
+    /**
+     * Map of parameter names to their constraint patterns.
+     *
+     * Only includes parameters with explicit constraints (e.g., `:id<\\d+>`).
+     * Parameters without constraints are not included in this map.
+     *
+     * @example
+     * ```typescript
+     * buildParamMeta("/users/:id<\\d+>").constraintPatterns.get("id")
+     * // → { pattern: /^(\d+)$/, constraint: "<\\d+>" }
+     *
+     * buildParamMeta("/users/:id").constraintPatterns.size
+     * // → 0 (no constraints)
+     * ```
+     */
+    readonly constraintPatterns: ReadonlyMap<string, ConstraintPattern>;
+    /**
+     * Path pattern without query string, pre-computed for buildPath.
+     *
+     * @example "/users/:id" from "/users/:id?q&page"
+     */
+    readonly pathPattern: string;
+}
+
+/**
+ * Immutable route tree node.
+ *
+ * This is the core data structure of the new route-tree architecture.
+ * It contains only data (no methods) and is created by the builder.
+ *
+ * All caches are pre-computed at build time:
+ * - nonAbsoluteChildren: filtered children without absolute paths
+ * - absoluteDescendants: all descendants with absolute paths (recursive)
+ * - parentSegments: array from root to parent
+ * - fullName: pre-computed "users.profile" instead of runtime join
+ */
+interface RouteTree {
+    /** Route segment name (e.g., "users" in "users.profile") */
+    readonly name: string;
+    /** Route path pattern (e.g., "/users/:id") */
+    readonly path: string;
+    /** Whether this route uses absolute path matching (path starts with "~") */
+    readonly absolute: boolean;
+    /** Child route nodes (Map for O(1) lookup by name) */
+    readonly children: ReadonlyMap<string, RouteTree>;
+    /** Parameter metadata extracted from path pattern (replaces parser dependency) */
+    readonly paramMeta: ParamMeta;
+    /** Parent node (null for root) */
+    readonly parent: RouteTree | null;
+    /** Children without absolute paths (for regular matching) */
+    readonly nonAbsoluteChildren: readonly RouteTree[];
+    /** Pre-computed full name (e.g., "users.profile") */
+    readonly fullName: string;
+    /**
+     * Pre-computed static path for routes without parameters.
+     * Used by buildPath fast path to avoid inject() overhead.
+     * Only set when route has no URL params, query params, or splat params.
+     */
+    readonly staticPath: string | null;
+    /**
+     * Pre-computed parameter type map for this segment.
+     * Cached to avoid recomputing on every navigation.
+     * Maps param name → "url" | "query".
+     */
+    readonly paramTypeMap: Readonly<Record<string, "url" | "query">>;
+}
+
+export { Router as R, type RouteTree as a };

package/dist/cjs/index.d.ts

@@ -1,5 +1,7 @@
-import { Params, RouteTreeState, DefaultDependencies, Router as Router$1, Route, Options, State, PluginFactory, Unsubscribe, SubscribeFn, NavigationOptions, ErrorCodeKeys, ErrorCodeValues, ErrorCodeToValueMap, EventToNameMap, Navigator, PluginApi as PluginApi$1, RoutesApi, DependenciesApi, LifecycleApi } from '@real-router/types';
-export { Config, DefaultDependencies, DependenciesApi, GuardFn, GuardFnFactory, LifecycleApi, Listener, NavigationOptions, Navigator, Options, Params, Plugin, PluginFactory, Route, RouteConfigUpdate, RoutesApi, SimpleState, State, StateMeta, SubscribeFn, SubscribeState, Subscription, Unsubscribe } from '@real-router/types';
+import { Params, RouteTreeState, ErrorCodeKeys, ErrorCodeValues, ErrorCodeToValueMap, EventToNameMap, State, DefaultDependencies, Route, Options, Router as Router$1, Navigator } from '@real-router/types';
+export { Config, DefaultDependencies, GuardFn, GuardFnFactory, Listener, NavigationOptions, Navigator, Options, Params, Plugin, PluginFactory, Route, RouteConfigUpdate, SimpleState, State, StateMeta, SubscribeFn, SubscribeState, Subscription, Unsubscribe } from '@real-router/types';
+import { R as Router } from './index.d-DDimDpYc.js';
+export { a as RouteTree } from './index.d-DDimDpYc.js';
 
 /**
  * Core-internal types + re-exports from @real-router/types.
@@ -21,49 +23,6 @@ interface BuildStateResultWithSegments<P extends Params = Params> {
     readonly segments: readonly unknown[];
 }
 
-/**
- * Router class with integrated namespace architecture.
- *
- * All functionality is provided by namespace classes:
- * - OptionsNamespace: getOptions (immutable)
- * - DependenciesStore: get/set/remove dependencies
- * - EventEmitter: subscribe
- * - StateNamespace: state storage (getState, setState, getPreviousState)
- * - RoutesNamespace: route tree operations
- * - RouteLifecycleNamespace: canActivate/canDeactivate guards
- * - PluginsNamespace: plugin lifecycle
- * - NavigationNamespace: navigate
- * - RouterLifecycleNamespace: start, stop, isStarted
- *
- * @internal This class implementation is internal. Use createRouter() instead.
- */
-declare class Router<Dependencies extends DefaultDependencies = DefaultDependencies> implements Router$1<Dependencies> {
-    #private;
-    [key: string]: unknown;
-    /**
-     * @param routes - Route definitions
-     * @param options - Router options
-     * @param dependencies - DI dependencies
-     */
-    constructor(routes?: Route<Dependencies>[], options?: Partial<Options>, dependencies?: Dependencies);
-    isActiveRoute(name: string, params?: Params, strictEquality?: boolean, ignoreQueryParams?: boolean): boolean;
-    buildPath(route: string, params?: Params): string;
-    getState<P extends Params = Params, MP extends Params = Params>(): State<P, MP> | undefined;
-    getPreviousState(): State | undefined;
-    areStatesEqual(state1: State | undefined, state2: State | undefined, ignoreQueryParams?: boolean): boolean;
-    shouldUpdateNode(nodeName: string): (toState: State, fromState?: State) => boolean;
-    isActive(): boolean;
-    start(startPath: string): Promise<State>;
-    stop(): this;
-    dispose(): void;
-    canNavigateTo(name: string, params?: Params): boolean;
-    usePlugin(...plugins: PluginFactory<Dependencies>[]): Unsubscribe;
-    subscribe(listener: SubscribeFn): Unsubscribe;
-    navigate(routeName: string, routeParams?: Params, options?: NavigationOptions): Promise<State>;
-    navigateToDefault(options?: NavigationOptions): Promise<State>;
-    navigateToNotFound(path?: string): State;
-}
-
 type ConstantsKeys = "UNKNOWN_ROUTE";
 type Constants = Record<ConstantsKeys, string>;
 type ErrorCodes = Record<ErrorCodeKeys, ErrorCodeValues>;
@@ -292,137 +251,4 @@ declare const createRouter: <Dependencies extends DefaultDependencies = DefaultD
 
 declare const getNavigator: <Dependencies extends DefaultDependencies = DefaultDependencies>(router: Router$1<Dependencies>) => Navigator;
 
-/**
- * Path Matcher Type Definitions.
- *
- * Core types for path matching and parameter extraction.
- *
- * @module path-matcher/types
- */
-/**
- * Constraint pattern for a URL parameter.
- */
-interface ConstraintPattern {
-    /**
-     * Compiled RegExp for validating the parameter value.
-     *
-     * @example /^(\d+)$/ for constraint "<\\d+>"
-     */
-    readonly pattern: RegExp;
-    /**
-     * Raw constraint string from the route pattern.
-     *
-     * @example "<\\d+>"
-     */
-    readonly constraint: string;
-}
-/**
- * Parameter metadata extracted from a route path pattern.
- */
-interface ParamMeta {
-    /**
-     * URL parameter names extracted from the path pattern.
-     *
-     * @example [":id", ":postId"] from "/users/:id/posts/:postId"
-     */
-    readonly urlParams: readonly string[];
-    /**
-     * Query parameter names extracted from the path pattern.
-     *
-     * @example ["q", "page"] from "/search?q&page"
-     */
-    readonly queryParams: readonly string[];
-    /**
-     * Splat parameter names extracted from the path pattern.
-     *
-     * @example ["path"] from "/files/*path"
-     */
-    readonly spatParams: readonly string[];
-    /**
-     * Map of parameter names to their type (url or query).
-     *
-     * @example { id: "url", q: "query" }
-     */
-    readonly paramTypeMap: Readonly<Record<string, "url" | "query">>;
-    /**
-     * Map of parameter names to their constraint patterns.
-     *
-     * Only includes parameters with explicit constraints (e.g., `:id<\\d+>`).
-     * Parameters without constraints are not included in this map.
-     *
-     * @example
-     * ```typescript
-     * buildParamMeta("/users/:id<\\d+>").constraintPatterns.get("id")
-     * // → { pattern: /^(\d+)$/, constraint: "<\\d+>" }
-     *
-     * buildParamMeta("/users/:id").constraintPatterns.size
-     * // → 0 (no constraints)
-     * ```
-     */
-    readonly constraintPatterns: ReadonlyMap<string, ConstraintPattern>;
-    /**
-     * Path pattern without query string, pre-computed for buildPath.
-     *
-     * @example "/users/:id" from "/users/:id?q&page"
-     */
-    readonly pathPattern: string;
-}
-
-/**
- * Immutable route tree node.
- *
- * This is the core data structure of the new route-tree architecture.
- * It contains only data (no methods) and is created by the builder.
- *
- * All caches are pre-computed at build time:
- * - nonAbsoluteChildren: filtered children without absolute paths
- * - absoluteDescendants: all descendants with absolute paths (recursive)
- * - parentSegments: array from root to parent
- * - fullName: pre-computed "users.profile" instead of runtime join
- */
-interface RouteTree {
-    /** Route segment name (e.g., "users" in "users.profile") */
-    readonly name: string;
-    /** Route path pattern (e.g., "/users/:id") */
-    readonly path: string;
-    /** Whether this route uses absolute path matching (path starts with "~") */
-    readonly absolute: boolean;
-    /** Child route nodes (Map for O(1) lookup by name) */
-    readonly children: ReadonlyMap<string, RouteTree>;
-    /** Parameter metadata extracted from path pattern (replaces parser dependency) */
-    readonly paramMeta: ParamMeta;
-    /** Parent node (null for root) */
-    readonly parent: RouteTree | null;
-    /** Children without absolute paths (for regular matching) */
-    readonly nonAbsoluteChildren: readonly RouteTree[];
-    /** Pre-computed full name (e.g., "users.profile") */
-    readonly fullName: string;
-    /**
-     * Pre-computed static path for routes without parameters.
-     * Used by buildPath fast path to avoid inject() overhead.
-     * Only set when route has no URL params, query params, or splat params.
-     */
-    readonly staticPath: string | null;
-    /**
-     * Pre-computed parameter type map for this segment.
-     * Cached to avoid recomputing on every navigation.
-     * Maps param name → "url" | "query".
-     */
-    readonly paramTypeMap: Readonly<Record<string, "url" | "query">>;
-}
-
-interface PluginApi extends Omit<PluginApi$1, "getTree"> {
-    getTree: () => RouteTree;
-}
-
-declare function getPluginApi<Dependencies extends DefaultDependencies = DefaultDependencies>(router: Router$1<Dependencies>): PluginApi;
-
-declare function getRoutesApi<Dependencies extends DefaultDependencies = DefaultDependencies>(router: Router$1<Dependencies>): RoutesApi<Dependencies>;
-
-declare function getDependenciesApi<Dependencies extends DefaultDependencies = DefaultDependencies>(router: Router$1<Dependencies>): DependenciesApi<Dependencies>;
-
-declare function getLifecycleApi<Dependencies extends DefaultDependencies = DefaultDependencies>(router: Router$1<Dependencies>): LifecycleApi<Dependencies>;
-
-declare function cloneRouter<Dependencies extends DefaultDependencies = DefaultDependencies>(router: Router$1<Dependencies>, dependencies?: Dependencies): Router<Dependencies>;
-
-export { type BuildStateResultWithSegments, type Constants, type ErrorCodes, type PluginApi, type RouteTree, Router, RouterError, UNKNOWN_ROUTE, cloneRouter, constants, createRouter, errorCodes, events, getDependenciesApi, getLifecycleApi, getNavigator, getPluginApi, getRoutesApi };
+export { type BuildStateResultWithSegments, type Constants, type ErrorCodes, Router, RouterError, UNKNOWN_ROUTE, constants, createRouter, errorCodes, events, getNavigator };