@dereekb/dbx-core 13.4.1 → 13.4.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -750,6 +750,7 @@ declare abstract class DbxActionContextBaseSource<T = unknown, O = unknown> impl
750
750
  readyValue(value: T | Observable<T>): void;
751
751
  /**
752
752
  * Triggers the context and then readies the value.
753
+ *
753
754
  * @param value
754
755
  */
755
756
  triggerWithValue(value: T | Observable<T>): void;
@@ -882,12 +883,14 @@ declare abstract class ActionContextStoreSourceMap<T = unknown, O = unknown> imp
882
883
  abstract sourceForKey(key: ActionKey): ActionContextStoreSource<T, O>;
883
884
  /**
884
885
  * Adds the store source for the input key.
886
+ *
885
887
  * @param key Action key to add the source for.
886
888
  * @param source Store source to add.
887
889
  */
888
890
  abstract addStoreSource(key: ActionKey, source: ActionContextStoreSource<T, O>): void;
889
891
  /**
890
892
  * Removes the store source for the input key.
893
+ *
891
894
  * @param key Action key to remove the source for.
892
895
  */
893
896
  abstract removeStoreSource(key: ActionKey): void;
@@ -2210,11 +2213,17 @@ type AuthTransitionDecision = true | false | SegueRefOrSegueRefRouterLink;
2210
2213
  * for making authorization decisions.
2211
2214
  */
2212
2215
  interface AuthTransitionDecisionGetterInput {
2213
- /** The UIRouter transition that triggered the auth check. */
2216
+ /**
2217
+ * The UIRouter transition that triggered the auth check.
2218
+ */
2214
2219
  readonly transition: Transition;
2215
- /** The Angular injector for resolving additional dependencies. */
2220
+ /**
2221
+ * The Angular injector for resolving additional dependencies.
2222
+ */
2216
2223
  readonly injector: Injector;
2217
- /** The auth service for querying the current authentication state. */
2224
+ /**
2225
+ * The auth service for querying the current authentication state.
2226
+ */
2218
2227
  readonly authService: DbxAuthService;
2219
2228
  }
2220
2229
  /**
@@ -2624,7 +2633,7 @@ declare const DBX_KNOWN_APP_CONTEXT_STATES: DbxKnownAppContextState[];
2624
2633
  /**
2625
2634
  * The feature key for these items/reducers.
2626
2635
  */
2627
- declare const dbxAppContextStateFeatureKey = "data";
2636
+ declare const DBX_APP_CONTEXT_STATE_FEATURE_KEY = "data";
2628
2637
  /**
2629
2638
  * The typings for this feature.
2630
2639
  */
