@real-router/types 0.18.0 → 0.19.0

package/dist/cjs/index.d.ts

@@ -47,6 +47,8 @@ interface SimpleState<P extends Params = Params> {
 type TransitionPhase = "deactivating" | "activating";
 type TransitionReason = "success" | "blocked" | "cancelled" | "error";
 interface TransitionMeta {
+    readonly reload?: boolean;
+    readonly redirected?: boolean;
     phase: TransitionPhase;
     from?: string;
     reason: TransitionReason;
@@ -67,7 +69,6 @@ interface State<P extends Params = Params, MP extends Params = Params> {
 interface StateMeta<P extends Params = Params> {
     id: number;
     params: P;
-    options: NavigationOptions;
 }
 /**
  * Input type for makeState meta parameter.
@@ -102,11 +103,9 @@ interface RouterError extends Error {
  * guard enforcement, and state comparison logic.
  *
  * All options are optional and have sensible defaults. Options can be combined to achieve
- * complex navigation behaviors. The options object is stored in state.meta.options and is
- * available to guards and event listeners.
+ * complex navigation behaviors. These options are available to guards and event listeners.
  *
  * @see {@link Router.navigate} for navigation method that accepts these options
- * @see {@link State.meta} for where options are stored after navigation
  */
 interface NavigationOptions {
     /**
@@ -225,19 +224,17 @@ interface NavigationOptions {
      * @internal
      *
      * @description
-     * Automatically set by the router when a navigation is triggered by a redirect from
-     * guards or lifecycle hooks. This flag is used internally to track redirect chains
-     * and is stored in state.meta.options.redirected.
+     * Automatically set by the router when a navigation is triggered by a redirect.
+     * Available on `state.transition` after successful navigation (not during guard execution).
      *
      * @default false (auto-set by router during redirects)
      *
      * @example
-     * // Accessing redirect flag in lifecycle
-     * router.addActivateGuard('dashboard', (toState, fromState) => {
-     *   if (toState.meta?.options?.redirected) {
+     * // Accessing redirect flag in TRANSITION_SUCCESS listener
+     * router.addEventListener('TRANSITION_SUCCESS', (state) => {
+     *   if (state.transition?.redirected) {
      *     console.log('This navigation is from a redirect');
      *   }
-     *   return true;
      * });
      *
      * @see {@link Router.navigate} for redirect handling implementation

package/dist/esm/index.d.mts

@@ -47,6 +47,8 @@ interface SimpleState<P extends Params = Params> {
 type TransitionPhase = "deactivating" | "activating";
 type TransitionReason = "success" | "blocked" | "cancelled" | "error";
 interface TransitionMeta {
+    readonly reload?: boolean;
+    readonly redirected?: boolean;
     phase: TransitionPhase;
     from?: string;
     reason: TransitionReason;
@@ -67,7 +69,6 @@ interface State<P extends Params = Params, MP extends Params = Params> {
 interface StateMeta<P extends Params = Params> {
     id: number;
     params: P;
-    options: NavigationOptions;
 }
 /**
  * Input type for makeState meta parameter.
@@ -102,11 +103,9 @@ interface RouterError extends Error {
  * guard enforcement, and state comparison logic.
  *
  * All options are optional and have sensible defaults. Options can be combined to achieve
- * complex navigation behaviors. The options object is stored in state.meta.options and is
- * available to guards and event listeners.
+ * complex navigation behaviors. These options are available to guards and event listeners.
  *
  * @see {@link Router.navigate} for navigation method that accepts these options
- * @see {@link State.meta} for where options are stored after navigation
  */
 interface NavigationOptions {
     /**
@@ -225,19 +224,17 @@ interface NavigationOptions {
      * @internal
      *
      * @description
-     * Automatically set by the router when a navigation is triggered by a redirect from
-     * guards or lifecycle hooks. This flag is used internally to track redirect chains
-     * and is stored in state.meta.options.redirected.
+     * Automatically set by the router when a navigation is triggered by a redirect.
+     * Available on `state.transition` after successful navigation (not during guard execution).
      *
      * @default false (auto-set by router during redirects)
      *
      * @example
-     * // Accessing redirect flag in lifecycle
-     * router.addActivateGuard('dashboard', (toState, fromState) => {
-     *   if (toState.meta?.options?.redirected) {
+     * // Accessing redirect flag in TRANSITION_SUCCESS listener
+     * router.addEventListener('TRANSITION_SUCCESS', (state) => {
+     *   if (state.transition?.redirected) {
      *     console.log('This navigation is from a redirect');
      *   }
-     *   return true;
      * });
      *
      * @see {@link Router.navigate} for redirect handling implementation

package/package.json

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

package/src/base.ts

@@ -16,6 +16,8 @@ export type TransitionPhase = "deactivating" | "activating";
 export type TransitionReason = "success" | "blocked" | "cancelled" | "error";
 
 export interface TransitionMeta {
+  readonly reload?: boolean;
+  readonly redirected?: boolean;
   phase: TransitionPhase;
   from?: string;
   reason: TransitionReason;
@@ -38,7 +40,6 @@ export interface State<P extends Params = Params, MP extends Params = Params> {
 export interface StateMeta<P extends Params = Params> {
   id: number;
   params: P;
-  options: NavigationOptions;
 }
 
 /**
@@ -79,11 +80,9 @@ export interface RouterError extends Error {
  * guard enforcement, and state comparison logic.
  *
  * All options are optional and have sensible defaults. Options can be combined to achieve
- * complex navigation behaviors. The options object is stored in state.meta.options and is
- * available to guards and event listeners.
+ * complex navigation behaviors. These options are available to guards and event listeners.
  *
  * @see {@link Router.navigate} for navigation method that accepts these options
- * @see {@link State.meta} for where options are stored after navigation
  */
 export interface NavigationOptions {
   /**
@@ -206,19 +205,17 @@ export interface NavigationOptions {
    * @internal
    *
    * @description
-   * Automatically set by the router when a navigation is triggered by a redirect from
-   * guards or lifecycle hooks. This flag is used internally to track redirect chains
-   * and is stored in state.meta.options.redirected.
+   * Automatically set by the router when a navigation is triggered by a redirect.
+   * Available on `state.transition` after successful navigation (not during guard execution).
    *
    * @default false (auto-set by router during redirects)
    *
    * @example
-   * // Accessing redirect flag in lifecycle
-   * router.addActivateGuard('dashboard', (toState, fromState) => {
-   *   if (toState.meta?.options?.redirected) {
+   * // Accessing redirect flag in TRANSITION_SUCCESS listener
+   * router.addEventListener('TRANSITION_SUCCESS', (state) => {
+   *   if (state.transition?.redirected) {
    *     console.log('This navigation is from a redirect');
    *   }
-   *   return true;
    * });
    *
    * @see {@link Router.navigate} for redirect handling implementation