mobx-route 1.2.3 → 1.3.0

package/view-model.d.ts

@@ -1,39 +1,401 @@
-import { AnyAbstractRouteEntity, RouteParams, IQueryParams } from 'mobx-route';
-import { ViewModelBase, ViewModelParams } from 'mobx-view-model';
-import { EmptyObject } from 'yummies/types';
+import * as mobx_view_model from 'mobx-view-model';
+import { ViewModelBase, ViewModel } from 'mobx-view-model';
+import * as yummies_types from 'yummies/types';
+import { AnyObject, EmptyObject, IsPartial, Maybe, MaybePromise, Class } from 'yummies/types';
+import { RawQueryParamsData, History, IQueryParams } from 'mobx-location-history';
+import { ParseOptions, MatchOptions, ParamData, TokenData } from 'path-to-regexp';
 
-declare abstract class RouteViewModel<TRoute extends AnyAbstractRouteEntity = AnyAbstractRouteEntity> extends ViewModelBase<EmptyObject> {
+interface VirtualOpenExtraParams extends Omit<RouteNavigateParams, 'state' | 'mergeQuery'> {
+}
+interface AbstractVirtualRoute<TParams extends AnyObject | EmptyObject = EmptyObject> {
+    isOpened: boolean;
+    isOpening: boolean;
+    params: TParams | null;
     /**
-     * Route entity bound to this view model.
+     * [**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>;
+}
+
+interface AbstractRouteGroup<TRoutesCollection extends RoutesCollection = RoutesCollection> {
+    routes: TRoutesCollection;
+    isOpened: boolean;
+}
+type AnyAbstractRoute = AnyRoute | AbstractVirtualRoute<any>;
+type AnyAbstractRouteEntity = AnyAbstractRoute | AbstractRouteGroup;
+type RoutesArrayCollection = AnyAbstractRouteEntity[];
+type RoutesObjectCollection = Record<string, AnyAbstractRouteEntity>;
+type RoutesCollection = RoutesArrayCollection | RoutesObjectCollection;
+
+type NavigationTrx<TParams extends AnyObject = AnyObject> = {
+    state?: any;
+    /**
+     * path parameters
      *
-     * [**Documentation**](https://js2me.github.io/mobx-route/view-model/RouteViewModel#route)
+     * can be received from extended routes
      */
-    abstract readonly route: TRoute;
+    params?: TParams;
+    url: string;
+    replace?: boolean;
+    query?: AnyObject;
+    preferSkipHistoryUpdate?: boolean;
+};
+/**
+ * Returning `false` means ignore navigation
+ */
+type BeforeOpenFeedback = void | boolean | Pick<NavigationTrx, 'url' | 'state' | 'replace'>;
+interface UrlCreateParams<TInputParams> {
+    baseUrl?: string | undefined;
+    params: TInputParams;
+    query: AnyObject;
+}
+type UrlCreateParamsFn<TInputParams = any> = (params: UrlCreateParams<TInputParams>, currentQueryData: RawQueryParamsData) => Maybe<UrlCreateParams<TInputParams>>;
+/**
+ * Output options for `createUrl()` (third argument).
+ * @see [**Documentation**](https://js2me.github.io/mobx-route/core/Route.html#createurl)
+ */
+interface CreatedUrlOutputParams {
+    /** @see [**Documentation**](https://js2me.github.io/mobx-route/core/Route.html#createurl) */
+    mergeQuery?: boolean;
+    /** @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'> {
+    /**
+     * [**Documentation**](https://js2me.github.io/mobx-route/core/Route.html#abortsignal)
+     */
+    abortSignal?: AbortSignal;
+    index?: boolean;
+    hash?: boolean;
+    /**
+     * Exact match for the path
+     * @default false
+     */
+    exact?: boolean;
+    /**
+     * [**Documentation**](https://js2me.github.io/mobx-route/core/Route.html#meta)
+     */
+    meta?: AnyObject;
+    parseOptions?: ParseOptions;
+    matchOptions?: MatchOptions & ParseOptions;
+    parent?: TParentRoute;
+    children?: AnyRoute[];
+    /**
+     * [**Documentation**](https://js2me.github.io/mobx-route/core/Route.html#params)
+     */
+    params?: (params: ParsedPathParams<TPath>, meta: AnyObject | undefined) => TOutputParams | null | false;
+    /**
+     * [**Documentation**](https://js2me.github.io/mobx-route/core/Route.html#checkopened)
+     */
+    checkOpened?: (parsedPathData: ParsedPathData<NoInfer<TPath>>) => boolean;
+    /**
+     * [**Documentation**](https://js2me.github.io/mobx-route/core/Route.html#beforeopen)
+     */
+    beforeOpen?: (navigationTransaction: NavigationTrx<NoInfer<TInputParams>>) => MaybePromise<BeforeOpenFeedback>;
+    /**
+     * [**Documentation**](https://js2me.github.io/mobx-route/core/Route.html#afterclose)
+     */
+    afterClose?: () => void;
     /**
-     * Caches the latest known route params.
+     * [**Documentation**](https://js2me.github.io/mobx-route/core/Route.html#afteropen)
      */
-    protected lastPayload: RouteParams<TRoute>;
-    constructor(params: ViewModelParams<EmptyObject, any>);
+    afterOpen?: (data: ParsedPathData<NoInfer<TPath>>, route: Route<NoInfer<TPath>, NoInfer<TInputParams>, NoInfer<TOutputParams>, NoInfer<TParentRoute>>) => void;
     /**
-     * Current route params with fallback to the last cached value.
+     * [**Documentation**](https://js2me.github.io/mobx-route/core/Route.html#afterupdate)
      */
-    get payload(): RouteParams<TRoute>;
+    afterUpdate?: (data: ParsedPathData<NoInfer<TPath>>, route: Route<NoInfer<TPath>, NoInfer<TInputParams>, NoInfer<TOutputParams>, NoInfer<TParentRoute>>) => void;
     /**
-     * Current query params from route or global route config.
+     * [**Documentation**](https://js2me.github.io/mobx-route/core/Route.html#createurl)
+     */
+    createUrl?: UrlCreateParamsFn<TInputParams>;
+}
+type AnyRoute = Route<any, any, any, any>;
+type InputPathParam = string | number | boolean | null;
+type ParsedPathParam = string;
+type Simplify<T> = T extends infer U ? {
+    [K in keyof U]: U[K];
+} : never;
+type RouteParams<TRoute extends AnyAbstractRouteEntity> = TRoute extends {
+    pathDeclaration: string;
+} ? ParsedPathParams<TRoute['pathDeclaration']> : TRoute extends {
+    params: infer TParams;
+} ? Exclude<TParams, null> : AnyObject;
+type PathToObject<Path extends string, PropertyValue = string> = Simplify<Path extends `${infer Prefix}{${infer Optional}}${infer Suffix}` ? PathToObject<`${Prefix}${Suffix}`, PropertyValue> & Partial<PathToObject<Optional, PropertyValue>> : Path extends `${infer PartA}/${infer PartB}` ? PathToObject<PartA, PropertyValue> & PathToObject<PartB, PropertyValue> : Path extends `:${infer Param}?` ? {
+    [K in Param]?: PropertyValue;
+} : Path extends `:${infer Param}` ? {
+    [K in Param]: PropertyValue;
+} : Path extends `*${infer Wildcard}` ? {
+    [K in Wildcard]: PropertyValue[];
+} : {}>;
+type ParsedPathParams<Path extends string> = PathToObject<Path, ParsedPathParam>;
+type InputPathParams<Path extends string> = PathToObject<Path, InputPathParam>;
+interface RouteNavigateParams {
+    replace?: boolean;
+    state?: any;
+    query?: AnyObject;
+    mergeQuery?: boolean;
+}
+interface ParsedPathData<TPath extends string> {
+    path: string;
+    params: ParsedPathParams<TPath>;
+}
+
+/**
+ * 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>;
+    private isDestroyed?;
+    private disposer?;
+    protected history: History;
+    /**
+     * Parent route.
      *
-     * [**Documentation**](https://js2me.github.io/mobx-route/view-model/RouteViewModel#query)
+     * [**Documentation**](https://js2me.github.io/mobx-route/core/Route.html#parent)
      */
-    get query(): IQueryParams;
+    parent: TParentRoute;
+    query: IQueryParams;
+    private _tokenData;
+    private _matcher?;
+    private _compiler?;
+    private ignoreOpenByPathMatch;
+    private isUpdate;
+    private updateDisposer?;
+    protected status: 'opening' | 'closed' | 'open-rejected' | 'open-confirmed' | 'unknown';
+    meta?: AnyObject;
     /**
-     * Alias for `payload`.
+     * Route path pattern declaration.
      *
-     * [**Documentation**](https://js2me.github.io/mobx-route/view-model/RouteViewModel#pathparams)
+     * [**Documentation**](https://js2me.github.io/mobx-route/core/Route.html#pathdeclaration)
      */
-    get pathParams(): RouteParams<TRoute>;
+    pathDeclaration: TPath;
     /**
-     * Mounted state including the route opened status.
+     * Indicates if this route is an index route. Index routes activate when parent route path matches exactly.
+     *
+     * [**Documentation**](https://js2me.github.io/mobx-route/core/Route.html#isindex)
      */
-    get isMounted(): boolean;
+    isIndex: boolean;
+    /**
+     * Indicates if this route is an hash route.
+     *
+     * [**Documentation**](https://js2me.github.io/mobx-route/core/Route.html#ishash)
+     */
+    isHash: boolean;
+    /**
+     * Array of child routes.
+     *
+     * [**Documentation**](https://js2me.github.io/mobx-route/core/Route.html#children)
+     */
+    children: AnyRoute[];
+    constructor(pathDeclaration: TPath, config?: RouteConfiguration<TPath, TInputParams, TOutputParams, TParentRoute>);
+    protected get baseUrl(): string | undefined;
+    /**
+     * Checks whether current route matches provided path.
+     *
+     * [**Documentation**](https://js2me.github.io/mobx-route/core/Route.html#matchpath)
+     */
+    matchPath(path?: Maybe<string>): ParsedPathData<TPath> | null;
+    protected get parsedPathData(): ParsedPathData<TPath> | null;
+    /**
+     * [**Documentation**](https://js2me.github.io/mobx-route/core/Route.html#isopening)
+     *
+     * Also true in the short gap after history already matches this route but
+     * `confirmOpening` has not started yet (e.g. browser Back) — otherwise every
+     * route looks closed for one tick and RouteViewGroup unmounts the page.
+     */
+    get isOpening(): boolean;
+    /**
+     * Matched path segment for current URL.
+     *
+     * [**Documentation**](https://js2me.github.io/mobx-route/core/Route.html#path)
+     */
+    get path(): string | null;
+    /**
+     * Matched path segment for current URL with base URL.
+     *
+     * [**Documentation**](https://js2me.github.io/mobx-route/core/Route.html#absolutepath)
+     */
+    get absolutePath(): string | null;
+    /**
+     * Current parsed path parameters.
+     *
+     * [**Documentation**](https://js2me.github.io/mobx-route/core/Route.html#params)
+     */
+    get params(): TOutputParams | null;
+    protected get isPathMatched(): boolean;
+    /**
+     * Defines the "open" state for this route.
+     *
+     * [**Documentation**](https://js2me.github.io/mobx-route/core/Route.html#isopened)
+     */
+    get isOpened(): boolean;
+    /**
+     * Allows to create child route based on this route with merging this route path and extending path.
+     *
+     * [**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>;
+    /**
+     * Manually add child routes.
+     *
+     * [**Documentation**](https://js2me.github.io/mobx-route/core/Route.html#addchildren)
+     */
+    addChildren(...routes: AnyRoute[]): void;
+    /**
+     * Remove specified routes from children.
+     *
+     * [**Documentation**](https://js2me.github.io/mobx-route/core/Route.html#removechildren)
+     */
+    removeChildren(...routes: AnyRoute[]): void;
+    /**
+     * [**Documentation**](https://js2me.github.io/mobx-route/core/Route.html#hasopenedchildren)
+     */
+    get hasOpenedChildren(): boolean;
+    protected processParams(params?: TInputParams | null | undefined): ParamData | undefined;
+    /**
+     * Generates full route URL.
+     *
+     * [**Documentation**](https://js2me.github.io/mobx-route/core/Route.html#createurl)
+     */
+    createUrl(...args: IsPartial<TInputParams> extends true ? [
+        params?: Maybe<TInputParams>,
+        query?: Maybe<AnyObject>,
+        mergeQueryOrParams?: boolean | CreatedUrlOutputParams
+    ] : [
+        params: TInputParams,
+        query?: Maybe<AnyObject>,
+        mergeQueryOrParams?: boolean | CreatedUrlOutputParams
+    ]): string;
+    /**
+     * Navigates to this route.
+     *
+     * [**Documentation**](https://js2me.github.io/mobx-route/core/Route.html#open)
+     */
+    open(...args: IsPartial<TInputParams> extends true ? [
+        params?: TInputParams | null | undefined,
+        navigateParams?: RouteNavigateParams
+    ] : [params: TInputParams, navigateParams?: RouteNavigateParams]): Promise<void>;
+    open(...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>;
+    open(url: string, navigateParams?: RouteNavigateParams): Promise<void>;
+    open(url: string, replace?: RouteNavigateParams['replace'], query?: RouteNavigateParams['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,
+     * and defaults to `replace: true` instead of push.
+     *
+     * [**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>;
+    protected get tokenData(): TokenData;
+    protected confirmOpening(trx: NavigationTrx<TInputParams>): Promise<true | undefined>;
+    protected confirmClosing(): boolean;
+    private firstPathMatchingRun;
+    private checkPathMatch;
+    private get isAbleToMergeQuery();
+    /**
+     * Destroys route subscriptions and reactions.
+     *
+     * [**Documentation**](https://js2me.github.io/mobx-route/core/Route.html#destroy)
+     */
+    destroy(): void;
+}
+
+/**
+ * Global configuration for routes and router.
+ * @see [**Documentation**](https://js2me.github.io/mobx-route/core/routeConfig.html)
+ */
+interface RouteGlobalConfig {
+    /** @see [**Documentation**](https://js2me.github.io/mobx-route/core/routeConfig.html#history) */
+    history: History;
+    /** @see [**Documentation**](https://js2me.github.io/mobx-route/core/routeConfig.html#queryparams) */
+    queryParams: IQueryParams;
+    /** @see [**Documentation**](https://js2me.github.io/mobx-route/core/routeConfig.html#baseurl) */
+    baseUrl?: string;
+    /** @see [**Documentation**](https://js2me.github.io/mobx-route/core/routeConfig.html#mergequery) */
+    mergeQuery?: boolean;
+    /** @see [**Documentation**](https://js2me.github.io/mobx-route/core/routeConfig.html#createurl) */
+    createUrl?: UrlCreateParamsFn;
+    /** @see [**Documentation**](https://js2me.github.io/mobx-route/core/routeConfig.html#formatlinkhref) */
+    formatLinkHref?: (href: string) => string;
+    /** @see [**Documentation**](https://js2me.github.io/mobx-route/core/routeConfig.html#fallbackpath) */
+    fallbackPath?: string;
+}
+
+/**
+ * Public interface added by `withRouteViewModel` mixin.
+ */
+type RouteViewModelMixinPublic<TRoute extends AnyAbstractRouteEntity> = {
+    readonly route: TRoute;
+    _lastPayload: RouteParams<TRoute>;
+    payload: RouteParams<TRoute>;
+    query: IQueryParams;
+    pathParams: RouteParams<TRoute>;
+    isMounted: boolean;
+};
+/**
+ * Mixin function that enhances any `ViewModelBase` subclass with route-related properties.
+ *
+ * [**Documentation**](https://js2me.github.io/mobx-route/view-model/RouteViewModel)
+ *
+ * @param route - Route entity to bind to the view model.
+ * @returns A class enhancer that takes a base class and returns a new class with route properties.
+ *
+ * @example
+ * ```ts
+ * // With ViewModelBase directly
+ * class MyVM extends withRoute(someRoute)(ViewModelBase) {}
+ *
+ * // With a custom base class
+ * class ProductPageVM extends withRoute(productRoute)(AppVM) {}
+ * ```
+ */
+declare function withRoute<TRoute extends AnyAbstractRouteEntity>(route: TRoute): <TBase extends Class<ViewModel<any, any>>>(Base: TBase) => TBase & Class<InstanceType<TBase> & RouteViewModelMixinPublic<TRoute>>;
+/**
+ * Base class created by the mixin with a dummy route.
+ * Used internally by `RouteViewModel` to avoid duplicating the mixin logic.
+ */
+declare const _RouteViewModelBase: typeof ViewModelBase & Class<ViewModelBase<yummies_types.AnyObject, mobx_view_model.AnyViewModel | mobx_view_model.AnyViewModelSimple | null, yummies_types.AnyObject> & RouteViewModelMixinPublic<any>>;
+/**
+ * Abstract route-aware view model that extends `ViewModelBase<EmptyObject>`.
+ *
+ * Provides `route`, `payload`, `pathParams`, `query`, and `isMounted` properties.
+ * Subclasses must declare `route = someRoute`.
+ *
+ * [**Documentation**](https://js2me.github.io/mobx-route/view-model/RouteViewModel)
+ *
+ * @example
+ * ```ts
+ * class MyVM extends RouteViewModel<typeof myRoute> {
+ *   route = myRoute;
+ * }
+ * ```
+ */
+declare abstract class RouteViewModel<TRoute extends AnyAbstractRouteEntity = AnyAbstractRouteEntity> extends _RouteViewModelBase {
+    abstract readonly route: TRoute;
 }
 
-export { RouteViewModel };
+export { RouteViewModel, withRoute };

package/view-model.js

@@ -1,55 +1,70 @@
 import { computed } from "mobx";
-import { routeConfig } from "mobx-route";
 import { ViewModelBase, applyObservable } from "mobx-view-model";
+import { r as routeConfig } from "./virtual-route-fZzKp_7K.js";
 const annotations = [
   [computed.struct, "pathParams"],
   [computed, "query"]
 ];
-class RouteViewModel extends ViewModelBase {
-  /**
-   * Caches the latest known route params.
-   */
-  lastPayload = {};
-  constructor(params) {
-    super(params);
-    applyObservable(this, annotations, this.vmConfig.observable.viewModels);
-  }
-  /**
-   * Current route params with fallback to the last cached value.
-   */
-  get payload() {
-    if ("params" in this.route && this.route.params != null) {
-      this.lastPayload = this.route.params;
+function withRoute(route) {
+  return (Base) => {
+    class RouteViewModelMixin extends Base {
+      /**
+       * Route entity bound to this view model.
+       *
+       * [**Documentation**](https://js2me.github.io/mobx-route/view-model/RouteViewModel#route)
+       */
+      route = route;
+      /**
+       * Caches the latest known route params.
+       */
+      _lastPayload = {};
+      constructor(...args) {
+        super(...args);
+        applyObservable(this, annotations, this.vmConfig.observable.viewModels);
+      }
+      /**
+       * Current route params with fallback to the last cached value.
+       */
+      get payload() {
+        if ("params" in this.route && this.route.params != null) {
+          this._lastPayload = this.route.params;
+        }
+        return this._lastPayload;
+      }
+      /**
+       * Current query params from route or global route config.
+       *
+       * [**Documentation**](https://js2me.github.io/mobx-route/view-model/RouteViewModel#query)
+       */
+      get query() {
+        if ("query" in this.route) {
+          return this.route.query;
+        }
+        return routeConfig.get().queryParams;
+      }
+      /**
+       * Alias for `payload`.
+       *
+       * [**Documentation**](https://js2me.github.io/mobx-route/view-model/RouteViewModel#pathparams)
+       */
+      get pathParams() {
+        return this.payload;
+      }
+      /**
+       * Mounted state including the route opened status.
+       */
+      get isMounted() {
+        return super.isMounted && this.route.isOpened;
+      }
     }
-    return this.lastPayload;
-  }
-  /**
-   * Current query params from route or global route config.
-   *
-   * [**Documentation**](https://js2me.github.io/mobx-route/view-model/RouteViewModel#query)
-   */
-  get query() {
-    if ("query" in this.route) {
-      return this.route.query;
-    }
-    return routeConfig.get().queryParams;
-  }
-  /**
-   * Alias for `payload`.
-   *
-   * [**Documentation**](https://js2me.github.io/mobx-route/view-model/RouteViewModel#pathparams)
-   */
-  get pathParams() {
-    return this.payload;
-  }
-  /**
-   * Mounted state including the route opened status.
-   */
-  get isMounted() {
-    return super.isMounted && this.route.isOpened;
-  }
+    return RouteViewModelMixin;
+  };
+}
+const _RouteViewModelBase = withRoute({})(ViewModelBase);
+class RouteViewModel extends _RouteViewModelBase {
 }
 export {
-  RouteViewModel
+  RouteViewModel,
+  withRoute
 };
 //# sourceMappingURL=view-model.js.map

package/view-model.js.map

@@ -1 +1 @@
-{"version":3,"file":"view-model.js","sources":["../src/view-model/route-view-model.ts"],"sourcesContent":["import { computed } from 'mobx';\nimport {\n  type AnyAbstractRouteEntity,\n  type IQueryParams,\n  type RouteParams,\n  routeConfig,\n} from 'mobx-route';\nimport {\n  applyObservable,\n  ViewModelBase,\n  type ViewModelParams,\n} from 'mobx-view-model';\nimport type { ObservableAnnotationsArray } from 'yummies/mobx';\nimport type { EmptyObject } from 'yummies/types';\n\nconst annotations: ObservableAnnotationsArray<RouteViewModel<any>> = [\n  [computed.struct, 'pathParams'],\n  [computed, 'query'],\n];\n\nexport abstract class RouteViewModel<\n  TRoute extends AnyAbstractRouteEntity = AnyAbstractRouteEntity,\n> extends ViewModelBase<EmptyObject> {\n  /**\n   * Route entity bound to this view model.\n   *\n   * [**Documentation**](https://js2me.github.io/mobx-route/view-model/RouteViewModel#route)\n   */\n  abstract readonly route: TRoute;\n  /**\n   * Caches the latest known route params.\n   */\n  protected lastPayload: RouteParams<TRoute> = {} as any;\n\n  constructor(params: ViewModelParams<EmptyObject, any>) {\n    super(params);\n\n    applyObservable(this, annotations, this.vmConfig.observable.viewModels);\n  }\n\n  /**\n   * Current route params with fallback to the last cached value.\n   */\n  override get payload(): RouteParams<TRoute> {\n    if ('params' in this.route && this.route.params != null) {\n      this.lastPayload = this.route.params as RouteParams<TRoute>;\n    }\n\n    return this.lastPayload;\n  }\n\n  /**\n   * Current query params from route or global route config.\n   *\n   * [**Documentation**](https://js2me.github.io/mobx-route/view-model/RouteViewModel#query)\n   */\n  get query(): IQueryParams {\n    if ('query' in this.route) {\n      return this.route.query as IQueryParams;\n    }\n\n    return routeConfig.get().queryParams;\n  }\n\n  /**\n   * Alias for `payload`.\n   *\n   * [**Documentation**](https://js2me.github.io/mobx-route/view-model/RouteViewModel#pathparams)\n   */\n  get pathParams() {\n    return this.payload;\n  }\n\n  /**\n   * Mounted state including the route opened status.\n   */\n  get isMounted() {\n    return super.isMounted && this.route.isOpened;\n  }\n}\n"],"names":[],"mappings":";;;AAeA,MAAM,cAA+D;AAAA,EACnE,CAAC,SAAS,QAAQ,YAAY;AAAA,EAC9B,CAAC,UAAU,OAAO;AACpB;AAEO,MAAe,uBAEZ,cAA2B;AAAA;AAAA;AAAA;AAAA,EAUzB,cAAmC,CAAA;AAAA,EAE7C,YAAY,QAA2C;AACrD,UAAM,MAAM;AAEZ,oBAAgB,MAAM,aAAa,KAAK,SAAS,WAAW,UAAU;AAAA,EACxE;AAAA;AAAA;AAAA;AAAA,EAKA,IAAa,UAA+B;AAC1C,QAAI,YAAY,KAAK,SAAS,KAAK,MAAM,UAAU,MAAM;AACvD,WAAK,cAAc,KAAK,MAAM;AAAA,IAChC;AAEA,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,IAAI,QAAsB;AACxB,QAAI,WAAW,KAAK,OAAO;AACzB,aAAO,KAAK,MAAM;AAAA,IACpB;AAEA,WAAO,YAAY,MAAM;AAAA,EAC3B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,IAAI,aAAa;AACf,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA,EAKA,IAAI,YAAY;AACd,WAAO,MAAM,aAAa,KAAK,MAAM;AAAA,EACvC;AACF;"}
+{"version":3,"file":"view-model.js","sources":["../src/view-model/route-view-model.ts"],"sourcesContent":["import { computed } from 'mobx';\nimport type { IQueryParams } from 'mobx-location-history';\nimport {\n  applyObservable,\n  type ViewModel,\n  ViewModelBase,\n} from 'mobx-view-model';\nimport type { ObservableAnnotationsArray } from 'yummies/mobx';\nimport type { Class } from 'yummies/types';\nimport {\n  type AnyAbstractRouteEntity,\n  type RouteParams,\n  routeConfig,\n} from '../core/index.js';\n\nconst annotations: ObservableAnnotationsArray<any> = [\n  [computed.struct, 'pathParams'],\n  [computed, 'query'],\n];\n\n/**\n * Public interface added by `withRouteViewModel` mixin.\n */\ntype RouteViewModelMixinPublic<TRoute extends AnyAbstractRouteEntity> = {\n  readonly route: TRoute;\n  _lastPayload: RouteParams<TRoute>;\n  payload: RouteParams<TRoute>;\n  query: IQueryParams;\n  pathParams: RouteParams<TRoute>;\n  isMounted: boolean;\n};\n\n/**\n * Mixin function that enhances any `ViewModelBase` subclass with route-related properties.\n *\n * [**Documentation**](https://js2me.github.io/mobx-route/view-model/RouteViewModel)\n *\n * @param route - Route entity to bind to the view model.\n * @returns A class enhancer that takes a base class and returns a new class with route properties.\n *\n * @example\n * ```ts\n * // With ViewModelBase directly\n * class MyVM extends withRoute(someRoute)(ViewModelBase) {}\n *\n * // With a custom base class\n * class ProductPageVM extends withRoute(productRoute)(AppVM) {}\n * ```\n */\nexport function withRoute<TRoute extends AnyAbstractRouteEntity>(\n  route: TRoute,\n) {\n  return <TBase extends Class<ViewModel<any, any>>>(\n    Base: TBase,\n  ): TBase & Class<InstanceType<TBase> & RouteViewModelMixinPublic<TRoute>> => {\n    class RouteViewModelMixin extends Base {\n      /**\n       * Route entity bound to this view model.\n       *\n       * [**Documentation**](https://js2me.github.io/mobx-route/view-model/RouteViewModel#route)\n       */\n      readonly route: TRoute = route;\n\n      /**\n       * Caches the latest known route params.\n       */\n      _lastPayload: RouteParams<TRoute> = {} as RouteParams<TRoute>;\n\n      constructor(...args: any[]) {\n        super(...args);\n\n        applyObservable(this, annotations, this.vmConfig.observable.viewModels);\n      }\n\n      /**\n       * Current route params with fallback to the last cached value.\n       */\n      override get payload(): RouteParams<TRoute> {\n        if ('params' in this.route && this.route.params != null) {\n          this._lastPayload = this.route.params as RouteParams<TRoute>;\n        }\n\n        return this._lastPayload;\n      }\n\n      /**\n       * Current query params from route or global route config.\n       *\n       * [**Documentation**](https://js2me.github.io/mobx-route/view-model/RouteViewModel#query)\n       */\n      get query(): IQueryParams {\n        if ('query' in this.route) {\n          return this.route.query as IQueryParams;\n        }\n\n        return routeConfig.get().queryParams;\n      }\n\n      /**\n       * Alias for `payload`.\n       *\n       * [**Documentation**](https://js2me.github.io/mobx-route/view-model/RouteViewModel#pathparams)\n       */\n      get pathParams() {\n        return this.payload;\n      }\n\n      /**\n       * Mounted state including the route opened status.\n       */\n      override get isMounted() {\n        return super.isMounted && this.route.isOpened;\n      }\n    }\n\n    return RouteViewModelMixin as any;\n  };\n}\n\n/**\n * Base class created by the mixin with a dummy route.\n * Used internally by `RouteViewModel` to avoid duplicating the mixin logic.\n */\nconst _RouteViewModelBase = withRoute({} as any)(ViewModelBase);\n\n/**\n * Abstract route-aware view model that extends `ViewModelBase<EmptyObject>`.\n *\n * Provides `route`, `payload`, `pathParams`, `query`, and `isMounted` properties.\n * Subclasses must declare `route = someRoute`.\n *\n * [**Documentation**](https://js2me.github.io/mobx-route/view-model/RouteViewModel)\n *\n * @example\n * ```ts\n * class MyVM extends RouteViewModel<typeof myRoute> {\n *   route = myRoute;\n * }\n * ```\n */\nexport abstract class RouteViewModel<\n  TRoute extends AnyAbstractRouteEntity = AnyAbstractRouteEntity,\n> extends _RouteViewModelBase {\n  abstract override readonly route: TRoute;\n}\n"],"names":[],"mappings":";;;AAeA,MAAM,cAA+C;AAAA,EACnD,CAAC,SAAS,QAAQ,YAAY;AAAA,EAC9B,CAAC,UAAU,OAAO;AACpB;AA+BO,SAAS,UACd,OACA;AACA,SAAO,CACL,SAC2E;AAAA,IAC3E,MAAM,4BAA4B,KAAK;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAM5B,QAAgB;AAAA;AAAA;AAAA;AAAA,MAKzB,eAAoC,CAAA;AAAA,MAEpC,eAAe,MAAa;AAC1B,cAAM,GAAG,IAAI;AAEb,wBAAgB,MAAM,aAAa,KAAK,SAAS,WAAW,UAAU;AAAA,MACxE;AAAA;AAAA;AAAA;AAAA,MAKA,IAAa,UAA+B;AAC1C,YAAI,YAAY,KAAK,SAAS,KAAK,MAAM,UAAU,MAAM;AACvD,eAAK,eAAe,KAAK,MAAM;AAAA,QACjC;AAEA,eAAO,KAAK;AAAA,MACd;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAOA,IAAI,QAAsB;AACxB,YAAI,WAAW,KAAK,OAAO;AACzB,iBAAO,KAAK,MAAM;AAAA,QACpB;AAEA,eAAO,YAAY,MAAM;AAAA,MAC3B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAOA,IAAI,aAAa;AACf,eAAO,KAAK;AAAA,MACd;AAAA;AAAA;AAAA;AAAA,MAKA,IAAa,YAAY;AACvB,eAAO,MAAM,aAAa,KAAK,MAAM;AAAA,MACvC;AAAA,IAAA;AAGF,WAAO;AAAA,EACT;AACF;AAMA,MAAM,sBAAsB,UAAU,EAAS,EAAE,aAAa;AAiBvD,MAAe,uBAEZ,oBAAoB;AAE9B;"}