@@ -2635,21 +2644,25 @@ interface DbxAppContextStateData {
2635
2644
  /**
2636
2645
  * Global feature key for our app.
2637
2646
  */
2638
- declare const featureKey$1 = "app.context";
2647
+ declare const FEATURE_KEY$1 = "app.context";
2639
2648
  /**
2640
2649
  * This is a "feature state", which in this case is a single feature (our app state), but could include keys/states within this feature.
2641
2650
  */
2642
2651
  interface DbxAppContextFeatureState {
2643
- [dbxAppContextStateFeatureKey]: DbxAppContextStateData;
2652
+ [DBX_APP_CONTEXT_STATE_FEATURE_KEY]: DbxAppContextStateData;
2644
2653
  }
2645
2654
  /**
2646
2655
  * Interface typing extension for the DbxAppContextFeatureState, and the typing information for how this feature extends the base state.
2647
2656
  */
2648
2657
  interface State$1 {
2649
- [featureKey$1]: DbxAppContextFeatureState;
2658
+ [FEATURE_KEY$1]: DbxAppContextFeatureState;
2650
2659
  }
2651
2660
  /**
2652
2661
  * Reducers mapping for the DbxAppContextFeatureState
2662
+ *
2663
+ * @param state - The current feature state, or undefined for initialization.
2664
+ * @param action - The dispatched action to reduce.
2665
+ * @returns The updated feature state.
2653
2666
  */
2654
2667
  declare function reducers$1(state: DbxAppContextFeatureState | undefined, action: Action): {
2655
2668
  data: DbxAppContextStateData;
@@ -2669,7 +2682,7 @@ type index_d$3_DbxAppContextFeatureState = DbxAppContextFeatureState;
2669
2682
  declare const index_d$3_selectAppContextFeature: typeof selectAppContextFeature;
2670
2683
  declare const index_d$3_selectDbxAppContextState: typeof selectDbxAppContextState;
2671
2684
  declare namespace index_d$3 {
2672
- export { featureKey$1 as featureKey, reducers$1 as reducers, index_d$3_selectAppContextFeature as selectAppContextFeature, index_d$3_selectDbxAppContextState as selectDbxAppContextState };
2685
+ export { FEATURE_KEY$1 as FEATURE_KEY, reducers$1 as reducers, index_d$3_selectAppContextFeature as selectAppContextFeature, index_d$3_selectDbxAppContextState as selectDbxAppContextState };
2673
2686
  export type { index_d$3_DbxAppContextFeatureState as DbxAppContextFeatureState, State$1 as State };
2674
2687
  }
2675
2688
 
@@ -2829,7 +2842,7 @@ declare abstract class AbstractOnDbxAppContextStateEffects<S = unknown> implemen
2829
2842
  /**
2830
2843
  * NgRx feature key for the auth user sub-state within the auth feature.
2831
2844
  */
2832
- declare const dbxAppAuthUserFeatureKey = "user";
2845
+ declare const DBX_APP_AUTH_USER_FEATURE_KEY = "user";
2833
2846
  /**
2834
2847
  * Shape of the authenticated user's state stored in the NgRx store.
2835
2848
  *
@@ -2850,13 +2863,21 @@ declare const dbxAppAuthUserFeatureKey = "user";
2850
2863
  * @see {@link AuthUserState} for possible values of `userState`.
2851
2864
  */
2852
2865
  interface DbxAppAuthStateUser {
2853
- /** Unique identifier for the authenticated user. Defaults to {@link NO_AUTH_USER_IDENTIFIER} when no user is logged in. */
2866
+ /**
2867
+ * Unique identifier for the authenticated user. Defaults to {@link NO_AUTH_USER_IDENTIFIER} when no user is logged in.
2868
+ */
2854
2869
  userId: AuthUserIdentifier;
2855
- /** Whether the user has completed the onboarding/setup flow. */
2870
+ /**
2871
+ * Whether the user has completed the onboarding/setup flow.
2872
+ */
2856
2873
  isOnboarded: boolean;
2857
- /** Current authentication lifecycle state of the user. */
2874
+ /**
2875
+ * Current authentication lifecycle state of the user.
2876
+ */
2858
2877
  userState: AuthUserState;
2859
- /** Array of authorization roles assigned to the current user. */
2878
+ /**
2879
+ * Array of authorization roles assigned to the current user.
2880
+ */
2860
2881
  userRoles: AuthRole[];
2861
2882
  }
2862
2883
 
@@ -2865,7 +2886,7 @@ interface DbxAppAuthStateUser {
2865
2886
  *
2866
2887
  * The auth state is registered under `'app.auth'` in the root NgRx state tree.
2867
2888
  */
2868
- declare const featureKey = "app.auth";
2889
+ declare const FEATURE_KEY = "app.auth";
2869
2890
  /**
2870
2891
  * Shape of the auth feature state slice, containing all auth-related sub-states.
2871
2892
  *
@@ -2875,7 +2896,7 @@ declare const featureKey = "app.auth";
2875
2896
  * @see {@link DbxAppAuthStateUser} for the user sub-state shape.
2876
2897
  */
2877
2898
  interface DbxAppAuthFeatureState {
2878
- [dbxAppAuthUserFeatureKey]: DbxAppAuthStateUser;
2899
+ [DBX_APP_AUTH_USER_FEATURE_KEY]: DbxAppAuthStateUser;
2879
2900
  }
2880
2901
  /**
2881
2902
  * Root state interface extension that declares how the auth feature integrates into the global NgRx store.
@@ -2886,7 +2907,7 @@ interface DbxAppAuthFeatureState {
2886
2907
  * @see {@link DbxAppAuthFullState} for the public alias of this type.
2887
2908
  */
2888
2909
  interface State {
2889
- [featureKey]: DbxAppAuthFeatureState;
2910
+ [FEATURE_KEY]: DbxAppAuthFeatureState;
2890
2911
  }
2891
2912
  /**
2892
2913
  * Combined reducer function for the auth feature state.
@@ -2915,13 +2936,13 @@ declare const selectAppAuthFeature: _ngrx_store.MemoizedSelector<object, DbxAppA
2915
2936
  declare const selectDbxAppAuthUser: _ngrx_store.MemoizedSelector<object, DbxAppAuthStateUser, (s1: DbxAppAuthFeatureState) => DbxAppAuthStateUser>;
2916
2937
 
2917
2938
  type index_d$1_DbxAppAuthFeatureState = DbxAppAuthFeatureState;
2939
+ declare const index_d$1_FEATURE_KEY: typeof FEATURE_KEY;
2918
2940
  type index_d$1_State = State;
2919
- declare const index_d$1_featureKey: typeof featureKey;
2920
2941
  declare const index_d$1_reducers: typeof reducers;
2921
2942
  declare const index_d$1_selectAppAuthFeature: typeof selectAppAuthFeature;
2922
2943
  declare const index_d$1_selectDbxAppAuthUser: typeof selectDbxAppAuthUser;
2923
2944
  declare namespace index_d$1 {
2924
- export { index_d$1_featureKey as featureKey, index_d$1_reducers as reducers, index_d$1_selectAppAuthFeature as selectAppAuthFeature, index_d$1_selectDbxAppAuthUser as selectDbxAppAuthUser };
2945
+ export { index_d$1_FEATURE_KEY as FEATURE_KEY, index_d$1_reducers as reducers, index_d$1_selectAppAuthFeature as selectAppAuthFeature, index_d$1_selectDbxAppAuthUser as selectDbxAppAuthUser };
2925
2946
  export type { index_d$1_DbxAppAuthFeatureState as DbxAppAuthFeatureState, index_d$1_State as State };
2926
2947
  }
2927
2948
 
@@ -3091,7 +3112,9 @@ declare enum DbxRouterTransitionEventType {
3091
3112
  * @see {@link DbxRouterTransitionService}
3092
3113
  */
3093
3114
  interface DbxRouterTransitionEvent {
3094
- /** The type of transition event (start or success). */
3115
+ /**
3116
+ * The type of transition event (start or success).
3117
+ */
3095
3118
  type: DbxRouterTransitionEventType;
3096
3119
  }
3097
3120
 
@@ -3219,13 +3242,21 @@ declare abstract class DbxRouterService extends DbxRouterTransitionService {
3219
3242
  * @see {@link provideDbxAppAuthRouter} for registering this configuration.
3220
3243
  */
3221
3244
  declare abstract class DbxAppAuthRoutes {
3222
- /** Route reference for the login page. Users are redirected here when authentication is required. */
3245
+ /**
3246
+ * Route reference for the login page. Users are redirected here when authentication is required.
3247
+ */
3223
3248
  abstract readonly loginRef: SegueRefOrSegueRefRouterLink;
3224
- /** Optional route reference for the logged-out page. Falls back to {@link loginRef} if not provided. */
3249
+ /**
3250
+ * Optional route reference for the logged-out page. Falls back to {@link loginRef} if not provided.
3251
+ */
3225
3252
  abstract readonly loggedOutRef?: SegueRefOrSegueRefRouterLink;
3226
- /** Optional route reference for the onboarding/setup page. Falls back to {@link appRef} if not provided. */
3253
+ /**
3254
+ * Optional route reference for the onboarding/setup page. Falls back to {@link appRef} if not provided.
3255
+ */
3227
3256
  abstract readonly onboardRef?: SegueRefOrSegueRefRouterLink;
3228
- /** Route reference for the main application page. Users are redirected here after successful authentication. */
3257
+ /**
3258
+ * Route reference for the main application page. Users are redirected here after successful authentication.
3259
+ */
3229
3260
  abstract readonly appRef: SegueRefOrSegueRefRouterLink;
3230
3261
  }
3231
3262
 
@@ -3260,9 +3291,13 @@ declare class DbxAppAuthRouterService implements OnDestroy {
3260
3291
  readonly dbxAppAuthRoutes: DbxAppAuthRoutes;
3261
3292
  private readonly _isAuthRouterEffectsEnabled;
3262
3293
  private readonly _ignoredRoutes;
3263
- /** Observable of whether auth router effects are currently enabled. */
3294
+ /**
3295
+ * Observable of whether auth router effects are currently enabled.
3296
+ */
3264
3297
  readonly isAuthRouterEffectsEnabled$: Observable<boolean>;
3265
- /** Observable of the set of route refs that are excluded from auth redirect effects. */
3298
+ /**
3299
+ * Observable of the set of route refs that are excluded from auth redirect effects.
3300
+ */
3266
3301
  readonly ignoredRoutes$: Observable<Set<SegueRefOrSegueRefRouterLink>>;
3267
3302
  /**
3268
3303
  * Observable that emits `true` when the current route is in the ignored set.
@@ -3281,6 +3316,8 @@ declare class DbxAppAuthRouterService implements OnDestroy {
3281
3316
  get hasOnboardingState(): boolean;
3282
3317
  /**
3283
3318
  * Whether or not DbxAppAuthRouterEffects are enabled.
3319
+ *
3320
+ * @returns Whether auth router effects are currently enabled.
3284
3321
  */
3285
3322
  get isAuthRouterEffectsEnabled(): boolean;
3286
3323
  set isAuthRouterEffectsEnabled(enabled: boolean);
@@ -3290,14 +3327,20 @@ declare class DbxAppAuthRouterService implements OnDestroy {
3290
3327
  *
3291
3328
  * Uses hierarchical matching — adding a parent route (e.g., `'/app/oauth'`)
3292
3329
  * will also ignore all child routes (e.g., `'/app/oauth/login'`).
3330
+ *
3331
+ * @param ref - The route ref to add to the ignored set.
3293
3332
  */
3294
3333
  addIgnoredRoute(ref: SegueRefOrSegueRefRouterLink): void;
3295
3334
  /**
3296
3335
  * Removes a route from the ignored set.
3336
+ *
3337
+ * @param ref - The route ref to remove from the ignored set.
3297
3338
  */
3298
3339
  removeIgnoredRoute(ref: SegueRefOrSegueRefRouterLink): void;
3299
3340
  /**
3300
3341
  * Returns `true` if the current route matches any of the ignored routes.
3342
+ *
3343
+ * @returns Whether the current route is in the ignored set.
3301
3344
  */
3302
3345
  get isCurrentRouteIgnoredByAuthEffects(): boolean;
3303
3346
  private _checkCurrentRouteIgnored;
@@ -3641,9 +3684,13 @@ declare function provideDbxAppAuthState(): EnvironmentProviders;
3641
3684
  * @see {@link fromDbxAppAuth.selectDbxAppAuthUser}
3642
3685
  */
3643
3686
  declare class DbxAppAuthStateService {
3644
- /** NgRx store instance typed to the full auth state. */
3687
+ /**
3688
+ * NgRx store instance typed to the full auth state.
3689
+ */
3645
3690
  readonly store: Store<any>;
3646
- /** Observable of the current {@link DbxAppAuthStateUser} from the NgRx store. */
3691
+ /**
3692
+ * Observable of the current {@link DbxAppAuthStateUser} from the NgRx store.
3693
+ */
3647
3694
  readonly authStateUser$: rxjs.Observable<DbxAppAuthStateUser>;
3648
3695
  static ɵfac: i0.ɵɵFactoryDeclaration<DbxAppAuthStateService, never>;
3649
3696
  static ɵprov: i0.ɵɵInjectableDeclaration<DbxAppAuthStateService>;
@@ -3760,6 +3807,7 @@ declare abstract class DbxButton {
3760
3807
  * Creates Angular providers that register a {@link DbxButton} implementation for DI.
3761
3808
  *
3762
3809
  * @param sourceType - The concrete button directive or component class to provide.
3810
+ * @returns An array of Angular providers for the button.
3763
3811
  *
3764
3812
  * @example
3765
3813
  * ```typescript
@@ -3920,6 +3968,8 @@ declare abstract class AbstractDbxButtonDirective implements DbxButton {
3920
3968
  setDisplayContent(content: DbxButtonDisplay): void;
3921
3969
  /**
3922
3970
  * Sets the button interceptor. If any interceptor is already set, it is replaced.
3971
+ *
3972
+ * @param interceptor - The interceptor to set on the button.
3923
3973
  */
3924
3974
  setButtonInterceptor(interceptor: DbxButtonInterceptor): void;
3925
3975
  /**
@@ -4059,6 +4109,8 @@ declare class DbxAppEnviromentService {
4059
4109
  get isTesting(): boolean;
4060
4110
  /**
4061
4111
  * Returns the environment, typed as a specific type.
4112
+ *
4113
+ * @returns The environment cast to the specified type.
4062
4114
  */
4063
4115
  getEnvironment<T extends DbxAppEnviroment>(): T;
4064
4116
  static ɵfac: i0.ɵɵFactoryDeclaration<DbxAppEnviromentService, never>;
@@ -4069,6 +4121,7 @@ declare class DbxAppEnviromentService {
4069
4121
  * Registers {@link DbxAppEnviroment} and {@link DbxAppEnviromentService} as environment-level providers.
4070
4122
  *
4071
4123
  * @param environment - The concrete environment configuration to provide.
4124
+ * @returns The environment providers for the application environment.
4072
4125
  *
4073
4126
  * @example
4074
4127
  * ```typescript
@@ -4097,9 +4150,13 @@ type MouseEventType = 'enter' | 'leave';
4097
4150
  * ```
4098
4151
  */
4099
4152
  interface MouseEventPair<T> {
4100
- /** The type of mouse event that occurred. */
4153
+ /**
4154
+ * The type of mouse event that occurred.
4155
+ */
4101
4156
  readonly type: MouseEventType;
4102
- /** Data associated with this mouse event. */
4157
+ /**
4158
+ * Data associated with this mouse event.
4159
+ */
4103
4160
  readonly data: T;
4104
4161
  }
4105
4162
  /**
@@ -4113,7 +4170,9 @@ interface MouseEventPair<T> {
4113
4170
  * ```
4114
4171
  */
4115
4172
  interface MousableFunction {
4116
- /** Optional handler invoked on mouse enter and leave events. */
4173
+ /**
4174
+ * Optional handler invoked on mouse enter and leave events.
4175
+ */
4117
4176
  onMouse?: (type: MouseEventType, event?: Maybe<MouseEvent>) => void;
4118
4177
  }
4119
4178
 
@@ -4128,7 +4187,9 @@ interface MousableFunction {
4128
4187
  * ```
4129
4188
  */
4130
4189
  interface ClickableFunction {
4131
- /** Optional click handler invoked when the element is clicked. */
4190
+ /**
4191
+ * Optional click handler invoked when the element is clicked.
4192
+ */
4132
4193
  readonly onClick?: (event?: Maybe<MouseEvent>) => void;
4133
4194
  }
4134
4195
  /**
@@ -4280,16 +4341,6 @@ interface DbxInjectionTemplateConfig<T = unknown> {
4280
4341
  */
4281
4342
  readonly viewRef?: Maybe<ViewRef>;
4282
4343
  }
4283
- /**
4284
- * Merges multiple partial {@link DbxInjectionComponentConfig} objects into a single configuration.
4285
- *
4286
- * Provider arrays are concatenated (not overwritten) so that all providers from all configs
4287
- * are preserved. All other properties are merged with later values taking precedence.
4288
- *
4289
- * @typeParam T - The component type for the configuration.
4290
- * @param configs - An array of partial configs (may contain `undefined`/`null` entries which are filtered out).
4291
- * @returns A single merged partial configuration.
4292
- */
4293
4344
  /**
4294
4345
  * Compares two {@link DbxInjectionComponentConfig} values for structural equality, safely handling nullish values.
4295
4346
  *
@@ -4301,6 +4352,15 @@ interface DbxInjectionTemplateConfig<T = unknown> {
4301
4352
  * `null === undefined` is `false`). The comparator is only invoked when both are non-nullish.
4302
4353
  */
4303
4354
  declare const dbxInjectionComponentConfigIsEqual: EqualityComparatorFunction<Maybe<DbxInjectionComponentConfig<any>>>;
4355
+ /**
4356
+ * Merges multiple partial {@link DbxInjectionComponentConfig} objects into a single configuration.
4357
+ *
4358
+ * Provider arrays are concatenated so that all providers from all configs are preserved.
4359
+ * All other properties are merged with later values taking precedence.
4360
+ *
4361
+ * @param configs - An array of partial configs to merge. May contain `undefined`/`null` entries which are filtered out.
4362
+ * @returns A single merged partial configuration.
4363
+ */
4304
4364
  declare function mergeDbxInjectionComponentConfigs<T = unknown>(configs: Maybe<Partial<DbxInjectionComponentConfig<T>>>[]): Partial<DbxInjectionComponentConfig<T>>;
4305
4365
 
4306
4366
  /**
@@ -4324,9 +4384,13 @@ declare function mergeDbxInjectionComponentConfigs<T = unknown>(configs: Maybe<P
4324
4384
  * @see {@link SegueRef} for router navigation references
4325
4385
  */
4326
4386
  interface ClickableAnchor extends ClickableFunction, MousableFunction, ClickableUrl, Partial<SegueRef> {
4327
- /** Whether this anchor is disabled and should not be interactive. */
4387
+ /**
4388
+ * Whether this anchor is disabled and should not be interactive.
4389
+ */
4328
4390
  readonly disabled?: boolean;
4329
- /** Whether this anchor is currently in a selected/active state. */
4391
+ /**
4392
+ * Whether this anchor is currently in a selected/active state.
4393
+ */
4330
4394
  readonly selected?: boolean;
4331
4395
  }
4332
4396
  /**
@@ -4382,7 +4446,9 @@ type ClickableAnchorLinkSegueRef = ClickableAnchorLink & SegueRef;
4382
4446
  * @see {@link ClickableAnchorLink}
4383
4447
  */
4384
4448
  interface ClickableIconAnchorLink extends Omit<ClickableAnchorLink, 'title'> {
4385
- /** The icon identifier (e.g., Material icon name). */
4449
+ /**
4450
+ * The icon identifier (e.g., Material icon name).
4451
+ */
4386
4452
  readonly icon: string;
4387
4453
  }
4388
4454
  /**
@@ -4407,7 +4473,9 @@ interface ClickableIconAnchorLink extends Omit<ClickableAnchorLink, 'title'> {
4407
4473
  * @see {@link expandClickableAnchorLinkTree} for flattening trees
4408
4474
  */
4409
4475
  interface ClickableAnchorLinkTree extends ClickableAnchorLink {
4410
- /** Optional child links forming a nested navigation tree. */
4476
+ /**
4477
+ * Optional child links forming a nested navigation tree.
4478
+ */
4411
4479
  readonly children?: ClickableAnchorLinkTree[];
4412
4480
  }
4413
4481
  /**
@@ -4534,37 +4602,73 @@ declare function provideDbxAnchor<S extends DbxAnchor>(sourceType: Type<S>): Pro
4534
4602
  * @see {@link anchorTypeForAnchor} for anchor type resolution logic
4535
4603
  */
4536
4604
  declare class AbstractDbxAnchorDirective<T extends ClickableAnchor = ClickableAnchor> implements DbxAnchor {
4537
- /** Model input for the segue ref or router link to navigate to. */
4605
+ /**
4606
+ * Model input for the segue ref or router link to navigate to.
4607
+ */
4538
4608
  readonly ref: i0.ModelSignal<Maybe<SegueRefOrSegueRefRouterLink>>;
4539
- /** Model input for the full anchor configuration object. */
4609
+ /**
4610
+ * Model input for the full anchor configuration object.
4611
+ */
4540
4612
  readonly anchor: i0.ModelSignal<Maybe<T>>;
4541
- /** Model input for externally controlling the disabled state. */
4613
+ /**
4614
+ * Model input for externally controlling the disabled state.
4615
+ */
4542
4616
  readonly disabled: i0.ModelSignal<Maybe<boolean>>;
4543
- /** Model input for externally controlling the selected state. */
4617
+ /**
4618
+ * Model input for externally controlling the selected state.
4619
+ */
4544
4620
  readonly selected: i0.ModelSignal<Maybe<boolean>>;
4545
- /** Computed anchor that merges the `ref` input with the `anchor` input, preferring `ref` when set. */
4621
+ /**
4622
+ * Computed anchor that merges the `ref` input with the `anchor` input, preferring `ref` when set.
4623
+ */
4546
4624
  readonly anchorSignal: i0.Signal<Maybe<T>>;
4547
- /** Computed selected state that combines the `selected` input with the anchor's own `selected` property. */
4625
+ /**
4626
+ * Computed selected state that combines the `selected` input with the anchor's own `selected` property.
4627
+ */
4548
4628
  readonly selectedSignal: i0.Signal<boolean | undefined>;
4549
- /** Computed {@link ClickableAnchorType} derived from the current anchor and disabled state. */
4629
+ /**
4630
+ * Computed {@link ClickableAnchorType} derived from the current anchor and disabled state.
4631
+ */
4550
4632
  readonly typeSignal: i0.Signal<ClickableAnchorType>;
4551
- /** Computed disabled state that combines the `disabled` input with the anchor's own `disabled` property. */
4633
+ /**
4634
+ * Computed disabled state that combines the `disabled` input with the anchor's own `disabled` property.
4635
+ */
4552
4636
  readonly disabledSignal: i0.Signal<boolean | undefined>;
4553
- /** Computed URL extracted from the current anchor's `url` property. */
4637
+ /**
4638
+ * Computed URL extracted from the current anchor's `url` property.
4639
+ */
4554
4640
  readonly urlSignal: i0.Signal<string | undefined>;
4555
- /** Computed target (e.g., `_blank`) extracted from the current anchor's `target` property. */
4641
+ /**
4642
+ * Computed target (e.g., `_blank`) extracted from the current anchor's `target` property.
4643
+ */
4556
4644
  readonly targetSignal: i0.Signal<string | undefined>;
4557
4645
  readonly anchor$: Observable<Maybe<T>>;
4558
4646
  readonly disabled$: Observable<Maybe<boolean>>;
4559
4647
  readonly selected$: Observable<Maybe<boolean>>;
4560
4648
  readonly type$: Observable<ClickableAnchorType>;
4561
- /** Sets the segue ref or router link for this anchor. */
4649
+ /**
4650
+ * Sets the segue ref or router link for this anchor.
4651
+ *
4652
+ * @param ref - The segue ref or router link to set.
4653
+ */
4562
4654
  setRef(ref: Maybe<SegueRefOrSegueRefRouterLink>): void;
4563
- /** Sets the full anchor configuration object. */
4655
+ /**
4656
+ * Sets the full anchor configuration object.
4657
+ *
4658
+ * @param anchor - The anchor configuration to set.
4659
+ */
4564
4660
  setAnchor(anchor: Maybe<T>): void;
4565
- /** Sets the external disabled state override. */
4661
+ /**
4662
+ * Sets the external disabled state override.
4663
+ *
4664
+ * @param disabled - Whether the anchor should be disabled.
4665
+ */
4566
4666
  setDisabled(disabled: Maybe<boolean>): void;
4567
- /** Sets the external selected state override. */
4667
+ /**
4668
+ * Sets the external selected state override.
4669
+ *
4670
+ * @param selected - Whether the anchor should be selected.
4671
+ */
4568
4672
  setSelected(selected: Maybe<boolean>): void;
4569
4673
  static ɵfac: i0.ɵɵFactoryDeclaration<AbstractDbxAnchorDirective<any>, never>;
4570
4674
  static ɵdir: i0.ɵɵDirectiveDeclaration<AbstractDbxAnchorDirective<any>, never, never, { "ref": { "alias": "ref"; "required": false; "isSignal": true; }; "anchor": { "alias": "anchor"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "selected": { "alias": "selected"; "required": false; "isSignal": true; }; }, { "ref": "refChange"; "anchor": "anchorChange"; "disabled": "disabledChange"; "selected": "selectedChange"; }, never, never, true, never>;
@@ -4709,6 +4813,7 @@ interface RedirectForUserIdentifierParamHookInput {
4709
4813
  * missing or matches the placeholder value.
4710
4814
  *
4711
4815
  * @param input - Configuration specifying the route criteria, access control logic, and optional parameter overrides.
4816
+ * @returns The result of registering the transition hook.
4712
4817
  *
4713
4818
  * @see {@link RedirectForUserIdentifierParamHookInput}
4714
4819
  * @see {@link redirectForIdentifierParamHook}
@@ -4742,9 +4847,9 @@ declare class DbxAngularRouterService implements DbxRouterService, DbxRouterTran
4742
4847
  readonly transitions$: Observable<DbxRouterTransitionEvent>;
4743
4848
  go(input: ObservableOrValue<SegueRefOrSegueRefRouterLink<NavigationExtras | NavigationBehaviorOptions>>): Promise<boolean>;
4744
4849
  updateParams(inputParams: ObservableOrValue<SegueRefRawSegueParams>): Promise<boolean>;
4745
- isActive(segueRef: SegueRefOrSegueRefRouterLink): boolean;
4746
- isActiveExactly(segueRef: SegueRefOrSegueRefRouterLink): boolean;
4747
- comparePrecision(a: SegueRefOrSegueRefRouterLink, b: SegueRefOrSegueRefRouterLink): number;
4850
+ isActive(_segueRef: SegueRefOrSegueRefRouterLink): boolean;
4851
+ isActiveExactly(_segueRef: SegueRefOrSegueRefRouterLink): boolean;
4852
+ comparePrecision(_a: SegueRefOrSegueRefRouterLink, _b: SegueRefOrSegueRefRouterLink): number;
4748
4853
  static ɵfac: i0.ɵɵFactoryDeclaration<DbxAngularRouterService, never>;
4749
4854
  static ɵprov: i0.ɵɵInjectableDeclaration<DbxAngularRouterService>;
4750
4855
  }
@@ -4961,9 +5066,13 @@ declare function isLatestSuccessfulRoute(config: IsLatestSuccessfulRouteConfig):
4961
5066
  */
4962
5067
  declare abstract class AbstractTransitionDirective {
4963
5068
  protected readonly dbxRouterTransitionService: DbxRouterTransitionService;
4964
- /** Observable that emits on each successful router transition. */
5069
+ /**
5070
+ * Observable that emits on each successful router transition.
5071
+ */
4965
5072
  readonly transitionSuccess$: Observable<_dereekb_dbx_core.DbxRouterTransitionEvent>;
4966
- /** Observable that emits immediately on initialization and on each subsequent successful transition. */
5073
+ /**
5074
+ * Observable that emits immediately on initialization and on each subsequent successful transition.
5075
+ */
4967
5076
  readonly initAndUpdateOnTransitionSuccess$: Observable<void>;
4968
5077
  static ɵfac: i0.ɵɵFactoryDeclaration<AbstractTransitionDirective, never>;
4969
5078
  static ɵdir: i0.ɵɵDirectiveDeclaration<AbstractTransitionDirective, never, never, {}, {}, never, never, true, never>;
@@ -5057,8 +5166,8 @@ declare function onRouterTransitionSuccessEvent(events$: Observable<DbxRouterTra
5057
5166
  /**
5058
5167
  * Creates an observable that returns true when the route for the input segueRef is active.
5059
5168
  *
5060
- * @param dbxRouterService
5061
- * @param segueRef
5169
+ * @param config - Configuration specifying the router service, segue ref, and matching options.
5170
+ * @returns An observable that emits `true` when the segue ref's route is active.
5062
5171
  */
5063
5172
  declare function isSegueRefActiveOnTransitionSuccess(config: IsSegueRefActiveFunctionConfig): Observable<boolean>;
5064
5173
  /**
@@ -5075,8 +5184,8 @@ interface IsSegueRefActiveConfig extends Pick<IsSegueRefActiveFunctionConfig, 'd
5075
5184
  /**
5076
5185
  * Operator function that maps the input segueRef to a boolean depending on the current route state.
5077
5186
  *
5078
- * @param dbxRouterService
5079
- * @param segueRef
5187
+ * @param config - Configuration specifying the router service and default behavior for null refs.
5188
+ * @returns An RxJS operator that maps a segue ref to whether it is currently active.
5080
5189
  */
5081
5190
  declare function isSegueRefActive(config: IsSegueRefActiveConfig): OperatorFunction<Maybe<SegueRefOrSegueRefRouterLink>, boolean>;
5082
5191
 
@@ -6034,6 +6143,7 @@ type ProvideFilterSourceDirectiveDefaultFilterFactoryFunction<F = unknown> = (in
6034
6143
  *
6035
6144
  * @param sourceType - The concrete directive class.
6036
6145
  * @param defaultFilterFactory - Optional factory to provide an initial filter value via DI.
6146
+ * @returns An array of Angular providers for the filter source directive.
6037
6147
  *
6038
6148
  * @example
6039
6149
  * ```typescript
@@ -6109,6 +6219,7 @@ declare class DbxFilterSourceConnectorDirective<F = unknown> extends AbstractFil
6109
6219
  * Creates Angular providers that register a {@link FilterSource} implementation for DI.
6110
6220
  *
6111
6221
  * @param sourceType - The concrete filter source class to provide.
6222
+ * @returns An array of Angular providers for the filter source.
6112
6223
  *
6113
6224
  * @example
6114
6225
  * ```typescript
@@ -6124,6 +6235,7 @@ declare function provideFilterSource<S extends FilterSource>(sourceType: Type<S>
6124
6235
  * Creates Angular providers that register both a {@link FilterSourceConnector} and {@link FilterSource} for DI.
6125
6236
  *
6126
6237
  * @param sourceType - The concrete connector class to provide.
6238
+ * @returns An array of Angular providers for the filter source connector.
6127
6239
  */
6128
6240
  declare function provideFilterSourceConnector<S extends FilterSourceConnector>(sourceType: Type<S>): Provider[];
6129
6241
 
@@ -6247,6 +6359,9 @@ interface ClickableFilterPreset<F extends FilterWithPreset<P>, P extends string
6247
6359
  }
6248
6360
  /**
6249
6361
  * Type guard that checks if an object is a {@link ClickableFilterPreset}.
6362
+ *
6363
+ * @param preset - The object to check.
6364
+ * @returns `true` if the object has a `presetValue` property.
6250
6365
  */
6251
6366
  declare function isClickableFilterPreset<F extends FilterWithPreset<P>, P extends string = string>(preset: object): preset is ClickableFilterPreset<F, P>;
6252
6367
  /**
@@ -6271,6 +6386,9 @@ interface ClickablePartialFilterPreset<F> extends Pick<ClickableAnchorLink, 'tit
6271
6386
  }
6272
6387
  /**
6273
6388
  * Type guard that checks if an object is a {@link ClickablePartialFilterPreset}.
6389
+ *
6390
+ * @param preset - The object to check.
6391
+ * @returns `true` if the object has `partialPresetValue` and `isActive` properties.
6274
6392
  */
6275
6393
  declare function isClickablePartialFilterPreset<F>(preset: object): preset is ClickablePartialFilterPreset<F>;
6276
6394
  /**
@@ -6574,10 +6692,15 @@ declare class DbxInjectionContextDirective<O = unknown> implements DbxInjectionC
6574
6692
  ngOnDestroy(): void;
6575
6693
  /**
6576
6694
  * {@inheritDoc DbxInjectionContext.showContext}
6695
+ *
6696
+ * @param config - The injection context configuration describing the component and its usage.
6697
+ * @returns A promise that resolves with the output of the injected component's usage.
6577
6698
  */
6578
6699
  showContext<T, O>(config: DbxInjectionContextConfig<T>): Promise<O>;
6579
6700
  /**
6580
6701
  * {@inheritDoc DbxInjectionContext.resetContext}
6702
+ *
6703
+ * @returns `true` if an active context was cleared, `false` otherwise.
6581
6704
  */
6582
6705
  resetContext(): boolean;
6583
6706
  /**
@@ -6617,10 +6740,15 @@ declare abstract class AbstractForwardDbxInjectionContextDirective implements Db
6617
6740
  readonly dbxInjectionContext: DbxInjectionContext;
6618
6741
  /**
6619
6742
  * {@inheritDoc DbxInjectionContext.showContext}
6743
+ *
6744
+ * @param config - The injection context configuration to forward to the host context.
6745
+ * @returns A promise that resolves with the output of the injected component's usage.
6620
6746
  */
6621
6747
  showContext<T = unknown, O = unknown>(config: DbxInjectionContextConfig<T, unknown>): Promise<O>;
6622
6748
  /**
6623
6749
  * {@inheritDoc DbxInjectionContext.resetContext}
6750
+ *
6751
+ * @returns `true` if an active context was cleared, `false` otherwise.
6624
6752
  */
6625
6753
  resetContext(): boolean;
6626
6754
  static ɵfac: i0.ɵɵFactoryDeclaration<AbstractForwardDbxInjectionContextDirective, never>;
@@ -6933,11 +7061,17 @@ interface ConfiguredSimpleStorageAccessorConfig extends SimpleStorageAccessorCon
6933
7061
  /**
6934
7062
  * Validates that a storage key prefix is non-empty and does not contain the prefix splitter character.
6935
7063
  *
7064
+ * @param prefix - The prefix string to validate.
7065
+ * @param prefixSplitter - The splitter string that separates the prefix from the key.
6936
7066
  * @throws {Error} If the prefix is invalid or the splitter is empty.
6937
7067
  */
6938
7068
  declare function assertValidStorageKeyPrefix(prefix: string, prefixSplitter: string): void;
6939
7069
  /**
6940
7070
  * Checks whether a storage key prefix is valid (non-empty and does not contain the splitter).
7071
+ *
7072
+ * @param prefix - The prefix string to validate.
7073
+ * @param prefixSpltter - The splitter string that separates the prefix from the key.
7074
+ * @returns `true` if the prefix is valid.
6941
7075
  */
6942
7076
  declare function isValidStorageKeyPrefix(prefix: string, prefixSpltter: string): boolean;
6943
7077
  /**
@@ -7103,6 +7237,8 @@ declare class MemoryStorageObject extends FullLocalStorageObject {
7103
7237
  * Creates the default {@link FullStorageObject}, preferring `localStorage` and
7104
7238
  * falling back to an in-memory store if `localStorage` is unavailable.
7105
7239
  *
7240
+ * @returns A FullStorageObject backed by localStorage or an in-memory fallback.
7241
+ *
7106
7242
  * @example
7107
7243
  * ```typescript
7108
7244
  * const storage = defaultStorageObjectFactory();
@@ -7115,6 +7251,8 @@ declare function defaultStorageObjectFactory(): FullStorageObject;
7115
7251
  *
7116
7252
  * Call in your application config to enable storage-based services throughout the app.
7117
7253
  *
7254
+ * @returns The environment providers for storage services.
7255
+ *
7118
7256
  * @example
7119
7257
  * ```typescript
7120
7258
  * export const appConfig: ApplicationConfig = {
@@ -7138,6 +7276,9 @@ declare function provideDbxStorage(): EnvironmentProviders;
7138
7276
  * @example
7139
7277
  * // Clean up a destroy function directly:
7140
7278
  * clean(() => resource.release());
7279
+ *
7280
+ * @param input - The Destroyable object or destroy function to register for cleanup.
7281
+ * @returns The same input, for chaining.
7141
7282
  */
7142
7283
  declare function clean<T extends Destroyable | DestroyFunction>(input: T): T;
7143
7284
  /**
@@ -7153,8 +7294,11 @@ declare function clean<T extends Destroyable | DestroyFunction>(input: T): T;
7153
7294
  * @example
7154
7295
  * // Complete a ReplaySubject when the component is destroyed:
7155
7296
  * readonly events$ = completeOnDestroy(new ReplaySubject<Event>(1));
7297
+ *
7298
+ * @param input - The Subject to register for completion on destroy.
7299
+ * @returns The same input, for chaining.
7156
7300
  */
7157
- declare function completeOnDestroy<T extends Pick<Subject<any>, 'complete' | 'error'>>(input: T): T;
7301
+ declare function completeOnDestroy<T extends Pick<Subject<unknown>, 'complete' | 'error'>>(input: T): T;
7158
7302
 
7159
7303
  /**
7160
7304
  * Configuration for {@link cleanLockSet}, controlling destruction timing and lifecycle callbacks.
@@ -7185,7 +7329,8 @@ type CleanLockSet = LockSet & {
7185
7329
  *
7186
7330
  * Must be run within an Angular injection context.
7187
7331
  *
7188
- * @param config Optional configuration for destruction behavior and callbacks.
7332
+ * @param config - Optional configuration for destruction behavior and callbacks.
7333
+ * @returns A CleanLockSet that is automatically destroyed when the context is destroyed.
7189
7334
  *
7190
7335
  * @example
7191
7336
  * // Create a simple lockset:
@@ -7236,6 +7381,9 @@ interface CleanSubscriptionWithLockSetConfig<T extends Unsubscribable = Unsubscr
7236
7381
  * // Create first, then set the subscription later:
7237
7382
  * readonly _sub = cleanSubscriptionWithLockSet({ lockSet: this.lockSet });
7238
7383
  * this._sub.subscription = obs$.subscribe(handler);
7384
+ *
7385
+ * @param input - Configuration specifying the lock set and optional initial subscription.
7386
+ * @returns A SubscriptionObject that is destroyed when the context is destroyed and the lock set unlocks.
7239
7387
  */
7240
7388
  declare function cleanSubscriptionWithLockSet<T extends Unsubscribable = Unsubscribable>(input: CleanSubscriptionWithLockSetConfig<T>): SubscriptionObject<T>;
7241
7389
 
@@ -7251,6 +7399,9 @@ declare function cleanSubscriptionWithLockSet<T extends Unsubscribable = Unsubsc
7251
7399
  * // Or create first, then set the subscription later:
7252
7400
  * readonly _sub = cleanSubscription();
7253
7401
  * this._sub.subscription = obs$.subscribe(handler);
7402
+ *
7403
+ * @param sub - Optional subscription or getter to wrap.
7404
+ * @returns A SubscriptionObject that is automatically destroyed when the context is destroyed.
7254
7405
  */
7255
7406
  declare function cleanSubscription<T extends Unsubscribable = Unsubscribable>(sub?: Maybe<GetterOrValue<T>>): SubscriptionObject<T>;
7256
7407
 
@@ -7267,6 +7418,9 @@ declare function cleanSubscription<T extends Unsubscribable = Unsubscribable>(su
7267
7418
  * // Create empty, then set the observable source later:
7268
7419
  * readonly context = cleanLoadingContext<MyData>();
7269
7420
  * this.context.obs = this.data$;
7421
+ *
7422
+ * @param input - Optional loading state context input configuration.
7423
+ * @returns A mutable loading state context that is automatically destroyed on cleanup.
7270
7424
  */
7271
7425
  declare function cleanLoadingContext<T = unknown, S extends LoadingState<T> = LoadingState<T>, E extends LoadingContextEvent = LoadingContextEvent & S>(input?: LoadingStateContextInput<T, S, E>): MutableLoadingStateContext<T, S, E>;
7272
7426
  /**
@@ -7282,6 +7436,9 @@ declare function cleanLoadingContext<T = unknown, S extends LoadingState<T> = Lo
7282
7436
  * // Create empty, then set the observable source later:
7283
7437
  * readonly listContext = cleanListLoadingContext<MyItem>();
7284
7438
  * this.listContext.obs = this.items$;
7439
+ *
7440
+ * @param input - Optional list loading state context input configuration.
7441
+ * @returns A mutable list loading state context that is automatically destroyed on cleanup.
7285
7442
  */
7286
7443
  declare function cleanListLoadingContext<L = unknown, S extends ListLoadingState<L> = ListLoadingState<L>>(input?: ListLoadingStateContextInput<L, S>): MutableListLoadingStateContext<L, S>;
7287
7444
 
@@ -7298,6 +7455,9 @@ declare function cleanListLoadingContext<L = unknown, S extends ListLoadingState
7298
7455
  * // Create first, then set the destroy function later:
7299
7456
  * readonly _destroy = cleanDestroy();
7300
7457
  * this._destroy.setDestroyFunction(() => resource.release());
7458
+ *
7459
+ * @param input - Optional destroy function to wrap.
7460
+ * @returns A DestroyFunctionObject that will be automatically destroyed when the context is destroyed.
7301
7461
  */
7302
7462
  declare function cleanDestroy(input?: Maybe<DestroyFunction>): DestroyFunctionObject;
7303
7463
 
@@ -7310,6 +7470,7 @@ declare function cleanDestroy(input?: Maybe<DestroyFunction>): DestroyFunctionOb
7310
7470
  *
7311
7471
  * @param cdRef - The change detector to trigger. If `null`/`undefined`, the operator is a no-op.
7312
7472
  * @param timeout - Delay in milliseconds before calling `detectChanges`.
7473
+ * @returns An RxJS operator that triggers change detection on each emission.
7313
7474
  *
7314
7475
  * @example
7315
7476
  * ```typescript
@@ -7335,6 +7496,7 @@ declare function safeDetectChanges(cdRef: ChangeDetectorRef): void;
7335
7496
  *
7336
7497
  * @param cdRef - The change detector to mark. If `null`/`undefined`, the operator is a no-op.
7337
7498
  * @param timeout - Delay in milliseconds before calling `markForCheck`.
7499
+ * @returns An RxJS operator that marks the view for check on each emission.
7338
7500
  *
7339
7501
  * @example
7340
7502
  * ```typescript
@@ -7366,6 +7528,7 @@ declare function safeUseCdRef(cdRef: ChangeDetectorRef, use: (cdRef: ChangeDetec
7366
7528
  * Useful for conditionally showing fallback content when no projection is provided.
7367
7529
  *
7368
7530
  * @param ref - Reference to the wrapper element around `ng-content`.
7531
+ * @returns `true` if the wrapper element has any child nodes.
7369
7532
  *
7370
7533
  * @example
7371
7534
  * ```typescript
@@ -7394,6 +7557,9 @@ declare function checkNgContentWrapperHasContent(ref: Maybe<ElementRef<Element>>
7394
7557
  * Useful for Angular directive inputs where the attribute can be applied without a value
7395
7558
  * (e.g., `<div myDirective>` passes `''`), and you want to treat that as "not provided".
7396
7559
  *
7560
+ * @param value - The input value to transform.
7561
+ * @returns The original value, or `undefined` if the value is an empty string.
7562
+ *
7397
7563
  * @example
7398
7564
  * ```typescript
7399
7565
  * @Directive({ selector: '[appHighlight]' })