@real-router/types 0.4.0 → 0.6.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.
  *
@@ -310,6 +359,16 @@ interface LoggerConfig {
     callback?: LogCallback | undefined;
     callbackIgnoresLevel?: boolean;
 }
+/**
+ * Callback function for dynamically resolving the default route.
+ * Receives a dependency getter function to access router dependencies.
+ */
+type DefaultRouteCallback<Dependencies = object> = (getDependency: <K extends keyof Dependencies>(name: K) => Dependencies[K]) => string;
+/**
+ * Callback function for dynamically resolving the default parameters.
+ * Receives a dependency getter function to access router dependencies.
+ */
+type DefaultParamsCallback<Dependencies = object> = (getDependency: <K extends keyof Dependencies>(name: K) => Dependencies[K]) => Params;
 /**
  * Router configuration options.
  *
@@ -323,13 +382,13 @@ interface Options {
      *
      * @default ""
      */
-    defaultRoute: string;
+    defaultRoute: string | DefaultRouteCallback;
     /**
      * Default parameters for the default route.
      *
      * @default {}
      */
-    defaultParams: Params;
+    defaultParams: Params | DefaultParamsCallback;
     /**
      * How to handle trailing slashes in URLs.
      * - "strict": Route must match exactly
@@ -340,12 +399,6 @@ interface Options {
      * @default "preserve"
      */
     trailingSlash: "strict" | "never" | "always" | "preserve";
-    /**
-     * Whether route names are case-sensitive.
-     *
-     * @default false
-     */
-    caseSensitive: boolean;
     /**
      * How to encode URL parameters.
      * - "default": Standard encoding
@@ -387,6 +440,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.
@@ -500,4 +560,4 @@ interface ErrorCodeToValueMap {
     TRANSITION_CANCELLED: "CANCELLED";
 }
 
-export type { ActivationFn, CancelFn, Config, DefaultDependencies, DoneFn, ErrorCodeKeys, ErrorCodeToValueMap, ErrorCodeValues, EventName, EventToNameMap, EventToPluginMap, EventsKeys, Listener, Middleware, NavigationOptions, Navigator, Options, Params, Plugin, PluginMethod, QueryParamsMode, QueryParamsOptions, RouteTreeState, RouterError, SimpleState, State, StateMeta, StateMetaInput, SubscribeFn, SubscribeState, Subscription, Unsubscribe };
+export type { ActivationFn, CancelFn, Config, DefaultDependencies, DefaultParamsCallback, DefaultRouteCallback, 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":1097,"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":1217,"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.
  *
@@ -310,6 +359,16 @@ interface LoggerConfig {
     callback?: LogCallback | undefined;
     callbackIgnoresLevel?: boolean;
 }
+/**
+ * Callback function for dynamically resolving the default route.
+ * Receives a dependency getter function to access router dependencies.
+ */
+type DefaultRouteCallback<Dependencies = object> = (getDependency: <K extends keyof Dependencies>(name: K) => Dependencies[K]) => string;
+/**
+ * Callback function for dynamically resolving the default parameters.
+ * Receives a dependency getter function to access router dependencies.
+ */
+type DefaultParamsCallback<Dependencies = object> = (getDependency: <K extends keyof Dependencies>(name: K) => Dependencies[K]) => Params;
 /**
  * Router configuration options.
  *
@@ -323,13 +382,13 @@ interface Options {
      *
      * @default ""
      */
-    defaultRoute: string;
+    defaultRoute: string | DefaultRouteCallback;
     /**
      * Default parameters for the default route.
      *
      * @default {}
      */
-    defaultParams: Params;
+    defaultParams: Params | DefaultParamsCallback;
     /**
      * How to handle trailing slashes in URLs.
      * - "strict": Route must match exactly
@@ -340,12 +399,6 @@ interface Options {
      * @default "preserve"
      */
     trailingSlash: "strict" | "never" | "always" | "preserve";
-    /**
-     * Whether route names are case-sensitive.
-     *
-     * @default false
-     */
-    caseSensitive: boolean;
     /**
      * How to encode URL parameters.
      * - "default": Standard encoding
@@ -387,6 +440,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.
@@ -500,4 +560,4 @@ interface ErrorCodeToValueMap {
     TRANSITION_CANCELLED: "CANCELLED";
 }
 
-export type { ActivationFn, CancelFn, Config, DefaultDependencies, DoneFn, ErrorCodeKeys, ErrorCodeToValueMap, ErrorCodeValues, EventName, EventToNameMap, EventToPluginMap, EventsKeys, Listener, Middleware, NavigationOptions, Navigator, Options, Params, Plugin, PluginMethod, QueryParamsMode, QueryParamsOptions, RouteTreeState, RouterError, SimpleState, State, StateMeta, StateMetaInput, SubscribeFn, SubscribeState, Subscription, Unsubscribe };
+export type { ActivationFn, CancelFn, Config, DefaultDependencies, DefaultParamsCallback, DefaultRouteCallback, 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":1097,"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":1217,"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.4.0",
+  "version": "0.6.0",
   "type": "commonjs",
   "description": "Shared TypeScript types for Real Router ecosystem",
   "types": "./dist/esm/index.d.mts",
@@ -38,6 +38,6 @@
   "scripts": {
     "build": "tsup",
     "type-check": "tsc --noEmit",
-    "lint": "eslint --cache --ext .ts src/ --fix"
+    "lint": "eslint --cache --ext .ts src/ --fix --max-warnings 0"
   }
 }