@real-router/types 0.21.0 → 0.23.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/dist/cjs/index.d.ts +5 -2
  2. package/dist/esm/index.d.mts +5 -2
  3. package/package.json +1 -1
  4. package/src/api.ts +2 -0
  5. package/src/constants.ts +5 -2
  6. package/src/router.ts +2 -0
package/dist/cjs/index.d.ts CHANGED
@@ -494,6 +494,7 @@ interface Router<D extends DefaultDependencies = DefaultDependencies> {
494
494
  subscribe: (listener: SubscribeFn) => Unsubscribe;
495
495
  navigate: (routeName: string, routeParams?: Params, options?: NavigationOptions) => Promise<State>;
496
496
  navigateToDefault: (options?: NavigationOptions) => Promise<State>;
497
+ navigateToNotFound: (path?: string) => State;
497
498
  }
498
499
  /**
499
500
  * Factory function for creating plugins.
@@ -576,11 +577,11 @@ type EventsKeys = "ROUTER_START" | "ROUTER_STOP" | "TRANSITION_START" | "TRANSIT
576
577
  /**
577
578
  * Error code values
578
579
  */
579
- type ErrorCodeValues = "NOT_STARTED" | "NO_START_PATH_OR_STATE" | "ALREADY_STARTED" | "ROUTE_NOT_FOUND" | "SAME_STATES" | "CANNOT_DEACTIVATE" | "CANNOT_ACTIVATE" | "TRANSITION_ERR" | "CANCELLED" | "DISPOSED";
580
+ type ErrorCodeValues = "NOT_STARTED" | "NO_START_PATH_OR_STATE" | "ALREADY_STARTED" | "ROUTE_NOT_FOUND" | "SAME_STATES" | "CANNOT_DEACTIVATE" | "CANNOT_ACTIVATE" | "TRANSITION_ERR" | "CANCELLED" | "DISPOSED" | "PLUGIN_CONFLICT";
580
581
  /**
581
582
  * Error code keys
582
583
  */
583
- type ErrorCodeKeys = "ROUTER_NOT_STARTED" | "NO_START_PATH_OR_STATE" | "ROUTER_ALREADY_STARTED" | "ROUTE_NOT_FOUND" | "SAME_STATES" | "CANNOT_DEACTIVATE" | "CANNOT_ACTIVATE" | "TRANSITION_ERR" | "TRANSITION_CANCELLED" | "ROUTER_DISPOSED";
584
+ type ErrorCodeKeys = "ROUTER_NOT_STARTED" | "NO_START_PATH_OR_STATE" | "ROUTER_ALREADY_STARTED" | "ROUTE_NOT_FOUND" | "SAME_STATES" | "CANNOT_DEACTIVATE" | "CANNOT_ACTIVATE" | "TRANSITION_ERR" | "TRANSITION_CANCELLED" | "ROUTER_DISPOSED" | "PLUGIN_CONFLICT";
584
585
  /**
585
586
  * Mapping of event keys to plugin methods
586
587
  */
@@ -624,6 +625,7 @@ interface ErrorCodeToValueMap {
624
625
  TRANSITION_ERR: "TRANSITION_ERR";
625
626
  TRANSITION_CANCELLED: "CANCELLED";
626
627
  ROUTER_DISPOSED: "DISPOSED";
628
+ PLUGIN_CONFLICT: "PLUGIN_CONFLICT";
627
629
  }
628
630
 
629
631
  /**
@@ -665,6 +667,7 @@ interface PluginApi {
665
667
  getOptions: () => Options;
666
668
  getTree: () => unknown;
667
669
  addInterceptor: <M extends keyof InterceptableMethodMap>(method: M, fn: InterceptorFn<M>) => Unsubscribe;
670
+ extendRouter: (extensions: Record<string, unknown>) => Unsubscribe;
668
671
  }
669
672
  /**
670
673
  * Routes API — for dynamic route mutation.
package/dist/esm/index.d.mts CHANGED
@@ -494,6 +494,7 @@ interface Router<D extends DefaultDependencies = DefaultDependencies> {
494
494
  subscribe: (listener: SubscribeFn) => Unsubscribe;
495
495
  navigate: (routeName: string, routeParams?: Params, options?: NavigationOptions) => Promise<State>;
496
496
  navigateToDefault: (options?: NavigationOptions) => Promise<State>;
497
+ navigateToNotFound: (path?: string) => State;
497
498
  }
498
499
  /**
499
500
  * Factory function for creating plugins.
@@ -576,11 +577,11 @@ type EventsKeys = "ROUTER_START" | "ROUTER_STOP" | "TRANSITION_START" | "TRANSIT
576
577
  /**
577
578
  * Error code values
578
579
  */
