@real-router/types 0.24.0 → 0.27.0

package/dist/cjs/index.d.ts

@@ -59,22 +59,15 @@ interface TransitionMeta {
         intersection: string;
     };
 }
-interface State<P extends Params = Params, MP extends Params = Params> {
+interface State<P extends Params = Params> {
     name: string;
     params: P;
     path: string;
-    meta?: StateMeta<MP> | undefined;
     transition?: TransitionMeta | undefined;
 }
-interface StateMeta<P extends Params = Params> {
-    id: number;
+interface StateMetaInput<P extends Params = Params> {
     params: P;
 }
-/**
- * Input type for makeState meta parameter.
- * Omits `id` since it's auto-generated by makeState.
- */
-type StateMetaInput<P extends Params = Params> = Omit<StateMeta<P>, "id">;
 /**
  * RouterError interface describing the public API of the RouterError class.
  * The actual class implementation is in the real-router package.
@@ -415,13 +408,6 @@ interface Options {
      * @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.
-     *
-     * @default false
-     */
-    noValidate?: boolean;
 }
 type GuardFn = (toState: State, fromState: State | undefined, signal?: AbortSignal) => boolean | Promise<boolean>;
 type DefaultDependencies = object;
@@ -481,7 +467,7 @@ interface Router<D extends DefaultDependencies = DefaultDependencies> {
     [key: string]: unknown;
     isActiveRoute: (name: string, params?: Params, strictEquality?: boolean, ignoreQueryParams?: boolean) => boolean;
     buildPath: (route: string, params?: Params) => string;
-    getState: <P extends Params = Params, MP extends Params = Params>() => State<P, MP> | undefined;
+    getState: <P extends Params = Params>() => State<P> | undefined;
     getPreviousState: () => State | undefined;
     areStatesEqual: (state1: State | undefined, state2: State | undefined, ignoreQueryParams?: boolean) => boolean;
     shouldUpdateNode: (nodeName: string) => (toState: State, fromState?: State) => boolean;
@@ -490,7 +476,7 @@ interface Router<D extends DefaultDependencies = DefaultDependencies> {
     stop: () => this;
     dispose: () => void;
     canNavigateTo: (name: string, params?: Params) => boolean;
-    usePlugin: (...plugins: PluginFactory<D>[]) => Unsubscribe;
+    usePlugin: (...plugins: (PluginFactory<D> | false | null | undefined)[]) => Unsubscribe;
     subscribe: (listener: SubscribeFn) => Unsubscribe;
     navigate: (routeName: string, routeParams?: Params, options?: NavigationOptions) => Promise<State>;
     navigateToDefault: (options?: NavigationOptions) => Promise<State>;
@@ -656,10 +642,10 @@ type InterceptorFn<M extends keyof InterceptableMethodMap> = (next: Interceptabl
  * Hides plugin-internal methods from public autocomplete.
  */
 interface PluginApi {
-    makeState: <P extends Params = Params, MP extends Params = Params>(name: string, params?: P, path?: string, meta?: StateMetaInput<MP>, forceId?: number) => State<P, MP>;
+    makeState: <P extends Params = Params>(name: string, params?: P, path?: string, meta?: StateMetaInput) => State<P>;
     buildState: (routeName: string, routeParams: Params) => RouteTreeState | undefined;
     forwardState: <P extends Params = Params>(routeName: string, routeParams: P) => SimpleState<P>;
-    matchPath: <P extends Params = Params, MP extends Params = Params>(path: string) => State<P, MP> | undefined;
+    matchPath: <P extends Params = Params>(path: string) => State<P> | undefined;
     setRootPath: (rootPath: string) => void;
     getRootPath: () => string;
     addEventListener: <E extends EventName>(eventName: E, cb: Plugin[EventMethodMap[E]]) => Unsubscribe;
@@ -706,4 +692,4 @@ interface LifecycleApi<Dependencies extends DefaultDependencies = DefaultDepende
     removeDeactivateGuard: (name: string) => void;
 }
 
-export type { Config, DefaultDependencies, DefaultParamsCallback, DefaultRouteCallback, DependenciesApi, ErrorCodeKeys, ErrorCodeToValueMap, ErrorCodeValues, EventMethodMap, EventName, EventToNameMap, EventToPluginMap, EventsKeys, ForwardToCallback, GuardFn, GuardFnFactory, InterceptableMethodMap, InterceptorFn, LifecycleApi, LimitsConfig, Listener, NavigationOptions, Navigator, Options, Params, Plugin, PluginApi, PluginFactory, PluginMethod, QueryParamsMode, QueryParamsOptions, Route, RouteConfigUpdate, RouteParams, RouteTreeState, Router, RouterError, RoutesApi, SimpleState, State, StateMeta, StateMetaInput, SubscribeFn, SubscribeState, Subscription, TransitionMeta, TransitionPhase, TransitionReason, Unsubscribe };
+export type { Config, DefaultDependencies, DefaultParamsCallback, DefaultRouteCallback, DependenciesApi, ErrorCodeKeys, ErrorCodeToValueMap, ErrorCodeValues, EventMethodMap, EventName, EventToNameMap, EventToPluginMap, EventsKeys, ForwardToCallback, GuardFn, GuardFnFactory, InterceptableMethodMap, InterceptorFn, LifecycleApi, LimitsConfig, Listener, NavigationOptions, Navigator, Options, Params, Plugin, PluginApi, PluginFactory, PluginMethod, QueryParamsMode, QueryParamsOptions, Route, RouteConfigUpdate, RouteParams, RouteTreeState, Router, RouterError, RoutesApi, SimpleState, State, 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.8_typescript@5.9.3_yaml@2.8.2/node_modules/tsup/assets/cjs_shims.js":{"bytes":569,"imports":[],"format":"esm"},"src/index.ts":{"bytes":1392,"imports":[{"path":"/home/runner/work/real-router/real-router/node_modules/.pnpm/tsup@8.5.1_jiti@2.6.1_postcss@8.5.8_typescript@5.9.3_yaml@2.8.2/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.8_tsx@4.21.0_typescript@6.0.2_yaml@2.8.3/node_modules/tsup/assets/cjs_shims.js":{"bytes":569,"imports":[],"format":"esm"},"src/index.ts":{"bytes":1379,"imports":[{"path":"/home/runner/work/real-router/real-router/node_modules/.pnpm/tsup@8.5.1_jiti@2.6.1_postcss@8.5.8_tsx@4.21.0_typescript@6.0.2_yaml@2.8.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

@@ -59,22 +59,15 @@ interface TransitionMeta {
         intersection: string;
     };
 }
-interface State<P extends Params = Params, MP extends Params = Params> {
+interface State<P extends Params = Params> {
     name: string;
     params: P;
     path: string;
-    meta?: StateMeta<MP> | undefined;
     transition?: TransitionMeta | undefined;
 }
-interface StateMeta<P extends Params = Params> {
-    id: number;
+interface StateMetaInput<P extends Params = Params> {
     params: P;
 }
-/**
- * Input type for makeState meta parameter.
- * Omits `id` since it's auto-generated by makeState.
- */
-type StateMetaInput<P extends Params = Params> = Omit<StateMeta<P>, "id">;
 /**
  * RouterError interface describing the public API of the RouterError class.
  * The actual class implementation is in the real-router package.
@@ -415,13 +408,6 @@ interface Options {
      * @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.
-     *
-     * @default false
-     */
-    noValidate?: boolean;
 }
 type GuardFn = (toState: State, fromState: State | undefined, signal?: AbortSignal) => boolean | Promise<boolean>;
 type DefaultDependencies = object;
@@ -481,7 +467,7 @@ interface Router<D extends DefaultDependencies = DefaultDependencies> {
     [key: string]: unknown;
     isActiveRoute: (name: string, params?: Params, strictEquality?: boolean, ignoreQueryParams?: boolean) => boolean;
     buildPath: (route: string, params?: Params) => string;
-    getState: <P extends Params = Params, MP extends Params = Params>() => State<P, MP> | undefined;
+    getState: <P extends Params = Params>() => State<P> | undefined;
     getPreviousState: () => State | undefined;
     areStatesEqual: (state1: State | undefined, state2: State | undefined, ignoreQueryParams?: boolean) => boolean;
     shouldUpdateNode: (nodeName: string) => (toState: State, fromState?: State) => boolean;
@@ -490,7 +476,7 @@ interface Router<D extends DefaultDependencies = DefaultDependencies> {
     stop: () => this;
     dispose: () => void;
     canNavigateTo: (name: string, params?: Params) => boolean;
-    usePlugin: (...plugins: PluginFactory<D>[]) => Unsubscribe;
+    usePlugin: (...plugins: (PluginFactory<D> | false | null | undefined)[]) => Unsubscribe;
     subscribe: (listener: SubscribeFn) => Unsubscribe;
     navigate: (routeName: string, routeParams?: Params, options?: NavigationOptions) => Promise<State>;
     navigateToDefault: (options?: NavigationOptions) => Promise<State>;
@@ -656,10 +642,10 @@ type InterceptorFn<M extends keyof InterceptableMethodMap> = (next: Interceptabl
  * Hides plugin-internal methods from public autocomplete.
  */
 interface PluginApi {
-    makeState: <P extends Params = Params, MP extends Params = Params>(name: string, params?: P, path?: string, meta?: StateMetaInput<MP>, forceId?: number) => State<P, MP>;
+    makeState: <P extends Params = Params>(name: string, params?: P, path?: string, meta?: StateMetaInput) => State<P>;
     buildState: (routeName: string, routeParams: Params) => RouteTreeState | undefined;
     forwardState: <P extends Params = Params>(routeName: string, routeParams: P) => SimpleState<P>;
-    matchPath: <P extends Params = Params, MP extends Params = Params>(path: string) => State<P, MP> | undefined;
+    matchPath: <P extends Params = Params>(path: string) => State<P> | undefined;
     setRootPath: (rootPath: string) => void;
     getRootPath: () => string;
     addEventListener: <E extends EventName>(eventName: E, cb: Plugin[EventMethodMap[E]]) => Unsubscribe;
@@ -706,4 +692,4 @@ interface LifecycleApi<Dependencies extends DefaultDependencies = DefaultDepende
     removeDeactivateGuard: (name: string) => void;
 }
 
-export type { Config, DefaultDependencies, DefaultParamsCallback, DefaultRouteCallback, DependenciesApi, ErrorCodeKeys, ErrorCodeToValueMap, ErrorCodeValues, EventMethodMap, EventName, EventToNameMap, EventToPluginMap, EventsKeys, ForwardToCallback, GuardFn, GuardFnFactory, InterceptableMethodMap, InterceptorFn, LifecycleApi, LimitsConfig, Listener, NavigationOptions, Navigator, Options, Params, Plugin, PluginApi, PluginFactory, PluginMethod, QueryParamsMode, QueryParamsOptions, Route, RouteConfigUpdate, RouteParams, RouteTreeState, Router, RouterError, RoutesApi, SimpleState, State, StateMeta, StateMetaInput, SubscribeFn, SubscribeState, Subscription, TransitionMeta, TransitionPhase, TransitionReason, Unsubscribe };
+export type { Config, DefaultDependencies, DefaultParamsCallback, DefaultRouteCallback, DependenciesApi, ErrorCodeKeys, ErrorCodeToValueMap, ErrorCodeValues, EventMethodMap, EventName, EventToNameMap, EventToPluginMap, EventsKeys, ForwardToCallback, GuardFn, GuardFnFactory, InterceptableMethodMap, InterceptorFn, LifecycleApi, LimitsConfig, Listener, NavigationOptions, Navigator, Options, Params, Plugin, PluginApi, PluginFactory, PluginMethod, QueryParamsMode, QueryParamsOptions, Route, RouteConfigUpdate, RouteParams, RouteTreeState, Router, RouterError, RoutesApi, SimpleState, State, StateMetaInput, SubscribeFn, SubscribeState, Subscription, TransitionMeta, TransitionPhase, TransitionReason, Unsubscribe };

package/dist/esm/metafile-esm.json

@@ -1 +1 @@
-{"inputs":{"src/index.ts":{"bytes":1392,"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":1379,"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.24.0",
+  "version": "0.27.0",
   "type": "commonjs",
   "description": "Shared TypeScript types for Real Router ecosystem",
   "types": "./dist/esm/index.d.mts",
@@ -40,6 +40,7 @@
   "scripts": {
     "build": "tsup",
     "type-check": "tsc --noEmit",
-    "lint": "eslint --cache --ext .ts src/ --fix --max-warnings 0"
+    "lint": "eslint --cache --ext .ts src/ --fix --max-warnings 0",
+    "build:dist-only": "tsup"
   }
 }

package/src/api.ts

@@ -51,13 +51,12 @@ export type InterceptorFn<M extends keyof InterceptableMethodMap> = (
  * Hides plugin-internal methods from public autocomplete.
  */
 export interface PluginApi {
-  makeState: <P extends Params = Params, MP extends Params = Params>(
+  makeState: <P extends Params = Params>(
     name: string,
     params?: P,
     path?: string,
-    meta?: StateMetaInput<MP>,
-    forceId?: number,
-  ) => State<P, MP>;
+    meta?: StateMetaInput,
+  ) => State<P>;
 
   buildState: (
     routeName: string,
@@ -69,9 +68,7 @@ export interface PluginApi {
     routeParams: P,
   ) => SimpleState<P>;
 
-  matchPath: <P extends Params = Params, MP extends Params = Params>(
-    path: string,
-  ) => State<P, MP> | undefined;
+  matchPath: <P extends Params = Params>(path: string) => State<P> | undefined;
 
   setRootPath: (rootPath: string) => void;
   getRootPath: () => string;

package/src/base.ts

@@ -29,28 +29,17 @@ export interface TransitionMeta {
   };
 }
 
-export interface State<P extends Params = Params, MP extends Params = Params> {
+export interface State<P extends Params = Params> {
   name: string;
   params: P;
   path: string;
-  meta?: StateMeta<MP> | undefined;
   transition?: TransitionMeta | undefined;
 }
 
-export interface StateMeta<P extends Params = Params> {
-  id: number;
+export interface StateMetaInput<P extends Params = Params> {
   params: P;
 }
 
-/**
- * Input type for makeState meta parameter.
- * Omits `id` since it's auto-generated by makeState.
- */
-export type StateMetaInput<P extends Params = Params> = Omit<
-  StateMeta<P>,
-  "id"
->;
-
 /**
  * RouterError interface describing the public API of the RouterError class.
  * The actual class implementation is in the real-router package.

package/src/index.ts

@@ -12,7 +12,6 @@ export type {
 export type {
   Params,
   State,
-  StateMeta,
   StateMetaInput,
   SimpleState,
   NavigationOptions,

package/src/router.ts

@@ -145,14 +145,6 @@ export interface Options {
    * @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.
-   *
-   * @default false
-   */
-  noValidate?: boolean;
 }
 
 export type GuardFn = (
@@ -253,9 +245,7 @@ export interface Router<D extends DefaultDependencies = DefaultDependencies> {
 
   buildPath: (route: string, params?: Params) => string;
 
-  getState: <P extends Params = Params, MP extends Params = Params>() =>
-    | State<P, MP>
-    | undefined;
+  getState: <P extends Params = Params>() => State<P> | undefined;
 
   getPreviousState: () => State | undefined;
 
@@ -279,7 +269,9 @@ export interface Router<D extends DefaultDependencies = DefaultDependencies> {
 
   canNavigateTo: (name: string, params?: Params) => boolean;
 
-  usePlugin: (...plugins: PluginFactory<D>[]) => Unsubscribe;
+  usePlugin: (
+    ...plugins: (PluginFactory<D> | false | null | undefined)[]
+  ) => Unsubscribe;
 
   subscribe: (listener: SubscribeFn) => Unsubscribe;