@real-router/types 0.13.0 → 0.14.0

package/dist/cjs/index.d.ts

@@ -433,6 +433,7 @@ interface Options {
     noValidate?: boolean;
 }
 type ActivationFn = (toState: State, fromState: State | undefined) => boolean | Promise<boolean | State | void> | State | void;
+type GuardFn = (toState: State, fromState: State | undefined) => boolean | Promise<boolean>;
 type DefaultDependencies = object;
 interface Config {
     decoders: Record<string, (params: Params) => Params>;
@@ -486,9 +487,9 @@ interface Navigator {
  * Defines the contract for router implementations. The actual Router class in
  * @real-router/core implements this interface with full functionality.
  *
- * This interface uses `ActivationFn | boolean` for guard types to avoid circular
+ * This interface uses `GuardFn | boolean` for guard types to avoid circular
  * dependencies. The concrete Router class in @real-router/core narrows this to
- * `ActivationFnFactory | boolean` for more precise type checking.
+ * `GuardFnFactory | boolean` for more precise type checking.
  */
 interface Router {
     /**
@@ -498,7 +499,7 @@ interface Router {
      * @param guard - Guard function or boolean
      * @returns this for method chaining
      */
-    addActivateGuard: (name: string, guard: ActivationFn | boolean) => this;
+    addActivateGuard: (name: string, guard: GuardFn | boolean) => this;
     /**
      * Register a deactivation guard for a route.
      *
@@ -506,7 +507,7 @@ interface Router {
      * @param guard - Guard function or boolean
      * @returns this for method chaining
      */
-    addDeactivateGuard: (name: string, guard: ActivationFn | boolean) => this;
+    addDeactivateGuard: (name: string, guard: GuardFn | boolean) => this;
     /**
      * Remove an activation guard from a route.
      *
@@ -599,4 +600,4 @@ interface ErrorCodeToValueMap {
     ROUTER_DISPOSED: "DISPOSED";
 }
 
-export type { ActivationFn, Config, DefaultDependencies, DefaultParamsCallback, DefaultRouteCallback, ErrorCodeKeys, ErrorCodeToValueMap, ErrorCodeValues, EventName, EventToNameMap, EventToPluginMap, EventsKeys, ForwardToCallback, LimitsConfig, Listener, Middleware, NavigationOptions, Navigator, Options, Params, Plugin, PluginMethod, QueryParamsMode, QueryParamsOptions, RouteParams, RouteTreeState, Router, RouterError, SimpleState, State, StateMeta, StateMetaInput, SubscribeFn, SubscribeState, Subscription, TransitionMeta, TransitionPhase, TransitionReason, Unsubscribe };
+export type { ActivationFn, Config, DefaultDependencies, DefaultParamsCallback, DefaultRouteCallback, ErrorCodeKeys, ErrorCodeToValueMap, ErrorCodeValues, EventName, EventToNameMap, EventToPluginMap, EventsKeys, ForwardToCallback, GuardFn, LimitsConfig, Listener, Middleware, NavigationOptions, Navigator, Options, Params, Plugin, PluginMethod, QueryParamsMode, QueryParamsOptions, RouteParams, RouteTreeState, Router, RouterError, SimpleState, State, StateMeta, StateMetaInput, SubscribeFn, SubscribeState, Subscription, TransitionMeta, TransitionPhase, TransitionReason, 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":1298,"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":1309,"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

@@ -433,6 +433,7 @@ interface Options {
     noValidate?: boolean;
 }
 type ActivationFn = (toState: State, fromState: State | undefined) => boolean | Promise<boolean | State | void> | State | void;
+type GuardFn = (toState: State, fromState: State | undefined) => boolean | Promise<boolean>;
 type DefaultDependencies = object;
 interface Config {
     decoders: Record<string, (params: Params) => Params>;
@@ -486,9 +487,9 @@ interface Navigator {
  * Defines the contract for router implementations. The actual Router class in
  * @real-router/core implements this interface with full functionality.
  *
- * This interface uses `ActivationFn | boolean` for guard types to avoid circular
+ * This interface uses `GuardFn | boolean` for guard types to avoid circular
  * dependencies. The concrete Router class in @real-router/core narrows this to
- * `ActivationFnFactory | boolean` for more precise type checking.
+ * `GuardFnFactory | boolean` for more precise type checking.
  */
 interface Router {
     /**
@@ -498,7 +499,7 @@ interface Router {
      * @param guard - Guard function or boolean
      * @returns this for method chaining
      */
-    addActivateGuard: (name: string, guard: ActivationFn | boolean) => this;
+    addActivateGuard: (name: string, guard: GuardFn | boolean) => this;
     /**
      * Register a deactivation guard for a route.
      *
@@ -506,7 +507,7 @@ interface Router {
      * @param guard - Guard function or boolean
      * @returns this for method chaining
      */
-    addDeactivateGuard: (name: string, guard: ActivationFn | boolean) => this;
+    addDeactivateGuard: (name: string, guard: GuardFn | boolean) => this;
     /**
      * Remove an activation guard from a route.
      *
@@ -599,4 +600,4 @@ interface ErrorCodeToValueMap {
     ROUTER_DISPOSED: "DISPOSED";
 }
 
-export type { ActivationFn, Config, DefaultDependencies, DefaultParamsCallback, DefaultRouteCallback, ErrorCodeKeys, ErrorCodeToValueMap, ErrorCodeValues, EventName, EventToNameMap, EventToPluginMap, EventsKeys, ForwardToCallback, LimitsConfig, Listener, Middleware, NavigationOptions, Navigator, Options, Params, Plugin, PluginMethod, QueryParamsMode, QueryParamsOptions, RouteParams, RouteTreeState, Router, RouterError, SimpleState, State, StateMeta, StateMetaInput, SubscribeFn, SubscribeState, Subscription, TransitionMeta, TransitionPhase, TransitionReason, Unsubscribe };
+export type { ActivationFn, Config, DefaultDependencies, DefaultParamsCallback, DefaultRouteCallback, ErrorCodeKeys, ErrorCodeToValueMap, ErrorCodeValues, EventName, EventToNameMap, EventToPluginMap, EventsKeys, ForwardToCallback, GuardFn, LimitsConfig, Listener, Middleware, NavigationOptions, Navigator, Options, Params, Plugin, PluginMethod, QueryParamsMode, QueryParamsOptions, RouteParams, RouteTreeState, Router, RouterError, SimpleState, State, StateMeta, StateMetaInput, SubscribeFn, SubscribeState, Subscription, TransitionMeta, TransitionPhase, TransitionReason, Unsubscribe };

package/dist/esm/metafile-esm.json

@@ -1 +1 @@
-{"inputs":{"src/index.ts":{"bytes":1298,"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":1309,"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.13.0",
+  "version": "0.14.0",
   "type": "commonjs",
   "description": "Shared TypeScript types for Real Router ecosystem",
   "types": "./dist/esm/index.d.mts",

package/src/index.ts

@@ -32,6 +32,7 @@ export type {
   ForwardToCallback,
   DefaultParamsCallback,
   ActivationFn,
+  GuardFn,
   DefaultDependencies,
   Config,
   Plugin,

package/src/router.ts

@@ -161,6 +161,11 @@ export type ActivationFn = (
   // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
 ) => boolean | Promise<boolean | State | void> | State | void;
 
+export type GuardFn = (
+  toState: State,
+  fromState: State | undefined,
+) => boolean | Promise<boolean>;
+
 export type DefaultDependencies = object;
 
 export interface Config {
@@ -241,9 +246,9 @@ export interface Navigator {
  * Defines the contract for router implementations. The actual Router class in
  * @real-router/core implements this interface with full functionality.
  *
- * This interface uses `ActivationFn | boolean` for guard types to avoid circular
+ * This interface uses `GuardFn | boolean` for guard types to avoid circular
  * dependencies. The concrete Router class in @real-router/core narrows this to
- * `ActivationFnFactory | boolean` for more precise type checking.
+ * `GuardFnFactory | boolean` for more precise type checking.
  */
 export interface Router {
   /**
@@ -253,7 +258,7 @@ export interface Router {
    * @param guard - Guard function or boolean
    * @returns this for method chaining
    */
-  addActivateGuard: (name: string, guard: ActivationFn | boolean) => this;
+  addActivateGuard: (name: string, guard: GuardFn | boolean) => this;
 
   /**
    * Register a deactivation guard for a route.
@@ -262,7 +267,7 @@ export interface Router {
    * @param guard - Guard function or boolean
    * @returns this for method chaining
    */
-  addDeactivateGuard: (name: string, guard: ActivationFn | boolean) => this;
+  addDeactivateGuard: (name: string, guard: GuardFn | boolean) => this;
 
   /**
    * Remove an activation guard from a route.