mobx-route 1.3.2 → 1.3.4

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-BKBYuOMt.cjs");
+const virtualRoute = require("./virtual-route-B_X_wClE.cjs");
 const isRouteEntity = (route) => route && "isOpened" in route;
 exports.Route = virtualRoute.Route;
 exports.RouteGroup = virtualRoute.RouteGroup;

package/index.d.ts

@@ -4,24 +4,27 @@ 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> {
+interface VirtualRouteConfiguration<TParams extends AnyObject | EmptyObject = EmptyObject, TQueryParams extends Record<string, any> = AnyObject> {
     /**
      * [**Documentation**](https://js2me.github.io/mobx-route/core/VirtualRoute.html#abortsignal)
      */
     abortSignal?: AbortSignal;
-    queryParams?: IQueryParams;
+    queryParams?: IQueryParams<TQueryParams>;
     /**
      * [**Documentation**](https://js2me.github.io/mobx-route/core/VirtualRoute.html#initialparams)
      */
@@ -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,11 +87,11 @@ interface VirtualRouteTrx {
  *
  * [**Documentation**](https://js2me.github.io/mobx-route/core/VirtualRoute.html)
  */
-declare class VirtualRoute<TParams extends AnyObject | EmptyObject = EmptyObject> implements AbstractVirtualRoute<TParams> {
-    protected config: VirtualRouteConfiguration<TParams>;
+declare class VirtualRoute<TParams extends AnyObject | EmptyObject = EmptyObject, TQueryParams extends Record<string, any> = AnyObject> implements AbstractVirtualRoute<TParams, TQueryParams> {
+    protected config: VirtualRouteConfiguration<TParams, TQueryParams>;
     private isDestroyed?;
     private disposer?;
-    query: IQueryParams;
+    query: IQueryParams<TQueryParams>;
     params: TParams | null;
     protected status: 'opening' | 'open-rejected' | 'opened' | 'closing' | 'closed' | 'unknown';
     private openChecker;
@@ -100,7 +103,7 @@ declare class VirtualRoute<TParams extends AnyObject | EmptyObject = EmptyObject
      * [**Documentation**](https://js2me.github.io/mobx-route/core/VirtualRoute.html#isouteropened)
      */
     isOuterOpened: boolean | undefined;
-    constructor(config?: VirtualRouteConfiguration<TParams>);
+    constructor(config?: VirtualRouteConfiguration<TParams, TQueryParams>);
     /**
      * [**Documentation**](https://js2me.github.io/mobx-route/core/VirtualRoute.html#isopened)
      */
@@ -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, TQueryParams>) => 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>, TParentRoute extends Route<string, any, any, any, any> | null = null, TQueryParams extends Record<string, any> = AnyObject> extends Omit<Partial<RouteGlobalConfig>, 'createUrl'> {
     /**
      * [**Documentation**](https://js2me.github.io/mobx-route/core/Route.html#abortsignal)
      */
@@ -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,17 +263,17 @@ 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<TParentRoute>, 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<TParentRoute>, 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 AnyRoute = Route<any, any, any, any, any>;
 type InputPathParam = string | number | boolean | null;
 type ParsedPathParam = string;
 type Simplify<T> = T extends infer U ? {
@@ -287,27 +293,28 @@ 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> {
     path: string;
     params: ParsedPathParams<TPath>;
 }
-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;
+type InferPath<T extends AnyRoute> = T extends Route<infer TPath, any, any, any, any> ? TPath : never;
+type InferInputParams<T extends AnyRoute> = T extends VirtualRoute<infer TParams> ? TParams : T extends Route<any, infer TInputParams, any, any, any> ? TInputParams : never;
+type InferParams<T extends AnyRoute> = T extends VirtualRoute<infer TParams> ? TParams : T extends Route<any, any, infer TParams, any, any> ? TParams : never;
+type InferQueryParams<T extends AnyRoute> = T extends Route<any, 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>, TParentRoute extends Route<any, any, any, any, any> | null = null, TQueryParams extends Record<string, any> = AnyObject> {
+    protected config: RouteConfiguration<TPath, TInputParams, TOutputParams, TParentRoute, TQueryParams>;
     private isDestroyed?;
     private disposer?;
     protected history: History;
@@ -317,7 +324,7 @@ declare class Route<TPath extends string, TInputParams extends InputPathParams<T
      * [**Documentation**](https://js2me.github.io/mobx-route/core/Route.html#parent)
      */
     parent: TParentRoute;
-    query: IQueryParams;
+    query: IQueryParams<TQueryParams>;
     private _tokenData;
     private _matcher?;
     private _compiler?;
@@ -350,7 +357,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, TParentRoute, TQueryParams>);
     protected get baseUrl(): string | undefined;
     /**
      * Checks whether current route matches provided path.
@@ -397,7 +404,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, any, TExtendedQueryParams>, 'parent'>): Route<`${TPath}${TExtendedPath}`, TInputParams & TExtendedInputParams, TExtendedOutputParams, this, TExtendedQueryParams>;
     /**
      * Manually add child routes.
      *
@@ -422,11 +429,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 +443,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,23 +467,12 @@ declare class Route<TPath extends string, TInputParams extends InputPathParams<T
      *
      * [**Documentation**](https://js2me.github.io/mobx-route/core/Route.html#update)
      */
-    update(...args: IsPartial<TInputParams> extends true ? [
-        params?: TInputParams | null | undefined,
-        navigateParams?: RouteNavigateParams
-    ] : [params: TInputParams, navigateParams?: RouteNavigateParams]): Promise<void>;
-    update(...args: IsPartial<TInputParams> extends true ? [
-        params?: TInputParams | null | undefined,
-        replace?: RouteNavigateParams['replace'],
-        query?: RouteNavigateParams['query']
-    ] : [
-        params: TInputParams,
-        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;
@@ -485,7 +484,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>, TParentRoute extends Route<any, any, any, any, any> | null = null, TQueryParams extends Record<string, any> = AnyObject>(path: TPath, config?: RouteConfiguration<TPath, TInputParams, TOutputParams, TParentRoute, TQueryParams>) => Route<TPath, TInputParams, TOutputParams, TParentRoute, TQueryParams>;
 
 /**
  * Global configuration for routes and router.
@@ -515,7 +514,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>;
 
@@ -537,4 +536,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-CqADneBu.js";
+import { R, a, b, V, c, d, e, g, r } from "./virtual-route-C7NPJx5y.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.2",
+  "version": "1.3.4",
   "keywords": [
     "mobx",
     "react",
@@ -67,13 +67,13 @@
       "require": "./view-model.cjs",
       "default": "./view-model.js"
     },
-    "./virtual-route-BKBYuOMt": {
-      "require": "./virtual-route-BKBYuOMt.cjs",
-      "default": "./virtual-route-BKBYuOMt.cjs"
+    "./virtual-route-B_X_wClE": {
+      "require": "./virtual-route-B_X_wClE.cjs",
+      "default": "./virtual-route-B_X_wClE.cjs"
     },
-    "./virtual-route-CqADneBu": {
-      "import": "./virtual-route-CqADneBu.js",
-      "default": "./virtual-route-CqADneBu.js"
+    "./virtual-route-C7NPJx5y": {
+      "import": "./virtual-route-C7NPJx5y.js",
+      "default": "./virtual-route-C7NPJx5y.js"
     }
   },
   "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-BKBYuOMt.cjs");
+const virtualRoute = require("./virtual-route-B_X_wClE.cjs");
 const annotations = [
   [mobx.computed.struct, "pathParams"],
   [mobx.computed, "query"]

package/view-model.d.ts

@@ -5,16 +5,19 @@ import { AnyObject, EmptyObject, IsPartial, Maybe, MaybePromise, Class } from 'y
 import { RawQueryParamsData, History, IQueryParams } from 'mobx-location-history';
 import { ParseOptions, MatchOptions, ParamData, TokenData } from 'path-to-regexp';
 
-interface VirtualOpenExtraParams extends Omit<RouteNavigateParams, 'state' | 'mergeQuery'> {
+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 AbstractRouteGroup<TRoutesCollection extends RoutesCollection = RoutesCollection> {
@@ -27,7 +30,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
@@ -37,19 +40,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)
@@ -60,7 +63,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>, TParentRoute extends Route<string, any, any, any, any> | null = null, TQueryParams extends Record<string, any> = AnyObject> extends Omit<Partial<RouteGlobalConfig>, 'createUrl'> {
     /**
      * [**Documentation**](https://js2me.github.io/mobx-route/core/Route.html#abortsignal)
      */
@@ -91,7 +94,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)
      */
@@ -99,17 +102,17 @@ 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<TParentRoute>, 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<TParentRoute>, 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 AnyRoute = Route<any, any, any, any, any>;
 type InputPathParam = string | number | boolean | null;
 type ParsedPathParam = string;
 type Simplify<T> = T extends infer U ? {
@@ -129,10 +132,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> {
@@ -145,8 +148,8 @@ interface ParsedPathData<TPath extends string> {
  *
  * [**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>, TParentRoute extends Route<any, any, any, any, any> | null = null, TQueryParams extends Record<string, any> = AnyObject> {
+    protected config: RouteConfiguration<TPath, TInputParams, TOutputParams, TParentRoute, TQueryParams>;
     private isDestroyed?;
     private disposer?;
     protected history: History;
@@ -156,7 +159,7 @@ declare class Route<TPath extends string, TInputParams extends InputPathParams<T
      * [**Documentation**](https://js2me.github.io/mobx-route/core/Route.html#parent)
      */
     parent: TParentRoute;
-    query: IQueryParams;
+    query: IQueryParams<TQueryParams>;
     private _tokenData;
     private _matcher?;
     private _compiler?;
@@ -189,7 +192,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, TParentRoute, TQueryParams>);
     protected get baseUrl(): string | undefined;
     /**
      * Checks whether current route matches provided path.
@@ -236,7 +239,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, any, TExtendedQueryParams>, 'parent'>): Route<`${TPath}${TExtendedPath}`, TInputParams & TExtendedInputParams, TExtendedOutputParams, this, TExtendedQueryParams>;
     /**
      * Manually add child routes.
      *
@@ -261,11 +264,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;
     /**
@@ -275,19 +278,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,
@@ -296,23 +302,12 @@ declare class Route<TPath extends string, TInputParams extends InputPathParams<T
      *
      * [**Documentation**](https://js2me.github.io/mobx-route/core/Route.html#update)
      */
-    update(...args: IsPartial<TInputParams> extends true ? [
-        params?: TInputParams | null | undefined,
-        navigateParams?: RouteNavigateParams
-    ] : [params: TInputParams, navigateParams?: RouteNavigateParams]): Promise<void>;
-    update(...args: IsPartial<TInputParams> extends true ? [
-        params?: TInputParams | null | undefined,
-        replace?: RouteNavigateParams['replace'],
-        query?: RouteNavigateParams['query']
-    ] : [
-        params: TInputParams,
-        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;

package/view-model.js

@@ -1,6 +1,6 @@
 import { computed } from "mobx";
 import { ViewModelBase, applyObservable } from "mobx-view-model";
-import { r as routeConfig } from "./virtual-route-CqADneBu.js";
+import { r as routeConfig } from "./virtual-route-C7NPJx5y.js";
 const annotations = [
   [computed.struct, "pathParams"],
   [computed, "query"]