579
- type ErrorCodeValues = "NOT_STARTED" | "NO_START_PATH_OR_STATE" | "ALREADY_STARTED" | "ROUTE_NOT_FOUND" | "SAME_STATES" | "CANNOT_DEACTIVATE" | "CANNOT_ACTIVATE" | "TRANSITION_ERR" | "CANCELLED" | "DISPOSED";
580
+ type ErrorCodeValues = "NOT_STARTED" | "NO_START_PATH_OR_STATE" | "ALREADY_STARTED" | "ROUTE_NOT_FOUND" | "SAME_STATES" | "CANNOT_DEACTIVATE" | "CANNOT_ACTIVATE" | "TRANSITION_ERR" | "CANCELLED" | "DISPOSED" | "PLUGIN_CONFLICT";
580
581
  /**
581
582
  * Error code keys
582
583
  */
583
- type ErrorCodeKeys = "ROUTER_NOT_STARTED" | "NO_START_PATH_OR_STATE" | "ROUTER_ALREADY_STARTED" | "ROUTE_NOT_FOUND" | "SAME_STATES" | "CANNOT_DEACTIVATE" | "CANNOT_ACTIVATE" | "TRANSITION_ERR" | "TRANSITION_CANCELLED" | "ROUTER_DISPOSED";
584
+ type ErrorCodeKeys = "ROUTER_NOT_STARTED" | "NO_START_PATH_OR_STATE" | "ROUTER_ALREADY_STARTED" | "ROUTE_NOT_FOUND" | "SAME_STATES" | "CANNOT_DEACTIVATE" | "CANNOT_ACTIVATE" | "TRANSITION_ERR" | "TRANSITION_CANCELLED" | "ROUTER_DISPOSED" | "PLUGIN_CONFLICT";
584
585
  /**
585
586
  * Mapping of event keys to plugin methods
586
587
  */
@@ -624,6 +625,7 @@ interface ErrorCodeToValueMap {
624
625
  TRANSITION_ERR: "TRANSITION_ERR";
625
626
  TRANSITION_CANCELLED: "CANCELLED";
626
627
  ROUTER_DISPOSED: "DISPOSED";
628
+ PLUGIN_CONFLICT: "PLUGIN_CONFLICT";
627
629
  }
628
630
 
629
631
  /**
@@ -665,6 +667,7 @@ interface PluginApi {
665
667
  getOptions: () => Options;
666
668
  getTree: () => unknown;
667
669
  addInterceptor: <M extends keyof InterceptableMethodMap>(method: M, fn: InterceptorFn<M>) => Unsubscribe;
670
+ extendRouter: (extensions: Record<string, unknown>) => Unsubscribe;
668
671
  }
669
672
  /**
670
673
  * Routes API — for dynamic route mutation.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@real-router/types",
3
- "version": "0.21.0",
3
+ "version": "0.23.0",
4
4
  "type": "commonjs",
5
5
  "description": "Shared TypeScript types for Real Router ecosystem",
6
6
  "types": "./dist/esm/index.d.mts",
package/src/api.ts CHANGED
@@ -91,6 +91,8 @@ export interface PluginApi {
91
91
  method: M,
92
92
  fn: InterceptorFn<M>,
93
93
  ) => Unsubscribe;
94
+
95
+ extendRouter: (extensions: Record<string, unknown>) => Unsubscribe;
94
96
  }
95
97
 
96
98
  /**
package/src/constants.ts CHANGED
@@ -46,7 +46,8 @@ export type ErrorCodeValues =
46
46
  | "CANNOT_ACTIVATE"
47
47
  | "TRANSITION_ERR"
48
48
  | "CANCELLED"
49
- | "DISPOSED";
49
+ | "DISPOSED"
50
+ | "PLUGIN_CONFLICT";
50
51
 
51
52
  /**
52
53
  * Error code keys
@@ -61,7 +62,8 @@ export type ErrorCodeKeys =
61
62
  | "CANNOT_ACTIVATE"
62
63
  | "TRANSITION_ERR"
63
64
  | "TRANSITION_CANCELLED"
64
- | "ROUTER_DISPOSED";
65
+ | "ROUTER_DISPOSED"
66
+ | "PLUGIN_CONFLICT";
65
67
 
66
68
  /**
67
69
  * Mapping of event keys to plugin methods
@@ -109,4 +111,5 @@ export interface ErrorCodeToValueMap {
109
111
  TRANSITION_ERR: "TRANSITION_ERR";
110
112
  TRANSITION_CANCELLED: "CANCELLED";
111
113
  ROUTER_DISPOSED: "DISPOSED";
114
+ PLUGIN_CONFLICT: "PLUGIN_CONFLICT";
112
115
  }
package/src/router.ts CHANGED
@@ -290,6 +290,8 @@ export interface Router<D extends DefaultDependencies = DefaultDependencies> {
290
290
  ) => Promise<State>;
291
291
 
292
292
  navigateToDefault: (options?: NavigationOptions) => Promise<State>;
293
+
294
+ navigateToNotFound: (path?: string) => State;
293
295
  }
294
296
 
295
297
  // =============================================================================