@ngrdt/router 0.0.23 → 0.0.24

package/index.d.ts

@@ -1,12 +1,13 @@
 import * as i0 from '@angular/core';
 import { Type, Injector, InjectionToken, OnInit, OnChanges, SimpleChanges, DestroyRef } from '@angular/core';
 import * as i1 from '@angular/router';
-import { LoadChildrenCallback, Route, ResolveFn, CanActivateFn, CanDeactivateFn, CanActivateChildFn, RunGuardsAndResolvers, Params, Data, NavigationEnd, IsActiveMatchOptions, Router } from '@angular/router';
+import { LoadChildrenCallback, Route, ResolveFn, CanActivateFn, CanDeactivateFn, CanActivateChildFn, RunGuardsAndResolvers, Data, Params, NavigationEnd, IsActiveMatchOptions, Router } from '@angular/router';
 import { Observable } from 'rxjs';
 
 declare class RdtAngularRoute<T extends object> {
     private route;
     private children;
+    private loadComponent?;
     private loadChildren?;
     private component?;
     private providers;
@@ -18,6 +19,7 @@ declare class RdtAngularRoute<T extends object> {
     private data?;
     constructor(route: RdtRoute<T>);
     provide(...providers: Type<unknown>[]): this;
+    withLazyComponent(callback: LoadComponentCallback): this;
     withModule(callback: LoadChildrenCallback): this;
     /**
      * @deprecated Use withModule() instead.
@@ -47,24 +49,34 @@ declare class RdtAngularRoute<T extends object> {
     private checkChildrenMatch;
 }
 
-declare function ALWAYS_TRUE(): boolean;
-declare class RdtRoute<T extends object = any> {
-    protected orderedParams: string[];
+declare class RdtRouteBase<T extends object> {
+    protected _orderedParams: string[];
     protected _paramMap: ParamTypeMap<T>;
     protected _regex: RegExp | null;
-    protected paramMappings: ParamMapping[];
-    protected _staticParams: Partial<T>;
-    protected _queryParams: Params;
-    protected _stateParams: Params;
-    protected _data: Data;
+    protected _paramMappings: ParamMapping[];
     protected _name: string;
     protected _path: string;
     protected _parent: RdtRoute | null;
     protected _children: RdtRoute[];
     protected _entryDisabled: boolean;
     protected _canBeEntered: () => boolean;
-    protected _built: boolean;
-    private _absoluteRegex?;
+    protected _data: Data;
+    /**
+     * Data that is passed to Angular route definition.
+     */
+    get data(): Data;
+    /**
+     * Regular expression route path relative to parent route.
+     * Hostname excluded.
+     */
+    get regex(): RegExp | null;
+    /**
+     * Denotes disabled route entry.
+     * If true, route should have no NgModule
+     * or component and only serves as virtual module
+     * for breadcrumb.
+     */
+    get entryDisabled(): boolean;
     /**
      * Map of parameters and their types.
      */
@@ -85,6 +97,87 @@ declare class RdtRoute<T extends object = any> {
      * Child routes.
      */
     get children(): RdtRoute<any>[];
+}
+
+declare class RdtRouteBuilder<T extends object = any> extends RdtRouteBase<T> {
+    get canBeEntered(): () => boolean;
+    get orderedParams(): string[];
+    get paramMappings(): ParamMapping[];
+    /**
+     * CanBeEntered function is synchronous function which
+     * lets framework hide menu buttons and disable links.
+     * Function is run in environment injection context, so
+     * you can inject global services, tokens, etc.
+     * @param fn
+     */
+    withCanBeEntered(fn: () => boolean): this;
+    /**
+     * @deprecated Use withCanBeEntered() instead.
+     */
+    setCanBeEntered(fn: () => boolean): this;
+    /**
+     * Entry disabled route will generate disabled breadcrumb.
+     * It should not have any component nor module added to it.
+     * @param value
+     * @returns
+     */
+    withEntryDisabled(value?: boolean): this;
+    /**
+     * @deprecated Use withEntryDisabled() instead.
+     */
+    setEntryDisabled(value?: boolean): this;
+    /**
+     * Sets path relative to parent. It is defined the same way as Angular route path including parameters.
+     * You need to call setParam() for each parameter you use in the path.
+     */
+    withPath(path: string): this;
+    /**
+     * @deprecated Use withPath() instead.
+     */
+    setPath(path: string): this;
+    /**
+     * Sets Angular route data.
+     * @param data Angular route data object. Breadcrumb key is merged into it.
+     */
+    withData(data: Data): this;
+    /**
+     * @deprecated Use withData() instead.
+     */
+    setData(data: Data): this;
+    /**
+     * Defines parameter type and lets framework parse it.
+     * @param paramName
+     * @param type
+     */
+    withParam(paramName: keyof T, type: 'string' | 'number'): this;
+    /**
+     * @deprecated Use withParam() instead.
+     */
+    setParam(paramName: keyof T, type: 'string' | 'number'): this;
+    /**
+     * Sets name to display in breadcrumb, etc.
+     */
+    withName(name: string): this;
+    /**
+     * @deprecated Use withName() instead.
+     */
+    setName(name: string): this;
+    /**
+     * Call .build() on children before you call this method!
+     */
+    withChildren(...children: RdtRoute[]): this;
+    /**
+     * @deprecated Use withChildren() instead.
+     */
+    setChildren(...children: RdtRoute[]): this;
+    build(): RdtRoute<T>;
+}
+
+declare class RdtRoute<T extends object = any> extends RdtRouteBase<T> {
+    private _absoluteRegex?;
+    protected _staticParams: Partial<T>;
+    protected _queryParams: Params;
+    protected _stateParams: Params;
     /**
      * Absolute path of parent route or '/' if there is no parent.
      * Hostname excluded.
@@ -94,23 +187,11 @@ declare class RdtRoute<T extends object = any> {
      * Absolute path of the route. Hostname excluded.
      */
     get absolutePath(): string;
-    /**
-     * Regular expression route path relative to parent route.
-     * Hostname excluded.
-     */
-    get regex(): RegExp | null;
     /**
      * Regular expression to match only this route (not children
      * or parent routes). Hostname excluded.
      */
     get absoluteRegex(): RegExp;
-    /**
-     * Denotes disabled route entry.
-     * If true, route should have no NgModule
-     * or component and only serves as virtual module
-     * for breadcrumb.
-     */
-    get entryDisabled(): boolean;
     /**
      * Statically set state params used when navigating to this instance.
      */
@@ -129,10 +210,6 @@ declare class RdtRoute<T extends object = any> {
      */
     get staticParams(): Partial<T>;
     get hasCanBeEnteredGuard(): boolean;
-    /**
-     * Data that is passed to Angular route definition.
-     */
-    get data(): Data;
     /**
      * Meta guard that is used by [rdtRouterLink] and RdtMenu
      * to determine if route can be entered.
@@ -180,6 +257,9 @@ declare class RdtRoute<T extends object = any> {
      * this route and its parents (NOT children).
      */
     clone(): RdtRoute<T>;
+    private setRegex;
+    static fromBuilder<T extends object>(builder: RdtRouteBuilder<T>): RdtRoute<T>;
+    private static readonly groups;
 }
 
 type ParamTypeMap<T> = {
@@ -199,6 +279,7 @@ declare class RdtReadonlyParameters {
     constructor(params?: StaticRouteParams);
     get<T extends object>(route: RdtRoute<T>): Partial<T> | null;
 }
+type LoadComponentCallback = Route['loadComponent'];
 
 /**
  * Injection token that defines behavior when route cannot be entered (canBeEntered returns false).
@@ -277,79 +358,6 @@ declare enum RdtNavigationSource {
     BREADCRUMB = "breadcrumb"
 }
 
-declare class RdtRouteBuilder<T extends object = any> extends RdtRoute<T> {
-    /**
-     * CanBeEntered function is synchronous function which
-     * lets framework hide menu buttons and disable links.
-     * Function is run in environment injection context, so
-     * you can inject global services, tokens, etc.
-     * @param fn
-     */
-    withCanBeEntered(fn: () => boolean): this;
-    /**
-     * @deprecated Use withCanBeEntered() instead.
-     */
-    setCanBeEntered(fn: () => boolean): this;
-    /**
-     * Entry disabled route will generate disabled breadcrumb.
-     * It should not have any component nor module added to it.
-     * @param value
-     * @returns
-     */
-    withEntryDisabled(value?: boolean): this;
-    /**
-     * @deprecated Use withEntryDisabled() instead.
-     */
-    setEntryDisabled(value?: boolean): this;
-    /**
-     * Sets path relative to parent. It is defined the same way as Angular route path including parameters.
-     * You need to call setParam() for each parameter you use in the path.
-     */
-    withPath(path: string): this;
-    /**
-     * @deprecated Use withPath() instead.
-     */
-    setPath(path: string): this;
-    /**
-     * Sets Angular route data.
-     * @param data Angular route data object. Breadcrumb key is merged into it.
-     */
-    withData(data: Data): this;
-    /**
-     * @deprecated Use withData() instead.
-     */
-    setData(data: Data): this;
-    /**
-     * Defines parameter type and lets framework parse it.
-     * @param paramName
-     * @param type
-     */
-    withParam(paramName: keyof T, type: 'string' | 'number'): this;
-    /**
-     * @deprecated Use withParam() instead.
-     */
-    setParam(paramName: keyof T, type: 'string' | 'number'): this;
-    /**
-     * Sets name to display in breadcrumb, etc.
-     */
-    withName(name: string): this;
-    /**
-     * @deprecated Use withName() instead.
-     */
-    setName(name: string): this;
-    /**
-     * Call .build() on children before you call this method!
-     */
-    withChildren(...children: RdtRoute[]): this;
-    /**
-     * @deprecated Use withChildren() instead.
-     */
-    setChildren(...children: RdtRoute[]): this;
-    build(): RdtRoute<T>;
-    private setRegex;
-    private static readonly groups;
-}
-
 /**
  * Directive that appends class to host if any of the watched routes is active.
  */
@@ -430,5 +438,5 @@ declare class GlobalRouteGuardService {
 
 declare const preventDataLossGuardFn: CanDeactivateFn<any>;
 
-export { ALWAYS_TRUE, GlobalRouteGuardService, PERMISSION_DISABLED_KEY, RDT_CANNOT_BE_ENTERED_PROVIDER, RDT_CONFIRM_DATA_LOSS_SERVICE, RDT_ROUTES_PROVIDER, RdtAngularRoute, RdtAnyRouteActiveDirective, RdtBackLinkDirective, RdtConfirmDataLossService, RdtConfirmDataLossServiceAlert, RdtNavigationSource, RdtRoute, RdtRouteBuilder, RdtRouterLinkDirective, RdtRouterService, preventDataLossGuardFn };
+export { GlobalRouteGuardService, PERMISSION_DISABLED_KEY, RDT_CANNOT_BE_ENTERED_PROVIDER, RDT_CONFIRM_DATA_LOSS_SERVICE, RDT_ROUTES_PROVIDER, RdtAngularRoute, RdtAnyRouteActiveDirective, RdtBackLinkDirective, RdtConfirmDataLossService, RdtConfirmDataLossServiceAlert, RdtNavigationSource, RdtRoute, RdtRouteBuilder, RdtRouterLinkDirective, RdtRouterService, preventDataLossGuardFn };
 export type { RdtNavigateExtras };

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@ngrdt/router",
-  "version": "0.0.23",
+  "version": "0.0.24",
   "peerDependencies": {
     "@angular/common": ">=18.2.0",
     "@angular/core": ">=18.2.0",
     "@angular/router": ">=18.2.0",
     "rxjs": ">=7.0.0",
-    "@ngrdt/utils": "^0.0.23",
-    "@ngrdt/core": "^0.0.23",
-    "@ngrdt/button": "^0.0.23"
+    "@ngrdt/utils": "^0.0.24",
+    "@ngrdt/core": "^0.0.24",
+    "@ngrdt/button": "^0.0.24"
   },
   "sideEffects": false,
   "module": "fesm2022/ngrdt-router.mjs",