mobx-route 1.3.3 → 2.0.0

package/README.md

@@ -1,6 +1,6 @@
 <img src="docs/public/logo.png" align="right" width="156" alt="logo" />
 
-# mobx-route  
+# mobx-route
 
 [![NPM version][npm-image]][npm-url] [![build status][github-build-actions-image]][github-actions-url] [![npm download][download-image]][download-url] [![bundle size][bundlephobia-image]][bundlephobia-url]
 
@@ -14,23 +14,189 @@
 [bundlephobia-url]: https://bundlephobia.com/result?p=mobx-route
 [bundlephobia-image]: https://badgen.net/bundlephobia/minzip/mobx-route
 
+🚀 Simple and lightweight **typed** MobX router 🚀
+_Uses [`path-to-regexp`](https://www.npmjs.com/package/path-to-regexp) power for path matching_
 
-🚀 Simple and lightweight typed MobX router 🚀    
-_Uses [`path-to-regexp` power](https://www.npmjs.com/package/path-to-regexp)_  
+### [📖 Read the docs →](https://js2me.github.io/mobx-route/)
 
-### [Read the docs →](https://js2me.github.io/mobx-route/)  
+---
 
+## Quick Start
 
 ```ts
 import { createRoute } from "mobx-route";
 
 const userDetails = createRoute("/users/:id");
 
-await userDetails.open({ id: 1 }); // path params are required
+// Path params are required — TypeScript enforces it
+await userDetails.open({ id: 1 });
 
-userDetails.isOpened; // true;
+userDetails.isOpened; // true
+userDetails.params;   // { id: "1" } — fully typed
 ```
 
-## Contribution Guide    
+---
 
-Want to contribute ? [Follow this guide](https://github.com/js2me/mobx-route/blob/master/CONTRIBUTING.md)  
+## ✨ Features
+
+### 🔗 Nested Routes with `.extend()`
+
+Build route trees naturally — no config arrays, no `<Routes>` wrappers:
+
+```ts
+const users = createRoute("/users");
+const userDetails = users.extend("/:userId");
+const userPhotos = userDetails.extend("/photos");
+
+// Path is auto-concatenated: /users/:userId/photos
+await userPhotos.open({ userId: 42 });
+// → /users/42/photos
+
+users.isOpened;        // true (parent is open too)
+users.hasOpenedChildren; // true
+```
+
+### 🛡️ Route Guards & Redirects
+
+Protect routes with `beforeOpen` — cancel navigation or redirect:
+
+```ts
+const dashboard = createRoute("/dashboard", {
+  beforeOpen: async () => {
+    if (!await isAuthenticated()) {
+      return { url: "/login", replace: true }; // redirect
+    }
+    // return undefined → proceed
+  },
+  checkOpened: () => currentUser.isAuthorized, // reactive predicate
+});
+```
+
+### 🔮 Virtual Routes for Modals & Drawers
+
+Same `.open()` / `.close()` / `.isOpened` API — but no URL involved:
+
+```ts
+const authModal = createVirtualRoute({
+  checkOpened: (route) => route.query.data.modal === "auth",
+  open: (_, route) => route.query.update({ modal: "auth" }),
+  close: (route) => route.query.update({ modal: undefined }),
+  beforeClose: () => !hasUnsavedChanges, // prevent closing
+});
+
+authModal.isOpened;  // reactive — auto-updates from query
+authModal.isClosing; // for exit animations
+```
+
+### 🎯 Typed Query Params
+
+```ts
+const search = createRoute<
+  "/search",
+  {},
+  {},
+  { q: string; page?: number; sort?: "asc" | "desc" }
+>("/search");
+
+// TQueryParams types the INPUT — what you pass to open()
+await search.open({}, { query: { q: "mobx", page: 1 } });
+
+// query.data is always Record<string, string> at runtime (values come from URL)
+search.query.data.q;    // string
+search.query.data.page; // string | undefined — use Number() or QueryParam for typed access
+```
+
+### 🔄 `update()` for In-Place Changes
+
+Replace params without polluting browser history:
+
+```ts
+await userRoute.open({ userId: 1 }, { query: { tab: "profile" } });
+await userRoute.update({ userId: 2 });
+// → /users/2?tab=profile (replace: true, mergeQuery: true by default)
+```
+
+### 🧩 React Integration
+
+```tsx
+import { RouteView, RouteViewGroup, Link } from "mobx-route/react";
+
+// Declarative route rendering
+<RouteView route={userRoute} view={UserPage} fallback={<Loading />} />
+
+// Route switching with fallback
+<RouteViewGroup otherwise={notFoundRoute}>
+  <RouteView route={homeRoute} view={HomePage} />
+  <RouteView route={userRoute} view={UserPage} />
+  <div>Not found</div>
+</RouteViewGroup>
+
+// Type-safe links
+<Link to={userRoute} params={{ userId: 42 }}>Profile</Link>
+```
+
+### 🧠 View Model Integration
+
+```ts
+import { RouteViewModel } from "mobx-route/view-model";
+
+class UserPageVM extends RouteViewModel<typeof userRoute> {
+  route = userRoute;
+  // payload, pathParams, query, isMounted — all built-in
+}
+```
+
+### 🌍 Optional Path Segments & Wildcards
+
+```ts
+// Optional segment
+const route = createRoute("/users{/:tab}");
+route.open();          // → /users
+route.open({ tab: 1 }); // → /users/1
+
+// Wildcard/rest params
+const docs = createRoute("/docs/*rest");
+docs.open({ rest: ["api", "v2", "auth"] }); // → /docs/api/v2/auth
+```
+
+### 📦 Tree-Shakeable Subpath Exports
+
+Only pay for what you use:
+
+```ts
+import { createRoute } from "mobx-route";              // core only
+import { RouteView, Link } from "mobx-route/react";    // + React
+import { RouteViewModel } from "mobx-route/view-model"; // + VM
+```
+
+---
+
+## Installation
+
+```bash
+npm install mobx-route
+# or
+pnpm add mobx-route
+# or
+yarn add mobx-route
+```
+
+Peer dependencies (React integration is optional):
+
+```bash
+npm install mobx
+# For React:
+npm install mobx-react-lite react react-dom
+```
+
+---
+
+## Contribution Guide
+
+Want to contribute? [Follow this guide](https://github.com/js2me/mobx-route/blob/master/CONTRIBUTING.md)
+
+---
+
+## License
+
+[MIT](https://github.com/js2me/mobx-route/blob/master/LICENSE)

package/index.cjs

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const mobxLocationHistory = require("mobx-location-history");
-const virtualRoute = require("./virtual-route-sU8rVTsu.cjs");
+const virtualRoute = require("./virtual-route-DCnOqDz5.cjs");
 const isRouteEntity = (route) => route && "isOpened" in route;
 exports.Route = virtualRoute.Route;
 exports.RouteGroup = virtualRoute.RouteGroup;

package/index.d.ts

@@ -4,17 +4,20 @@ import * as yummies_complex from 'yummies/complex';
 import { ParseOptions, MatchOptions, ParamData, TokenData } from 'path-to-regexp';
 import { AnyObject, EmptyObject, IsPartial, Maybe, MaybeFn, MaybePromise } from 'yummies/types';
 
-type AnyVirtualRoute = VirtualRoute<any> | AbstractVirtualRoute<any>;
-interface VirtualOpenExtraParams extends Omit<RouteNavigateParams, 'state' | 'mergeQuery'> {
+type AnyVirtualRoute = VirtualRoute<any, any> | AbstractVirtualRoute<any, any>;
+interface VirtualOpenExtraParams<TQueryParams extends Record<string, any> = AnyObject> extends Omit<RouteNavigateParams<TQueryParams>, 'state' | 'mergeQuery'> {
 }
-interface AbstractVirtualRoute<TParams extends AnyObject | EmptyObject = EmptyObject> {
+interface AbstractVirtualRoute<TParams extends AnyObject | EmptyObject = EmptyObject, TQueryParams extends Record<string, any> = AnyObject> {
     isOpened: boolean;
     isOpening: boolean;
     params: TParams | null;
     /**
      * [**Documentation**](https://js2me.github.io/mobx-route/core/VirtualRoute.html#open)
      */
-    open(...args: IsPartial<TParams> extends true ? [params?: Maybe<TParams>, extraParams?: VirtualOpenExtraParams] : [params: TParams, extraParams?: VirtualOpenExtraParams]): Promise<void>;
+    open(...args: IsPartial<TParams> extends true ? [
+        params?: Maybe<TParams>,
+        extraParams?: VirtualOpenExtraParams<TQueryParams>
+    ] : [params: TParams, extraParams?: VirtualOpenExtraParams<TQueryParams>]): Promise<void>;
 }
 interface VirtualRouteConfiguration<TParams extends AnyObject | EmptyObject = EmptyObject> {
     /**
@@ -73,9 +76,9 @@ interface VirtualRouteConfiguration<TParams extends AnyObject | EmptyObject = Em
      */
     afterUpdate?: (params: NoInfer<TParams | null>, route: VirtualRoute<NoInfer<TParams>>) => void;
 }
-interface VirtualRouteTrx {
+interface VirtualRouteTrx<TQueryParams extends Record<string, any> = AnyObject> {
     params: any;
-    extra?: Maybe<VirtualOpenExtraParams>;
+    extra?: Maybe<VirtualOpenExtraParams<TQueryParams>>;
     manual?: boolean;
 }
 
@@ -84,7 +87,7 @@ interface VirtualRouteTrx {
  *
  * [**Documentation**](https://js2me.github.io/mobx-route/core/VirtualRoute.html)
  */
-declare class VirtualRoute<TParams extends AnyObject | EmptyObject = EmptyObject> implements AbstractVirtualRoute<TParams> {
+declare class VirtualRoute<TParams extends AnyObject | EmptyObject = EmptyObject, TQueryParams extends Record<string, any> = AnyObject> implements AbstractVirtualRoute<TParams, TQueryParams> {
     protected config: VirtualRouteConfiguration<TParams>;
     private isDestroyed?;
     private disposer?;
@@ -120,7 +123,10 @@ declare class VirtualRoute<TParams extends AnyObject | EmptyObject = EmptyObject
     /**
      * [**Documentation**](https://js2me.github.io/mobx-route/core/VirtualRoute.html#open)
      */
-    open(...args: IsPartial<TParams> extends true ? [params?: Maybe<TParams>, extraParams?: VirtualOpenExtraParams] : [params: TParams, extraParams?: VirtualOpenExtraParams]): Promise<void>;
+    open(...args: IsPartial<TParams> extends true ? [
+        params?: Maybe<TParams>,
+        extraParams?: VirtualOpenExtraParams<TQueryParams>
+    ] : [params: TParams, extraParams?: VirtualOpenExtraParams<TQueryParams>]): Promise<void>;
     /**
      * [**Documentation**](https://js2me.github.io/mobx-route/core/VirtualRoute.html#close)
      */
@@ -129,7 +135,7 @@ declare class VirtualRoute<TParams extends AnyObject | EmptyObject = EmptyObject
     private confirmClosing;
     destroy(): void;
 }
-declare const createVirtualRoute: <TParams extends AnyObject | EmptyObject = EmptyObject>(config?: VirtualRouteConfiguration<TParams>) => VirtualRoute<TParams>;
+declare const createVirtualRoute: <TParams extends AnyObject | EmptyObject = EmptyObject, TQueryParams extends Record<string, any> = AnyObject>(config?: VirtualRouteConfiguration<TParams>) => VirtualRoute<TParams, TQueryParams>;
 
 /**
  * Class for grouping related routes and managing their state.
@@ -185,7 +191,7 @@ type RoutesArrayCollection = AnyAbstractRouteEntity[];
 type RoutesObjectCollection = Record<string, AnyAbstractRouteEntity>;
 type RoutesCollection = RoutesArrayCollection | RoutesObjectCollection;
 
-type NavigationTrx<TParams extends AnyObject = AnyObject> = {
+type NavigationTrx<TParams extends AnyObject = AnyObject, TQueryParams extends Record<string, any> = AnyObject> = {
     state?: any;
     /**
      * path parameters
@@ -195,19 +201,19 @@ type NavigationTrx<TParams extends AnyObject = AnyObject> = {
     params?: TParams;
     url: string;
     replace?: boolean;
-    query?: AnyObject;
+    query?: Partial<TQueryParams>;
     preferSkipHistoryUpdate?: boolean;
 };
 /**
  * Returning `false` means ignore navigation
  */
 type BeforeOpenFeedback = void | boolean | Pick<NavigationTrx, 'url' | 'state' | 'replace'>;
-interface UrlCreateParams<TInputParams> {
+interface UrlCreateParams<TInputParams, TQueryParams extends Record<string, any> = AnyObject> {
     baseUrl?: string | undefined;
     params: TInputParams;
-    query: AnyObject;
+    query: Partial<TQueryParams>;
 }
-type UrlCreateParamsFn<TInputParams = any> = (params: UrlCreateParams<TInputParams>, currentQueryData: RawQueryParamsData) => Maybe<UrlCreateParams<TInputParams>>;
+type UrlCreateParamsFn<TInputParams = any, TQueryParams extends Record<string, any> = AnyObject> = (params: UrlCreateParams<TInputParams, TQueryParams>, currentQueryData: RawQueryParamsData) => Maybe<UrlCreateParams<TInputParams, TQueryParams>>;
 /**
  * Output options for `createUrl()` (third argument).
  * @see [**Documentation**](https://js2me.github.io/mobx-route/core/Route.html#createurl)
@@ -218,7 +224,7 @@ interface CreatedUrlOutputParams {
     /** @see [**Documentation**](https://js2me.github.io/mobx-route/core/Route.html#createurl) */
     omitQuery?: boolean;
 }
-interface RouteConfiguration<TPath extends string, TInputParams extends InputPathParams<TPath> = InputPathParams<TPath>, TOutputParams extends AnyObject = ParsedPathParams<TPath>, TParentRoute extends Route<string, any, any, any> | null = null> extends Omit<Partial<RouteGlobalConfig>, 'createUrl'> {
+interface RouteConfiguration<TPath extends string, TInputParams extends InputPathParams<TPath> = InputPathParams<TPath>, TOutputParams extends AnyObject = ParsedPathParams<TPath>, TQueryParams extends Record<string, any> = AnyObject> extends Omit<Partial<RouteGlobalConfig>, 'createUrl'> {
     /**
      * [**Documentation**](https://js2me.github.io/mobx-route/core/Route.html#abortsignal)
      */
@@ -236,7 +242,7 @@ interface RouteConfiguration<TPath extends string, TInputParams extends InputPat
     meta?: AnyObject;
     parseOptions?: ParseOptions;
     matchOptions?: MatchOptions & ParseOptions;
-    parent?: TParentRoute;
+    parent?: AnyRoute | null;
     children?: AnyRoute[];
     /**
      * [**Documentation**](https://js2me.github.io/mobx-route/core/Route.html#params)
@@ -249,7 +255,7 @@ interface RouteConfiguration<TPath extends string, TInputParams extends InputPat
     /**
      * [**Documentation**](https://js2me.github.io/mobx-route/core/Route.html#beforeopen)
      */
-    beforeOpen?: (navigationTransaction: NavigationTrx<NoInfer<TInputParams>>) => MaybePromise<BeforeOpenFeedback>;
+    beforeOpen?: (navigationTransaction: NavigationTrx<NoInfer<TInputParams>, NoInfer<TQueryParams>>) => MaybePromise<BeforeOpenFeedback>;
     /**
      * [**Documentation**](https://js2me.github.io/mobx-route/core/Route.html#afterclose)
      */
@@ -257,15 +263,15 @@ interface RouteConfiguration<TPath extends string, TInputParams extends InputPat
     /**
      * [**Documentation**](https://js2me.github.io/mobx-route/core/Route.html#afteropen)
      */
-    afterOpen?: (data: ParsedPathData<NoInfer<TPath>>, route: Route<NoInfer<TPath>, NoInfer<TInputParams>, NoInfer<TOutputParams>, NoInfer<TParentRoute>>) => void;
+    afterOpen?: (data: ParsedPathData<NoInfer<TPath>>, route: Route<NoInfer<TPath>, NoInfer<TInputParams>, NoInfer<TOutputParams>, NoInfer<TQueryParams>>) => void;
     /**
      * [**Documentation**](https://js2me.github.io/mobx-route/core/Route.html#afterupdate)
      */
-    afterUpdate?: (data: ParsedPathData<NoInfer<TPath>>, route: Route<NoInfer<TPath>, NoInfer<TInputParams>, NoInfer<TOutputParams>, NoInfer<TParentRoute>>) => void;
+    afterUpdate?: (data: ParsedPathData<NoInfer<TPath>>, route: Route<NoInfer<TPath>, NoInfer<TInputParams>, NoInfer<TOutputParams>, NoInfer<TQueryParams>>) => void;
     /**
      * [**Documentation**](https://js2me.github.io/mobx-route/core/Route.html#createurl)
      */
-    createUrl?: UrlCreateParamsFn<TInputParams>;
+    createUrl?: UrlCreateParamsFn<TInputParams, TQueryParams>;
 }
 type AnyRoute = Route<any, any, any, any>;
 type InputPathParam = string | number | boolean | null;
@@ -287,10 +293,10 @@ type PathToObject<Path extends string, PropertyValue = string> = Simplify<Path e
 } : {}>;
 type ParsedPathParams<Path extends string> = PathToObject<Path, ParsedPathParam>;
 type InputPathParams<Path extends string> = PathToObject<Path, InputPathParam>;
-interface RouteNavigateParams {
+interface RouteNavigateParams<TQueryParams extends Record<string, any> = AnyObject> {
     replace?: boolean;
     state?: any;
-    query?: AnyObject;
+    query?: Partial<TQueryParams>;
     mergeQuery?: boolean;
 }
 interface ParsedPathData<TPath extends string> {
@@ -300,14 +306,21 @@ interface ParsedPathData<TPath extends string> {
 type InferPath<T extends AnyRoute> = T extends Route<infer TPath, any, any, any> ? TPath : never;
 type InferInputParams<T extends AnyRoute> = T extends VirtualRoute<infer TParams> ? TParams : T extends Route<any, infer TInputParams, any, any> ? TInputParams : never;
 type InferParams<T extends AnyRoute> = T extends VirtualRoute<infer TParams> ? TParams : T extends Route<any, any, infer TParams, any> ? TParams : never;
+/**
+ * Extracts the query params input type from a route.
+ *
+ * Note: this represents the INPUT shape used in `open()`, `createUrl()`, etc.
+ * The actual `route.query.data` values are always `Record<string, string>` at runtime.
+ */
+type InferQueryParams<T extends AnyRoute> = T extends Route<any, any, any, infer TQueryParams> ? TQueryParams : never;
 
 /**
  * Class for creating path based route.
  *
  * [**Documentation**](https://js2me.github.io/mobx-route/core/Route.html)
  */
-declare class Route<TPath extends string, TInputParams extends InputPathParams<TPath> = InputPathParams<TPath>, TOutputParams extends AnyObject = ParsedPathParams<TPath>, TParentRoute extends Route<any, any, any, any> | null = null> {
-    protected config: RouteConfiguration<TPath, TInputParams, TOutputParams, TParentRoute>;
+declare class Route<TPath extends string, TInputParams extends InputPathParams<TPath> = InputPathParams<TPath>, TOutputParams extends AnyObject = ParsedPathParams<TPath>, TQueryParams extends Record<string, any> = AnyObject> {
+    protected config: RouteConfiguration<TPath, TInputParams, TOutputParams, TQueryParams>;
     private isDestroyed?;
     private disposer?;
     protected history: History;
@@ -316,7 +329,7 @@ declare class Route<TPath extends string, TInputParams extends InputPathParams<T
      *
      * [**Documentation**](https://js2me.github.io/mobx-route/core/Route.html#parent)
      */
-    parent: TParentRoute;
+    parent: AnyRoute | null;
     query: IQueryParams;
     private _tokenData;
     private _matcher?;
@@ -350,7 +363,7 @@ declare class Route<TPath extends string, TInputParams extends InputPathParams<T
      * [**Documentation**](https://js2me.github.io/mobx-route/core/Route.html#children)
      */
     children: AnyRoute[];
-    constructor(pathDeclaration: TPath, config?: RouteConfiguration<TPath, TInputParams, TOutputParams, TParentRoute>);
+    constructor(pathDeclaration: TPath, config?: RouteConfiguration<TPath, TInputParams, TOutputParams, TQueryParams>);
     protected get baseUrl(): string | undefined;
     /**
      * Checks whether current route matches provided path.
@@ -397,7 +410,7 @@ declare class Route<TPath extends string, TInputParams extends InputPathParams<T
      *
      * [**Documentation**](https://js2me.github.io/mobx-route/core/Route.html#extend)
      */
-    extend<TExtendedPath extends string, TExtendedInputParams extends InputPathParams<`${TPath}${TExtendedPath}`> = InputPathParams<`${TPath}${TExtendedPath}`>, TExtendedOutputParams extends AnyObject = TInputParams & ParsedPathParams<`${TPath}${TExtendedPath}`>>(pathDeclaration: TExtendedPath, config?: Omit<RouteConfiguration<`${TPath}${TExtendedPath}`, TInputParams & TExtendedInputParams, TExtendedOutputParams, any>, 'parent'>): Route<`${TPath}${TExtendedPath}`, TInputParams & TExtendedInputParams, TExtendedOutputParams, this>;
+    extend<TExtendedPath extends string, TExtendedInputParams extends InputPathParams<`${TPath}${TExtendedPath}`> = InputPathParams<`${TPath}${TExtendedPath}`>, TExtendedOutputParams extends AnyObject = TInputParams & ParsedPathParams<`${TPath}${TExtendedPath}`>, TExtendedQueryParams extends Record<string, any> = TQueryParams>(pathDeclaration: TExtendedPath, config?: Omit<RouteConfiguration<`${TPath}${TExtendedPath}`, TInputParams & TExtendedInputParams, TExtendedOutputParams, TExtendedQueryParams>, 'parent'>): Route<`${TPath}${TExtendedPath}`, TInputParams & TExtendedInputParams, TExtendedOutputParams, TExtendedQueryParams>;
     /**
      * Manually add child routes.
      *
@@ -422,11 +435,11 @@ declare class Route<TPath extends string, TInputParams extends InputPathParams<T
      */
     createUrl(...args: IsPartial<TInputParams> extends true ? [
         params?: Maybe<TInputParams>,
-        query?: Maybe<AnyObject>,
+        query?: Maybe<Partial<TQueryParams>>,
         mergeQueryOrParams?: boolean | CreatedUrlOutputParams
     ] : [
         params: TInputParams,
-        query?: Maybe<AnyObject>,
+        query?: Maybe<Partial<TQueryParams>>,
         mergeQueryOrParams?: boolean | CreatedUrlOutputParams
     ]): string;
     /**
@@ -436,19 +449,22 @@ declare class Route<TPath extends string, TInputParams extends InputPathParams<T
      */
     open(...args: IsPartial<TInputParams> extends true ? [
         params?: TInputParams | null | undefined,
-        navigateParams?: RouteNavigateParams
-    ] : [params: TInputParams, navigateParams?: RouteNavigateParams]): Promise<void>;
+        navigateParams?: RouteNavigateParams<TQueryParams>
+    ] : [
+        params: TInputParams,
+        navigateParams?: RouteNavigateParams<TQueryParams>
+    ]): Promise<void>;
     open(...args: IsPartial<TInputParams> extends true ? [
         params?: TInputParams | null | undefined,
-        replace?: RouteNavigateParams['replace'],
-        query?: RouteNavigateParams['query']
+        replace?: RouteNavigateParams<TQueryParams>['replace'],
+        query?: RouteNavigateParams<TQueryParams>['query']
     ] : [
         params: TInputParams,
-        replace?: RouteNavigateParams['replace'],
-        query?: RouteNavigateParams['query']
+        replace?: RouteNavigateParams<TQueryParams>['replace'],
+        query?: RouteNavigateParams<TQueryParams>['query']
     ]): Promise<void>;
-    open(url: string, navigateParams?: RouteNavigateParams): Promise<void>;
-    open(url: string, replace?: RouteNavigateParams['replace'], query?: RouteNavigateParams['query']): Promise<void>;
+    open(url: string, navigateParams?: RouteNavigateParams<TQueryParams>): Promise<void>;
+    open(url: string, replace?: RouteNavigateParams<TQueryParams>['replace'], query?: RouteNavigateParams<TQueryParams>['query']): Promise<void>;
     /**
      * Updates the current route if it is already open.
      * Unlike `open`, this is a no-op if the route is not open,
@@ -457,12 +473,12 @@ declare class Route<TPath extends string, TInputParams extends InputPathParams<T
      *
      * [**Documentation**](https://js2me.github.io/mobx-route/core/Route.html#update)
      */
-    update(params?: TInputParams | null | undefined, navigateParams?: RouteNavigateParams): Promise<void>;
-    update(params?: TInputParams | null | undefined, replace?: RouteNavigateParams['replace'], query?: RouteNavigateParams['query']): Promise<void>;
-    update(url: string, navigateParams?: RouteNavigateParams): Promise<void>;
-    update(url: string, replace?: RouteNavigateParams['replace'], query?: RouteNavigateParams['query']): Promise<void>;
+    update(params?: TInputParams | null | undefined, navigateParams?: RouteNavigateParams<TQueryParams>): Promise<void>;
+    update(params?: TInputParams | null | undefined, replace?: RouteNavigateParams<TQueryParams>['replace'], query?: RouteNavigateParams<TQueryParams>['query']): Promise<void>;
+    update(url: string, navigateParams?: RouteNavigateParams<TQueryParams>): Promise<void>;
+    update(url: string, replace?: RouteNavigateParams<TQueryParams>['replace'], query?: RouteNavigateParams<TQueryParams>['query']): Promise<void>;
     protected get tokenData(): TokenData;
-    protected confirmOpening(trx: NavigationTrx<TInputParams>): Promise<true | undefined>;
+    protected confirmOpening(trx: NavigationTrx<TInputParams, TQueryParams>): Promise<true | undefined>;
     protected confirmClosing(): boolean;
     private firstPathMatchingRun;
     private checkPathMatch;
@@ -474,7 +490,7 @@ declare class Route<TPath extends string, TInputParams extends InputPathParams<T
      */
     destroy(): void;
 }
-declare const createRoute: <TPath extends string, TInputParams extends InputPathParams<TPath> = InputPathParams<TPath>, TOutputParams extends AnyObject = ParsedPathParams<TPath>, TParentRoute extends Route<any, any, any, any> | null = null>(path: TPath, config?: RouteConfiguration<TPath, TInputParams, TOutputParams, TParentRoute>) => Route<TPath, TInputParams, TOutputParams, TParentRoute>;
+declare const createRoute: <TPath extends string, TInputParams extends InputPathParams<TPath> = InputPathParams<TPath>, TOutputParams extends AnyObject = ParsedPathParams<TPath>, TQueryParams extends Record<string, any> = AnyObject>(path: TPath, config?: RouteConfiguration<TPath, TInputParams, TOutputParams, TQueryParams>) => Route<TPath, TInputParams, TOutputParams, TQueryParams>;
 
 /**
  * Global configuration for routes and router.
@@ -504,7 +520,7 @@ interface RouterConfiguration<TRoutesStruct extends RoutesCollection> {
     history?: History;
     queryParams?: IQueryParams;
 }
-interface RouterNavigateOptions extends RouteNavigateParams {
+interface RouterNavigateOptions<TQueryParams extends Record<string, any> = AnyObject> extends RouteNavigateParams<TQueryParams> {
 }
 type AnyRouter = Router<RoutesCollection>;
 
@@ -526,4 +542,4 @@ declare const createRouter: <TRoutesCollection extends RoutesCollection>(config:
 declare const isRouteEntity: (route: any) => route is AnyRouteEntity;
 
 export { Route, RouteGroup, Router, VirtualRoute, createRoute, createRouter, createVirtualRoute, groupRoutes, isRouteEntity, routeConfig };
-export type { AbstractRouteGroup, AbstractVirtualRoute, AnyAbstractRoute, AnyAbstractRouteEntity, AnyRoute, AnyRouteEntity, AnyRouteGroup, AnyRouter, AnyVirtualRoute, BeforeOpenFeedback, CreatedUrlOutputParams, InferInputParams, InferParams, InferPath, InputPathParam, InputPathParams, NavigationTrx, ParsedPathData, ParsedPathParam, ParsedPathParams, PathToObject, RouteConfiguration, RouteGlobalConfig, RouteNavigateParams, RouteParams, RouterConfiguration, RouterNavigateOptions, RoutesArrayCollection, RoutesCollection, RoutesObjectCollection, UrlCreateParams, UrlCreateParamsFn, VirtualOpenExtraParams, VirtualRouteConfiguration, VirtualRouteTrx };
+export type { AbstractRouteGroup, AbstractVirtualRoute, AnyAbstractRoute, AnyAbstractRouteEntity, AnyRoute, AnyRouteEntity, AnyRouteGroup, AnyRouter, AnyVirtualRoute, BeforeOpenFeedback, CreatedUrlOutputParams, InferInputParams, InferParams, InferPath, InferQueryParams, InputPathParam, InputPathParams, NavigationTrx, ParsedPathData, ParsedPathParam, ParsedPathParams, PathToObject, RouteConfiguration, RouteGlobalConfig, RouteNavigateParams, RouteParams, RouterConfiguration, RouterNavigateOptions, RoutesArrayCollection, RoutesCollection, RoutesObjectCollection, UrlCreateParams, UrlCreateParamsFn, VirtualOpenExtraParams, VirtualRouteConfiguration, VirtualRouteTrx };

package/index.js

@@ -1,5 +1,5 @@
 export * from "mobx-location-history";
-import { R, a, b, V, c, d, e, g, r } from "./virtual-route-Chv5K9C8.js";
+import { R, a, b, V, c, d, e, g, r } from "./virtual-route-C21P-S6I.js";
 const isRouteEntity = (route) => route && "isOpened" in route;
 export {
   R as Route,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mobx-route",
-  "version": "1.3.3",
+  "version": "2.0.0",
   "keywords": [
     "mobx",
     "react",
@@ -67,13 +67,13 @@
       "require": "./view-model.cjs",
       "default": "./view-model.js"
     },
-    "./virtual-route-Chv5K9C8": {
-      "import": "./virtual-route-Chv5K9C8.js",
-      "default": "./virtual-route-Chv5K9C8.js"
+    "./virtual-route-C21P-S6I": {
+      "import": "./virtual-route-C21P-S6I.js",
+      "default": "./virtual-route-C21P-S6I.js"
     },
-    "./virtual-route-sU8rVTsu": {
-      "require": "./virtual-route-sU8rVTsu.cjs",
-      "default": "./virtual-route-sU8rVTsu.cjs"
+    "./virtual-route-DCnOqDz5": {
+      "require": "./virtual-route-DCnOqDz5.cjs",
+      "default": "./virtual-route-DCnOqDz5.cjs"
     }
   },
   "files": [

package/view-model.cjs

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const mobx = require("mobx");
 const mobxViewModel = require("mobx-view-model");
-const virtualRoute = require("./virtual-route-sU8rVTsu.cjs");
+const virtualRoute = require("./virtual-route-DCnOqDz5.cjs");
 const annotations = [
   [mobx.computed.struct, "pathParams"],
   [mobx.computed, "query"]