@ngrdt/router 0.0.95 → 0.0.96

package/index.d.ts

@@ -2,6 +2,7 @@ import * as i0 from '@angular/core';
 import { Provider, EnvironmentProviders, Type, Injector, InjectionToken, OnInit, OnChanges, SimpleChanges, DestroyRef } from '@angular/core';
 import * as i1 from '@angular/router';
 import { LoadChildrenCallback, Route, ResolveFn, CanActivateFn, CanDeactivateFn, CanActivateChildFn, RunGuardsAndResolvers, Data, Params, NavigationEnd, IsActiveMatchOptions, Router } from '@angular/router';
+import * as _ngrdt_router from '@ngrdt/router';
 import { Observable } from 'rxjs';
 
 declare class RdtAngularRoute<T extends object> {
@@ -62,7 +63,7 @@ declare class RdtRouteBase<T extends object> {
     protected _parent: RdtRoute | null;
     protected _children: RdtRoute[];
     protected _entryDisabled: boolean;
-    protected _canBeEntered: () => boolean;
+    protected _canBeEntered: RdtCanBeEnteredFn<T>;
     protected _data: Data;
     /**
      * Data that is passed to Angular route definition.
@@ -103,7 +104,7 @@ declare class RdtRouteBase<T extends object> {
 }
 
 declare class RdtRouteBuilder<T extends object = any> extends RdtRouteBase<T> {
-    get canBeEntered(): () => boolean;
+    get canBeEntered(): RdtCanBeEnteredFn<T>;
     get orderedParams(): string[];
     get paramMappings(): ParamMapping[];
     /**
@@ -113,11 +114,11 @@ declare class RdtRouteBuilder<T extends object = any> extends RdtRouteBase<T> {
      * you can inject global services, tokens, etc.
      * @param fn
      */
-    withCanBeEntered(fn: () => boolean): this;
+    withCanBeEntered(fn: RdtCanBeEnteredFn<T>): this;
     /**
      * @deprecated Use withCanBeEntered() instead.
      */
-    setCanBeEntered(fn: () => boolean): this;
+    setCanBeEntered(fn: RdtCanBeEnteredFn<T>): this;
     /**
      * Entry disabled route will generate disabled breadcrumb.
      * It should not have any component nor module added to it.
@@ -217,13 +218,15 @@ declare class RdtRoute<T extends object = any> extends RdtRouteBase<T> {
      * Meta guard that is used by [rdtRouterLink] and RdtMenu
      * to determine if route can be entered.
      * @param injector Environment or custom injector.
+     * @param params Optional parameters to pass to guard function.
      * @returns True if route can be entered.
      */
-    canBeEntered(injector?: Injector): boolean;
+    canBeEntered(injector?: Injector, combinedParams?: Partial<RdtCombinedRouteParams<T>>): boolean;
+    get canBeEnteredFn(): _ngrdt_router.RdtCanBeEnteredFn<T>;
     /**
      * Extracts url parameters from absolute path for this path and each parent.
      */
-    parseAbsoluteUrl(url: string): RdtParameters | null;
+    parseAbsoluteUrl(url: string): RdtCombinedRouteParams<T> | null;
     private fill;
     /**
      * Fills parameters in path with values from paramMap.
@@ -255,6 +258,7 @@ declare class RdtRoute<T extends object = any> extends RdtRouteBase<T> {
      * @returns Partial of object that only contains properties necessary to create this route.
      */
     extractRouteParams(row: T): Partial<T>;
+    getStaticParams(): RdtParameters;
     /**
      * @returns New instance of RdtRoute<T> that is clone of
      * this route and its parents (NOT children).
@@ -282,9 +286,18 @@ declare class RdtParameters {
     constructor(params?: StaticRouteParams);
     get<T extends object>(route: RdtRoute<T>): Partial<T> | null;
     set<T extends object>(route: RdtRoute<T>, params: Partial<T>): this;
+    append<T extends object>(route: RdtRoute<T>, params: Partial<T>): this;
+    setAll(params: RdtParameters): this;
     [Symbol.iterator](): Generator<(string | object)[], void, unknown>;
 }
 type LoadComponentCallback = Route['loadComponent'];
+type RdtCanBeEnteredFn<T extends object> = (route: RdtRoute<T>, params: RdtCombinedRouteParams<T>) => boolean;
+interface RdtCombinedRouteParams<T extends object> {
+    params: Partial<T>;
+    route: RdtParameters;
+    query: Params;
+    state: Params;
+}
 
 /**
  * Injection token that defines behavior when route cannot be entered (canBeEntered returns false).
@@ -317,11 +330,11 @@ declare class RdtRouterService {
     get currentUrl(): string | null;
     parsePreviousUrl(): {
         route: RdtRoute<any>;
-        params: RdtParameters;
+        params: RdtCombinedRouteParams<any>;
     } | null;
     parseCurrentUrl(): {
         route: RdtRoute<any>;
-        params: RdtParameters;
+        params: RdtCombinedRouteParams<any>;
     } | null;
     readonly navigationEnd$: Observable<NavigationEnd>;
     readonly nextNavigationEnd$: Observable<NavigationEnd>;
@@ -348,9 +361,9 @@ declare class RdtRouterService {
      */
     parseAbsoluteUrl(url?: string): {
         route: RdtRoute<any>;
-        params: RdtParameters;
+        params: RdtCombinedRouteParams<any>;
     } | null;
-    extractAllParams(currentRoute?: RdtRoute): RdtParameters | null;
+    extractAllParams(currentRoute?: RdtRoute): RdtCombinedRouteParams<any> | null;
     isParentOfCurrentLocation(route: RdtRoute): boolean;
     removeQueryParams(...paramNames: string[]): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<RdtRouterService, never>;
@@ -419,6 +432,7 @@ declare class RdtRouterLinkDirective<T extends object> {
     readonly queryParams: i0.InputSignal<Params | undefined>;
     readonly stateParams: i0.InputSignal<Params | undefined>;
     readonly disabled: i0.InputSignalWithTransform<boolean, unknown>;
+    readonly canBeEntered: i0.Signal<boolean>;
     protected readonly updateEffect: i0.EffectRef;
     private updateButton;
     private setButtonLink;
@@ -445,4 +459,4 @@ declare class GlobalRouteGuardService {
 declare const preventDataLossGuardFn: CanDeactivateFn<any>;
 
 export { GlobalRouteGuardService, PERMISSION_DISABLED_KEY, RDT_CANNOT_BE_ENTERED_PROVIDER, RDT_CONFIRM_DATA_LOSS_SERVICE, RDT_ROUTES_PROVIDER, RdtAngularRoute, RdtAnyRouteActiveDirective, RdtBackLinkDirective, RdtConfirmDataLossService, RdtConfirmDataLossServiceAlert, RdtNavigationSource, RdtParameters, RdtRoute, RdtRouteBuilder, RdtRouterLinkDirective, RdtRouterService, preventDataLossGuardFn };
-export type { RdtNavigateExtras };
+export type { RdtCanBeEnteredFn, RdtNavigateExtras };

package/package.json

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