@real-router/types 0.3.0 → 0.5.0

package/dist/cjs/index.d.ts

@@ -294,6 +294,55 @@ interface Params {
     [key: string]: string | string[] | number | number[] | boolean | boolean[] | Params | Params[] | Record<string, string | number | boolean> | null | undefined;
 }
 
+/**
+ * Configuration for router resource limits.
+ * Controls maximum allowed values for various router operations to prevent resource exhaustion.
+ */
+interface LimitsConfig {
+    /**
+     * Maximum number of route dependencies allowed.
+     * Prevents circular dependency chains and excessive dependency graphs.
+     *
+     * @default 100
+     */
+    maxDependencies: number;
+    /**
+     * Maximum number of plugins that can be registered.
+     * Limits plugin stack depth to prevent performance degradation.
+     *
+     * @default 50
+     */
+    maxPlugins: number;
+    /**
+     * Maximum number of middleware functions in the navigation pipeline.
+     * Controls middleware chain length to prevent stack overflow and performance issues.
+     *
+     * @default 50
+     */
+    maxMiddleware: number;
+    /**
+     * Maximum number of event listeners per event type.
+     * Prevents memory leaks from excessive listener registration.
+     *
+     * @default 10000
+     */
+    maxListeners: number;
+    /**
+     * Maximum depth of nested event propagation.
+     * Prevents infinite recursion in event handling chains.
+     *
+     * @default 5
+     */
+    maxEventDepth: number;
+    /**
+     * Maximum number of lifecycle handlers (canActivate/canDeactivate) per route.
+     * Controls guard function stack to prevent excessive validation overhead.
+     *
+     * @default 200
+     */
+    maxLifecycleHandlers: number;
+}
+
 /**
  * Base router types without Router class dependency.
  *
@@ -387,6 +436,13 @@ interface Options {
      * @default undefined
      */
     logger?: Partial<LoggerConfig>;
+    /**
+     * Router resource limits configuration.
+     * Controls maximum allowed values for various router operations.
+     *
+     * @default DEFAULT_LIMITS (from LimitsNamespace)
+     */
+    limits?: Partial<LimitsConfig>;
     /**
      * Disables argument validation in public router methods.
      * Use in production for performance. Keep false in development for early error detection.
@@ -427,6 +483,21 @@ interface Listener {
 interface Subscription {
     unsubscribe: Unsubscribe;
 }
+/**
+ * Navigator interface - a minimal, safe subset of Router methods.
+ *
+ * Provides only the essential navigation and state inspection methods.
+ * Excludes lifecycle methods (start, stop), plugin management, and internal APIs.
+ * Use this when you need to pass a limited router interface to components.
+ *
+ * For full router access, use the Router interface directly or the useRouter() hook.
+ */
+interface Navigator {
+    navigate: (routeName: string, routeParamsOrDone?: Params | DoneFn, optionsOrDone?: NavigationOptions | DoneFn, done?: DoneFn) => CancelFn;
+    getState: () => State | undefined;
+    isActiveRoute: (name: string, params?: Params, strictEquality?: boolean, ignoreQueryParams?: boolean) => boolean;
+    subscribe: (listener: SubscribeFn) => Unsubscribe;
+}
 
 /**
  * Plugin lifecycle method names
@@ -485,4 +556,4 @@ interface ErrorCodeToValueMap {
     TRANSITION_CANCELLED: "CANCELLED";
 }
 
-export type { ActivationFn, CancelFn, Config, DefaultDependencies, DoneFn, ErrorCodeKeys, ErrorCodeToValueMap, ErrorCodeValues, EventName, EventToNameMap, EventToPluginMap, EventsKeys, Listener, Middleware, NavigationOptions, Options, Params, Plugin, PluginMethod, QueryParamsMode, QueryParamsOptions, RouteTreeState, RouterError, SimpleState, State, StateMeta, StateMetaInput, SubscribeFn, SubscribeState, Subscription, Unsubscribe };
+export type { ActivationFn, CancelFn, Config, DefaultDependencies, DoneFn, ErrorCodeKeys, ErrorCodeToValueMap, ErrorCodeValues, EventName, EventToNameMap, EventToPluginMap, EventsKeys, LimitsConfig, Listener, Middleware, NavigationOptions, Navigator, Options, Params, Plugin, PluginMethod, QueryParamsMode, QueryParamsOptions, RouteTreeState, RouterError, SimpleState, State, StateMeta, StateMetaInput, SubscribeFn, SubscribeState, Subscription, Unsubscribe };

package/dist/cjs/metafile-cjs.json

@@ -1 +1 @@
-{"inputs":{"../../node_modules/.pnpm/tsup@8.5.1_jiti@2.6.1_postcss@8.5.6_typescript@5.9.3/node_modules/tsup/assets/cjs_shims.js":{"bytes":569,"imports":[],"format":"esm"},"src/index.ts":{"bytes":1084,"imports":[{"path":"/home/runner/work/real-router/real-router/node_modules/.pnpm/tsup@8.5.1_jiti@2.6.1_postcss@8.5.6_typescript@5.9.3/node_modules/tsup/assets/cjs_shims.js","kind":"import-statement","external":true}],"format":"esm"}},"outputs":{"dist/cjs/index.js":{"imports":[],"exports":[],"entryPoint":"src/index.ts","inputs":{"src/index.ts":{"bytesInOutput":0}},"bytes":0}}}
+{"inputs":{"../../node_modules/.pnpm/tsup@8.5.1_jiti@2.6.1_postcss@8.5.6_typescript@5.9.3/node_modules/tsup/assets/cjs_shims.js":{"bytes":569,"imports":[],"format":"esm"},"src/index.ts":{"bytes":1168,"imports":[{"path":"/home/runner/work/real-router/real-router/node_modules/.pnpm/tsup@8.5.1_jiti@2.6.1_postcss@8.5.6_typescript@5.9.3/node_modules/tsup/assets/cjs_shims.js","kind":"import-statement","external":true}],"format":"esm"}},"outputs":{"dist/cjs/index.js":{"imports":[],"exports":[],"entryPoint":"src/index.ts","inputs":{"src/index.ts":{"bytesInOutput":0}},"bytes":0}}}

package/dist/esm/index.d.mts

@@ -294,6 +294,55 @@ interface Params {
     [key: string]: string | string[] | number | number[] | boolean | boolean[] | Params | Params[] | Record<string, string | number | boolean> | null | undefined;
 }
 
+/**
+ * Configuration for router resource limits.
+ * Controls maximum allowed values for various router operations to prevent resource exhaustion.
+ */
+interface LimitsConfig {
+    /**
+     * Maximum number of route dependencies allowed.
+     * Prevents circular dependency chains and excessive dependency graphs.
+     *
+     * @default 100
+     */
+    maxDependencies: number;
+    /**
+     * Maximum number of plugins that can be registered.
+     * Limits plugin stack depth to prevent performance degradation.
+     *
+     * @default 50
+     */
+    maxPlugins: number;
+    /**
+     * Maximum number of middleware functions in the navigation pipeline.
+     * Controls middleware chain length to prevent stack overflow and performance issues.
+     *
+     * @default 50
+     */
+    maxMiddleware: number;
+    /**
+     * Maximum number of event listeners per event type.
+     * Prevents memory leaks from excessive listener registration.
+     *
+     * @default 10000
+     */
+    maxListeners: number;
+    /**
+     * Maximum depth of nested event propagation.
+     * Prevents infinite recursion in event handling chains.
+     *
+     * @default 5
+     */
+    maxEventDepth: number;
+    /**
+     * Maximum number of lifecycle handlers (canActivate/canDeactivate) per route.
+     * Controls guard function stack to prevent excessive validation overhead.
+     *
+     * @default 200
+     */
+    maxLifecycleHandlers: number;
+}
+
 /**
  * Base router types without Router class dependency.
  *
@@ -387,6 +436,13 @@ interface Options {
      * @default undefined
      */
     logger?: Partial<LoggerConfig>;
+    /**
+     * Router resource limits configuration.
+     * Controls maximum allowed values for various router operations.
+     *
+     * @default DEFAULT_LIMITS (from LimitsNamespace)
+     */
+    limits?: Partial<LimitsConfig>;
     /**
      * Disables argument validation in public router methods.
      * Use in production for performance. Keep false in development for early error detection.
@@ -427,6 +483,21 @@ interface Listener {
 interface Subscription {
     unsubscribe: Unsubscribe;
 }
+/**
+ * Navigator interface - a minimal, safe subset of Router methods.
+ *
+ * Provides only the essential navigation and state inspection methods.
+ * Excludes lifecycle methods (start, stop), plugin management, and internal APIs.
+ * Use this when you need to pass a limited router interface to components.
+ *
+ * For full router access, use the Router interface directly or the useRouter() hook.
+ */
+interface Navigator {
+    navigate: (routeName: string, routeParamsOrDone?: Params | DoneFn, optionsOrDone?: NavigationOptions | DoneFn, done?: DoneFn) => CancelFn;
+    getState: () => State | undefined;
+    isActiveRoute: (name: string, params?: Params, strictEquality?: boolean, ignoreQueryParams?: boolean) => boolean;
+    subscribe: (listener: SubscribeFn) => Unsubscribe;
+}
 
 /**
  * Plugin lifecycle method names
@@ -485,4 +556,4 @@ interface ErrorCodeToValueMap {
     TRANSITION_CANCELLED: "CANCELLED";
 }
 
-export type { ActivationFn, CancelFn, Config, DefaultDependencies, DoneFn, ErrorCodeKeys, ErrorCodeToValueMap, ErrorCodeValues, EventName, EventToNameMap, EventToPluginMap, EventsKeys, Listener, Middleware, NavigationOptions, Options, Params, Plugin, PluginMethod, QueryParamsMode, QueryParamsOptions, RouteTreeState, RouterError, SimpleState, State, StateMeta, StateMetaInput, SubscribeFn, SubscribeState, Subscription, Unsubscribe };
+export type { ActivationFn, CancelFn, Config, DefaultDependencies, DoneFn, ErrorCodeKeys, ErrorCodeToValueMap, ErrorCodeValues, EventName, EventToNameMap, EventToPluginMap, EventsKeys, LimitsConfig, Listener, Middleware, NavigationOptions, Navigator, Options, Params, Plugin, PluginMethod, QueryParamsMode, QueryParamsOptions, RouteTreeState, RouterError, SimpleState, State, StateMeta, StateMetaInput, SubscribeFn, SubscribeState, Subscription, Unsubscribe };

package/dist/esm/metafile-esm.json

@@ -1 +1 @@
-{"inputs":{"src/index.ts":{"bytes":1084,"imports":[],"format":"esm"}},"outputs":{"dist/esm/index.mjs":{"imports":[],"exports":[],"entryPoint":"src/index.ts","inputs":{"src/index.ts":{"bytesInOutput":0}},"bytes":0}}}
+{"inputs":{"src/index.ts":{"bytes":1168,"imports":[],"format":"esm"}},"outputs":{"dist/esm/index.mjs":{"imports":[],"exports":[],"entryPoint":"src/index.ts","inputs":{"src/index.ts":{"bytesInOutput":0}},"bytes":0}}}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@real-router/types",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "type": "commonjs",
   "description": "Shared TypeScript types for Real Router ecosystem",
   "types": "./dist/esm/index.d.mts",