@dereekb/dbx-core 13.11.14 → 13.11.16
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.
- package/fesm2022/dereekb-dbx-core.mjs +322 -244
- package/fesm2022/dereekb-dbx-core.mjs.map +1 -1
- package/package.json +5 -5
- package/types/dereekb-dbx-core.d.ts +235 -194
|
@@ -70,6 +70,9 @@ declare class DbxCoreAssetLoader extends AssetLoader {
|
|
|
70
70
|
* Registers the config token, the concrete loader, and the abstract
|
|
71
71
|
* {@link AssetLoader} token pointing to the concrete implementation.
|
|
72
72
|
*
|
|
73
|
+
* @param config - Optional configuration for the asset loader. Defaults to loading from `/assets/`.
|
|
74
|
+
* @returns Angular environment providers that register the {@link AssetLoader} and its configuration.
|
|
75
|
+
*
|
|
73
76
|
* @example
|
|
74
77
|
* ```ts
|
|
75
78
|
* export const appConfig: ApplicationConfig = {
|
|
@@ -78,9 +81,6 @@ declare class DbxCoreAssetLoader extends AssetLoader {
|
|
|
78
81
|
* ]
|
|
79
82
|
* };
|
|
80
83
|
* ```
|
|
81
|
-
*
|
|
82
|
-
* @param config - Optional configuration for the asset loader. Defaults to loading from `/assets/`.
|
|
83
|
-
* @returns Angular environment providers that register the {@link AssetLoader} and its configuration.
|
|
84
84
|
*/
|
|
85
85
|
declare function provideDbxAssetLoader(config?: DbxCoreAssetLoaderConfig): EnvironmentProviders;
|
|
86
86
|
|
|
@@ -105,8 +105,8 @@ type DbxActionWorkOrWorkProgress = boolean | DbxActionWorkProgress;
|
|
|
105
105
|
/**
|
|
106
106
|
* Creates a working progress value from an array of working progress values.
|
|
107
107
|
*
|
|
108
|
-
* @param workOrWorkProgress The array of working progress values to use.
|
|
109
|
-
* @param progressPercent An optional progress percent value to use if the working progress is a boolean.
|
|
108
|
+
* @param workOrWorkProgress - The array of working progress values to use.
|
|
109
|
+
* @param progressPercent - An optional progress percent value to use if the working progress is a boolean.
|
|
110
110
|
* @returns The working progress value.
|
|
111
111
|
*/
|
|
112
112
|
declare function dbxActionWorkProgress(workOrWorkProgress: Maybe<DbxActionWorkOrWorkProgress>[], progressPercent?: Maybe<DbxActionWorkProgress>): number | boolean;
|
|
@@ -320,9 +320,10 @@ declare function actionContextHasNoErrorAndIsModifiedAndCanTrigger(state: Action
|
|
|
320
320
|
* - IDLE/DISABLED -> idle loading state
|
|
321
321
|
* - All other states -> loading (with optional work progress)
|
|
322
322
|
*
|
|
323
|
-
* @typeParam O - The output result type.
|
|
324
323
|
* @param state - The action context state to convert.
|
|
325
324
|
* @returns A loading state representation of the action context state.
|
|
325
|
+
*
|
|
326
|
+
* @typeParam O - The output result type.
|
|
326
327
|
*/
|
|
327
328
|
declare function loadingStateForActionContextState<O = unknown>(state: ActionContextState<unknown, O>): LoadingState<O>;
|
|
328
329
|
/**
|
|
@@ -610,10 +611,11 @@ declare abstract class SecondaryActionContextStoreSource<T = unknown, O = unknow
|
|
|
610
611
|
/**
|
|
611
612
|
* Filters null/undefined values from an observable of {@link ActionContextStore} instances.
|
|
612
613
|
*
|
|
613
|
-
* @typeParam T - The input value type.
|
|
614
|
-
* @typeParam O - The output result type.
|
|
615
614
|
* @param obs - The observable that may emit null/undefined store values.
|
|
616
615
|
* @returns An observable that only emits non-null store instances.
|
|
616
|
+
*
|
|
617
|
+
* @typeParam T - The input value type.
|
|
618
|
+
* @typeParam O - The output result type.
|
|
617
619
|
*/
|
|
618
620
|
declare function actionContextStoreSourcePipe<T, O>(obs: Observable<Maybe<ActionContextStore<T, O>>>): Observable<ActionContextStore<T, O>>;
|
|
619
621
|
/**
|
|
@@ -630,12 +632,13 @@ type PipeActionStoreFunction<R, T, O> = (store: ActionContextStore<T, O>) => Obs
|
|
|
630
632
|
* Subscribes to the source's store observable and applies the provided function
|
|
631
633
|
* via switchMap, automatically switching to the latest store.
|
|
632
634
|
*
|
|
633
|
-
* @typeParam R - The return type of the derived observable.
|
|
634
|
-
* @typeParam T - The input value type.
|
|
635
|
-
* @typeParam O - The output result type.
|
|
636
635
|
* @param source - The action context store source to read from.
|
|
637
636
|
* @param pipeFn - The function to apply to each emitted store.
|
|
638
637
|
* @returns An observable of the derived value.
|
|
638
|
+
*
|
|
639
|
+
* @typeParam R - The return type of the derived observable.
|
|
640
|
+
* @typeParam T - The input value type.
|
|
641
|
+
* @typeParam O - The output result type.
|
|
639
642
|
*/
|
|
640
643
|
declare function pipeActionStore<R = unknown, T = unknown, O = unknown>(source: ActionContextStoreSource<T, O>, pipeFn: PipeActionStoreFunction<R, T, O>): Observable<R>;
|
|
641
644
|
/**
|
|
@@ -651,11 +654,12 @@ type UseActionStoreFunction<T, O> = (store: ActionContextStore<T, O>) => void;
|
|
|
651
654
|
* This is a convenience for performing one-shot imperative operations on the store,
|
|
652
655
|
* such as triggering an action or setting a value, without maintaining a long-lived subscription.
|
|
653
656
|
*
|
|
654
|
-
* @typeParam T - The input value type.
|
|
655
|
-
* @typeParam O - The output result type.
|
|
656
657
|
* @param source - The action context store source to read from.
|
|
657
658
|
* @param useFn - The function to invoke with the store.
|
|
658
659
|
* @returns The subscription (completes after first emission).
|
|
660
|
+
*
|
|
661
|
+
* @typeParam T - The input value type.
|
|
662
|
+
* @typeParam O - The output result type.
|
|
659
663
|
*/
|
|
660
664
|
declare function useActionStore<T = unknown, O = unknown>(source: ActionContextStoreSource<T, O>, useFn: UseActionStoreFunction<T, O>): Subscription;
|
|
661
665
|
/**
|
|
@@ -1159,17 +1163,18 @@ interface ActionContextStoreSourceMapReader<T = unknown, O = unknown> {
|
|
|
1159
1163
|
* The reader provides reactive utility functions to aggregate data across all stores
|
|
1160
1164
|
* in the map (e.g., checking if any store is working, or reducing values from all stores).
|
|
1161
1165
|
*
|
|
1162
|
-
* @typeParam T - The input value type for the actions.
|
|
1163
|
-
* @typeParam O - The output result type for the actions.
|
|
1164
1166
|
* @param actionKeySourceMap$ - Observable (or static value) of the action key to source map.
|
|
1165
1167
|
* @returns A reader with aggregate query functions over the map's stores.
|
|
1168
|
+
*
|
|
1169
|
+
* @typeParam T - The input value type for the actions.
|
|
1170
|
+
* @typeParam O - The output result type for the actions.
|
|
1166
1171
|
*/
|
|
1167
1172
|
declare function actionContextStoreSourceMapReader<T = unknown, O = unknown>(actionKeySourceMap$: ObservableOrValue<Map<ActionKey, ActionContextStoreSource<T, O>>>): ActionContextStoreSourceMapReader<T, O>;
|
|
1168
1173
|
/**
|
|
1169
1174
|
* Returns an Observable of the results of the mapFn for each source in the actionKeySourceMap$.
|
|
1170
1175
|
*
|
|
1171
|
-
* @param actionKeySourceMap$ Observable of the action key source map.
|
|
1172
|
-
* @param mapFn Function to apply to each source.
|
|
1176
|
+
* @param actionKeySourceMap$ - Observable of the action key source map.
|
|
1177
|
+
* @param mapFn - Function to apply to each source.
|
|
1173
1178
|
* @returns Observable of the results of the mapFn for each source.
|
|
1174
1179
|
*/
|
|
1175
1180
|
declare function fromAllActionContextStoreSourceMapSources<O>(actionKeySourceMap$: ObservableOrValue<ActionContextStoreSourceMap>, mapFn: (input: ActionContextStore) => Observable<O>): Observable<O[]>;
|
|
@@ -2004,10 +2009,12 @@ interface DbxActionContextSourceReference<T = unknown, O = unknown> extends Dest
|
|
|
2004
2009
|
* The returned reference has a no-op `destroy()` method, making it suitable for cases
|
|
2005
2010
|
* where the caller does not own the lifecycle of the source instance.
|
|
2006
2011
|
*
|
|
2007
|
-
* @typeParam T - The input value type.
|
|
2008
|
-
* @typeParam O - The output result type.
|
|
2009
2012
|
* @param sourceInstance - The source instance to wrap.
|
|
2010
2013
|
* @returns A destroyable reference to the source instance.
|
|
2014
|
+
*
|
|
2015
|
+
* @typeParam T - The input value type.
|
|
2016
|
+
* @typeParam O - The output result type.
|
|
2017
|
+
*
|
|
2011
2018
|
* @__NO_SIDE_EFFECTS__
|
|
2012
2019
|
*/
|
|
2013
2020
|
declare function makeDbxActionContextSourceReference<T, O>(sourceInstance: DbxActionContextStoreSourceInstance<T, O>): DbxActionContextSourceReference<T, O>;
|
|
@@ -2076,25 +2083,26 @@ declare class DbxCoreActionModule {
|
|
|
2076
2083
|
* When `sourceType` is provided, the existing class is registered as the source. When `null`,
|
|
2077
2084
|
* a standalone {@link DbxActionContextMachineAsService} is created as the default implementation.
|
|
2078
2085
|
*
|
|
2079
|
-
* @param sourceType - The concrete source class to register, or `null` to use the default machine-based implementation
|
|
2080
|
-
* @returns
|
|
2086
|
+
* @param sourceType - The concrete source class to register, or `null` to use the default machine-based implementation.
|
|
2087
|
+
* @returns Array of Angular providers.
|
|
2081
2088
|
*
|
|
2082
|
-
* @
|
|
2083
|
-
* ```typescript
|
|
2084
|
-
* @Directive({
|
|
2089
|
+
* @Directive ({
|
|
2085
2090
|
* selector: '[myAction]',
|
|
2086
2091
|
* providers: provideActionStoreSource(MyActionDirective),
|
|
2087
2092
|
* })
|
|
2088
2093
|
* export class MyActionDirective extends ActionContextStoreSource { ... }
|
|
2089
2094
|
* ```
|
|
2095
|
+
*
|
|
2096
|
+
* @example
|
|
2097
|
+
* ```typescript
|
|
2090
2098
|
*/
|
|
2091
|
-
declare function provideActionStoreSource<S extends ActionContextStoreSource>(sourceType: Type<S
|
|
2099
|
+
declare function provideActionStoreSource<S extends ActionContextStoreSource>(sourceType: Maybe<Type<S>>): Provider[];
|
|
2092
2100
|
/**
|
|
2093
2101
|
* Creates Angular DI providers for a {@link SecondaryActionContextStoreSource} along with
|
|
2094
2102
|
* the standard {@link ActionContextStoreSource} and {@link DbxActionContextStoreSourceInstance} providers.
|
|
2095
2103
|
*
|
|
2096
|
-
* @param sourceType - The concrete secondary source class to register
|
|
2097
|
-
* @returns
|
|
2104
|
+
* @param sourceType - The concrete secondary source class to register.
|
|
2105
|
+
* @returns Array of Angular providers.
|
|
2098
2106
|
*/
|
|
2099
2107
|
declare function provideSecondaryActionStoreSource<S extends SecondaryActionContextStoreSource>(sourceType: Type<S>): Provider[];
|
|
2100
2108
|
|
|
@@ -2193,11 +2201,11 @@ type SegueRefOrSegueRefRouterLink<O = object> = SegueRef<O> | SegueRefRouterLink
|
|
|
2193
2201
|
/**
|
|
2194
2202
|
* Type guard that checks whether the given input is a {@link SegueRef} object (as opposed to a raw router link string).
|
|
2195
2203
|
*
|
|
2196
|
-
* @typeParam O - The type of the transition options.
|
|
2197
2204
|
* @param input - The value to test.
|
|
2198
2205
|
* @returns `true` if the input is a {@link SegueRef} with a non-empty `ref` property.
|
|
2199
2206
|
*
|
|
2200
2207
|
* @see {@link asSegueRef} for converting an input to a SegueRef
|
|
2208
|
+
* @typeParam O - The type of the transition options.
|
|
2201
2209
|
*/
|
|
2202
2210
|
declare function isSegueRef<O = object>(input: Maybe<SegueRefOrSegueRefRouterLink<O>>): input is SegueRef<O>;
|
|
2203
2211
|
/**
|
|
@@ -2233,21 +2241,22 @@ declare function asSegueRefString<O = object>(input: Maybe<SegueRefOrSegueRefRou
|
|
|
2233
2241
|
/**
|
|
2234
2242
|
* Creates a {@link SegueRef} from a string ref path and optional segue options.
|
|
2235
2243
|
*
|
|
2236
|
-
* @typeParam O - The type of the transition options.
|
|
2237
2244
|
* @param ref - The string ref path to wrap.
|
|
2238
2245
|
* @param options - Optional parameters and transition options to include.
|
|
2239
2246
|
* @returns A new {@link SegueRef} containing the given ref and options.
|
|
2247
|
+
*
|
|
2248
|
+
* @typeParam O - The type of the transition options.
|
|
2240
2249
|
*/
|
|
2241
2250
|
declare function refStringToSegueRef<O = object>(ref: string, options?: SegueRefOptions<O>): SegueRef<O>;
|
|
2242
2251
|
/**
|
|
2243
2252
|
* Maps an observable of string ref paths to an observable of {@link SegueRef} objects.
|
|
2244
2253
|
*
|
|
2245
|
-
* @typeParam O - The type of the transition options.
|
|
2246
2254
|
* @param obs - The source observable emitting string ref paths.
|
|
2247
2255
|
* @param options - Optional parameters and transition options to include in each emitted SegueRef.
|
|
2248
2256
|
* @returns An observable that emits {@link SegueRef} objects.
|
|
2249
2257
|
*
|
|
2250
2258
|
* @see {@link refStringToSegueRef}
|
|
2259
|
+
* @typeParam O - The type of the transition options.
|
|
2251
2260
|
*/
|
|
2252
2261
|
declare function mapRefStringObsToSegueRefObs<O = object>(obs: Observable<string>, options?: SegueRefOptions<O>): Observable<SegueRef<O>>;
|
|
2253
2262
|
|
|
@@ -2516,6 +2525,9 @@ declare function makeAuthTransitionHook(config: AuthTransitionHookConfig): Trans
|
|
|
2516
2525
|
* redirect targets (static or dynamic) for that state.
|
|
2517
2526
|
* @returns An {@link AuthTransitionRedirectTargetGetter} that resolves the redirect based on the current auth state.
|
|
2518
2527
|
*
|
|
2528
|
+
* @see {@link AuthTransitionRedirectTargetOrGetter}
|
|
2529
|
+
* @see {@link AuthUserState}
|
|
2530
|
+
*
|
|
2519
2531
|
* @example
|
|
2520
2532
|
* ```ts
|
|
2521
2533
|
* const redirectGetter = redirectBasedOnAuthUserState({
|
|
@@ -2525,9 +2537,6 @@ declare function makeAuthTransitionHook(config: AuthTransitionHookConfig): Trans
|
|
|
2525
2537
|
* 'user': '/app'
|
|
2526
2538
|
* });
|
|
2527
2539
|
* ```
|
|
2528
|
-
*
|
|
2529
|
-
* @see {@link AuthTransitionRedirectTargetOrGetter}
|
|
2530
|
-
* @see {@link AuthUserState}
|
|
2531
2540
|
*/
|
|
2532
2541
|
declare function redirectBasedOnAuthUserState(stateMap: ObjectMap<AuthTransitionRedirectTargetOrGetter>): AuthTransitionRedirectTargetGetter;
|
|
2533
2542
|
|
|
@@ -2537,7 +2546,7 @@ declare function redirectBasedOnAuthUserState(stateMap: ObjectMap<AuthTransition
|
|
|
2537
2546
|
* @see {@link AuthTransitionHookOptions} for redirect and timeout configuration.
|
|
2538
2547
|
*/
|
|
2539
2548
|
interface IsLoggedInHookConfig {
|
|
2540
|
-
options: AuthTransitionHookOptions;
|
|
2549
|
+
readonly options: AuthTransitionHookOptions;
|
|
2541
2550
|
}
|
|
2542
2551
|
/**
|
|
2543
2552
|
* UIRouter state `data` interface for states that require the user to be logged in.
|
|
@@ -2687,7 +2696,7 @@ declare function hasAuthRoleDecisionPipe(stateData: HasAuthRoleStateData): Opera
|
|
|
2687
2696
|
* @see {@link AuthTransitionHookOptions} for redirect and timeout configuration.
|
|
2688
2697
|
*/
|
|
2689
2698
|
interface HasAuthStateHookConfig {
|
|
2690
|
-
options: AuthTransitionHookOptions;
|
|
2699
|
+
readonly options: AuthTransitionHookOptions;
|
|
2691
2700
|
}
|
|
2692
2701
|
/**
|
|
2693
2702
|
* Configuration for specifying which {@link AuthUserState} values are allowed or disallowed for a UIRouter state.
|
|
@@ -2719,12 +2728,12 @@ interface HasAuthStateObjectConfig {
|
|
|
2719
2728
|
* Auth user states that are permitted to access this route.
|
|
2720
2729
|
* If specified, only users in one of these states can proceed.
|
|
2721
2730
|
*/
|
|
2722
|
-
allowedStates?: ArrayOrValue<AuthUserState>;
|
|
2731
|
+
readonly allowedStates?: ArrayOrValue<AuthUserState>;
|
|
2723
2732
|
/**
|
|
2724
2733
|
* Auth user states that are explicitly forbidden from accessing this route.
|
|
2725
2734
|
* If the user is in one of these states, the transition is rejected.
|
|
2726
2735
|
*/
|
|
2727
|
-
disallowedStates?: ArrayOrValue<AuthUserState>;
|
|
2736
|
+
readonly disallowedStates?: ArrayOrValue<AuthUserState>;
|
|
2728
2737
|
}
|
|
2729
2738
|
/**
|
|
2730
2739
|
* UIRouter state `data` interface for states that require a specific {@link AuthUserState}.
|
|
@@ -2844,7 +2853,7 @@ interface State$1 {
|
|
|
2844
2853
|
[FEATURE_KEY$1]: DbxAppContextFeatureState;
|
|
2845
2854
|
}
|
|
2846
2855
|
/**
|
|
2847
|
-
* Reducers mapping for the DbxAppContextFeatureState
|
|
2856
|
+
* Reducers mapping for the DbxAppContextFeatureState.
|
|
2848
2857
|
*
|
|
2849
2858
|
* @param state - The current feature state, or undefined for initialization.
|
|
2850
2859
|
* @param action - The dispatched action to reduce.
|
|
@@ -2969,7 +2978,7 @@ declare class DbxAppContextStateDirective {
|
|
|
2969
2978
|
/**
|
|
2970
2979
|
* Creates EnvironmentProviders for providing the DbxAppContext state.
|
|
2971
2980
|
*
|
|
2972
|
-
* @returns EnvironmentProviders
|
|
2981
|
+
* @returns EnvironmentProviders.
|
|
2973
2982
|
*/
|
|
2974
2983
|
declare function provideDbxAppContextState(): EnvironmentProviders;
|
|
2975
2984
|
|
|
@@ -2997,15 +3006,15 @@ interface ProvideDbxAppAuthRouterStateConfig {
|
|
|
2997
3006
|
* @param config - Configuration specifying which app context states activate the auth router effects.
|
|
2998
3007
|
* @returns Angular `EnvironmentProviders` for the auth router state effects.
|
|
2999
3008
|
*
|
|
3009
|
+
* @see {@link provideDbxAppAuth} for the all-in-one provider that includes this.
|
|
3010
|
+
* @see {@link DbxAppAuthRouterEffects} for the effects that handle auth-based navigation.
|
|
3011
|
+
*
|
|
3000
3012
|
* @example
|
|
3001
3013
|
* ```ts
|
|
3002
3014
|
* provideDbxAppAuthRouterState({
|
|
3003
3015
|
* activeRoutesToApplyEffects: ['root']
|
|
3004
3016
|
* });
|
|
3005
3017
|
* ```
|
|
3006
|
-
*
|
|
3007
|
-
* @see {@link provideDbxAppAuth} for the all-in-one provider that includes this.
|
|
3008
|
-
* @see {@link DbxAppAuthRouterEffects} for the effects that handle auth-based navigation.
|
|
3009
3018
|
*/
|
|
3010
3019
|
declare function provideDbxAppAuthRouterState(config: ProvideDbxAppAuthRouterStateConfig): EnvironmentProviders;
|
|
3011
3020
|
|
|
@@ -3021,7 +3030,7 @@ declare abstract class AbstractOnDbxAppContextStateEffects<S = unknown> implemen
|
|
|
3021
3030
|
private _activeStatesSet;
|
|
3022
3031
|
constructor(activeStates: IterableOrValue<DbxAppContextState>);
|
|
3023
3032
|
/**
|
|
3024
|
-
* Configures all actions of the sub-class to only activate when the DbxAppContextState in App
|
|
3033
|
+
* Configures all actions of the sub-class to only activate when the DbxAppContextState in App.
|
|
3025
3034
|
*
|
|
3026
3035
|
* @param resolvedEffects$
|
|
3027
3036
|
* @returns
|
|
@@ -3630,6 +3639,8 @@ interface ProvideDbxAppAuthRouterConfig {
|
|
|
3630
3639
|
* @param config - Configuration containing the auth routes to register.
|
|
3631
3640
|
* @returns Angular `EnvironmentProviders` for the auth router.
|
|
3632
3641
|
*
|
|
3642
|
+
* @see {@link provideDbxAppAuth} for the all-in-one provider that includes this.
|
|
3643
|
+
*
|
|
3633
3644
|
* @example
|
|
3634
3645
|
* ```ts
|
|
3635
3646
|
* provideDbxAppAuthRouter({
|
|
@@ -3639,8 +3650,6 @@ interface ProvideDbxAppAuthRouterConfig {
|
|
|
3639
3650
|
* }
|
|
3640
3651
|
* });
|
|
3641
3652
|
* ```
|
|
3642
|
-
*
|
|
3643
|
-
* @see {@link provideDbxAppAuth} for the all-in-one provider that includes this.
|
|
3644
3653
|
*/
|
|
3645
3654
|
declare function provideDbxAppAuthRouter(config: ProvideDbxAppAuthRouterConfig): EnvironmentProviders;
|
|
3646
3655
|
|
|
@@ -3736,6 +3745,10 @@ interface ProvideDbxAppAuthConfig extends ProvideDbxAppAuthRouterConfig, Provide
|
|
|
3736
3745
|
* @param config - Combined auth configuration including routes and active states for effects.
|
|
3737
3746
|
* @returns Angular `EnvironmentProviders` to be included in the application's provider list.
|
|
3738
3747
|
*
|
|
3748
|
+
* @see {@link provideDbxAppAuthState}
|
|
3749
|
+
* @see {@link provideDbxAppAuthRouter}
|
|
3750
|
+
* @see {@link provideDbxAppAuthRouterState}
|
|
3751
|
+
*
|
|
3739
3752
|
* @example
|
|
3740
3753
|
* ```ts
|
|
3741
3754
|
* // In your app config or module:
|
|
@@ -3747,10 +3760,6 @@ interface ProvideDbxAppAuthConfig extends ProvideDbxAppAuthRouterConfig, Provide
|
|
|
3747
3760
|
* activeRoutesToApplyEffects: ['root']
|
|
3748
3761
|
* });
|
|
3749
3762
|
* ```
|
|
3750
|
-
*
|
|
3751
|
-
* @see {@link provideDbxAppAuthState}
|
|
3752
|
-
* @see {@link provideDbxAppAuthRouter}
|
|
3753
|
-
* @see {@link provideDbxAppAuthRouterState}
|
|
3754
3763
|
*/
|
|
3755
3764
|
declare function provideDbxAppAuth(config: ProvideDbxAppAuthConfig): EnvironmentProviders;
|
|
3756
3765
|
|
|
@@ -4049,16 +4058,17 @@ declare abstract class DbxButton {
|
|
|
4049
4058
|
* Creates Angular providers that register a {@link DbxButton} implementation for DI.
|
|
4050
4059
|
*
|
|
4051
4060
|
* @param sourceType - The concrete button directive or component class to provide.
|
|
4052
|
-
* @returns
|
|
4061
|
+
* @returns Array of Angular providers for the button.
|
|
4053
4062
|
*
|
|
4054
|
-
* @
|
|
4055
|
-
* ```typescript
|
|
4056
|
-
* @Directive({
|
|
4063
|
+
* @Directive ({
|
|
4057
4064
|
* selector: '[myCustomButton]',
|
|
4058
4065
|
* providers: provideDbxButton(MyCustomButtonDirective),
|
|
4059
4066
|
* })
|
|
4060
4067
|
* export class MyCustomButtonDirective extends AbstractDbxButtonDirective {}
|
|
4061
4068
|
* ```
|
|
4069
|
+
*
|
|
4070
|
+
* @example
|
|
4071
|
+
* ```typescript
|
|
4062
4072
|
*/
|
|
4063
4073
|
declare function provideDbxButton<S extends DbxButton>(sourceType: Type<S>): Provider[];
|
|
4064
4074
|
/**
|
|
@@ -4170,15 +4180,15 @@ declare const DBX_ACTION_BUTTON_ECHO_CONFIG: InjectionToken<DbxActionButtonEchoC
|
|
|
4170
4180
|
/**
|
|
4171
4181
|
* Creates a provider for the app-wide {@link DbxActionButtonEchoConfig}.
|
|
4172
4182
|
*
|
|
4183
|
+
* @param config - The echo configuration controlling success/error icon behavior.
|
|
4184
|
+
* @returns An Angular provider that registers the given echo config for all action buttons.
|
|
4185
|
+
*
|
|
4173
4186
|
* @example
|
|
4174
4187
|
* ```typescript
|
|
4175
4188
|
* providers: [
|
|
4176
4189
|
* provideDbxActionButtonEchoConfig({ onSuccess: { icon: 'done', color: 'ok' }, onError: false })
|
|
4177
4190
|
* ]
|
|
4178
4191
|
* ```
|
|
4179
|
-
*
|
|
4180
|
-
* @param config - The echo configuration controlling success/error icon behavior.
|
|
4181
|
-
* @returns An Angular provider that registers the given echo config for all action buttons.
|
|
4182
4192
|
*/
|
|
4183
4193
|
declare function provideDbxActionButtonEchoConfig(config: DbxActionButtonEchoConfig): Provider;
|
|
4184
4194
|
/**
|
|
@@ -4697,7 +4707,7 @@ declare const dbxInjectionComponentConfigIsEqual: EqualityComparatorFunction<May
|
|
|
4697
4707
|
* Provider arrays are concatenated so that all providers from all configs are preserved.
|
|
4698
4708
|
* All other properties are merged with later values taking precedence.
|
|
4699
4709
|
*
|
|
4700
|
-
* @param configs -
|
|
4710
|
+
* @param configs - The partial configs to merge. May contain `undefined`/`null` entries which are filtered out.
|
|
4701
4711
|
* @returns A single merged partial configuration.
|
|
4702
4712
|
*/
|
|
4703
4713
|
declare function mergeDbxInjectionComponentConfigs<T = unknown>(configs: Maybe<Partial<DbxInjectionComponentConfig<T>>>[]): Partial<DbxInjectionComponentConfig<T>>;
|
|
@@ -4899,18 +4909,19 @@ declare abstract class DbxAnchor<T extends ClickableAnchor = ClickableAnchor> {
|
|
|
4899
4909
|
/**
|
|
4900
4910
|
* Creates Angular DI providers that register the given source type as a {@link DbxAnchor} provider using `forwardRef`.
|
|
4901
4911
|
*
|
|
4902
|
-
* @typeParam S - The concrete {@link DbxAnchor} subclass to provide.
|
|
4903
4912
|
* @param sourceType - The class type to register as the anchor provider.
|
|
4904
|
-
* @returns
|
|
4913
|
+
* @returns Array of Angular providers.
|
|
4905
4914
|
*
|
|
4906
|
-
* @
|
|
4907
|
-
*
|
|
4908
|
-
* @Directive({
|
|
4915
|
+
* @typeParam S - The concrete {@link DbxAnchor} subclass to provide.
|
|
4916
|
+
* @Directive ({
|
|
4909
4917
|
* selector: '[myAnchor]',
|
|
4910
4918
|
* providers: provideDbxAnchor(MyAnchorDirective)
|
|
4911
4919
|
* })
|
|
4912
4920
|
* class MyAnchorDirective extends DbxAnchor { ... }
|
|
4913
4921
|
* ```
|
|
4922
|
+
*
|
|
4923
|
+
* @example
|
|
4924
|
+
* ```ts
|
|
4914
4925
|
*/
|
|
4915
4926
|
declare function provideDbxAnchor<S extends DbxAnchor>(sourceType: Type<S>): Provider[];
|
|
4916
4927
|
|
|
@@ -5269,6 +5280,9 @@ declare class DbxUIRouterService implements DbxRouterService, DbxRouterTransitio
|
|
|
5269
5280
|
*
|
|
5270
5281
|
* @returns Angular `EnvironmentProviders` for the UIRouter-based router service.
|
|
5271
5282
|
*
|
|
5283
|
+
* @see {@link DbxUIRouterService}
|
|
5284
|
+
* @see {@link DbxCoreAngularRouterSegueModule} for the Angular Router alternative
|
|
5285
|
+
*
|
|
5272
5286
|
* @example
|
|
5273
5287
|
* ```ts
|
|
5274
5288
|
* bootstrapApplication(AppComponent, {
|
|
@@ -5278,8 +5292,6 @@ declare class DbxUIRouterService implements DbxRouterService, DbxRouterTransitio
|
|
|
5278
5292
|
* });
|
|
5279
5293
|
* ```
|
|
5280
5294
|
*
|
|
5281
|
-
* @see {@link DbxUIRouterService}
|
|
5282
|
-
* @see {@link DbxCoreAngularRouterSegueModule} for the Angular Router alternative
|
|
5283
5295
|
* @__NO_SIDE_EFFECTS__
|
|
5284
5296
|
*/
|
|
5285
5297
|
declare function provideDbxUIRouterService(): EnvironmentProviders;
|
|
@@ -5346,12 +5358,12 @@ interface LatestSuccessfulRoutesConfig<T extends LatestSuccessfulRoutesConfigRou
|
|
|
5346
5358
|
* On each successful router transition, checks all configured routes against the router service
|
|
5347
5359
|
* and emits an array of those that are active. The result is deduplicated by index and shared.
|
|
5348
5360
|
*
|
|
5349
|
-
* @typeParam T - The route configuration type, extending {@link LatestSuccessfulRoutesConfigRoute}.
|
|
5350
5361
|
* @param config - Configuration specifying the router services and routes to monitor.
|
|
5351
5362
|
* @returns An observable emitting an array of the currently active route configurations.
|
|
5352
5363
|
*
|
|
5353
5364
|
* @see {@link LatestSuccessfulRoutesConfig}
|
|
5354
5365
|
* @see {@link isLatestSuccessfulRoute} for a boolean variant
|
|
5366
|
+
* @typeParam T - The route configuration type, extending {@link LatestSuccessfulRoutesConfigRoute}.
|
|
5355
5367
|
*/
|
|
5356
5368
|
declare function latestSuccessfulRoutes<T extends LatestSuccessfulRoutesConfigRoute>(config: LatestSuccessfulRoutesConfig<T>): Observable<T[]>;
|
|
5357
5369
|
/**
|
|
@@ -5545,15 +5557,15 @@ type GoWithRouter = (route: ObservableOrValue<SegueRef>) => Promise<boolean>;
|
|
|
5545
5557
|
* resolves it to a single value, and calls `go()` on the router service.
|
|
5546
5558
|
*
|
|
5547
5559
|
* @param dbxRouterService - The router service to use for navigation.
|
|
5548
|
-
* @returns
|
|
5560
|
+
* @returns Navigates to the given route and returns a promise resolving to the navigation result.
|
|
5561
|
+
*
|
|
5562
|
+
* @see {@link GoWithRouter}
|
|
5549
5563
|
*
|
|
5550
5564
|
* @example
|
|
5551
5565
|
* ```ts
|
|
5552
5566
|
* const navigate = goWithRouter(routerService);
|
|
5553
5567
|
* await navigate({ ref: 'app.dashboard' });
|
|
5554
5568
|
* ```
|
|
5555
|
-
*
|
|
5556
|
-
* @see {@link GoWithRouter}
|
|
5557
5569
|
*/
|
|
5558
5570
|
declare function goWithRouter(dbxRouterService: DbxRouterService): (route: ObservableOrValue<SegueRefOrSegueRefRouterLink>) => Promise<boolean>;
|
|
5559
5571
|
|
|
@@ -5672,15 +5684,15 @@ declare class DbxRouteParamDefaultRedirectInstance<T> implements Initialized, De
|
|
|
5672
5684
|
/**
|
|
5673
5685
|
* Default identifier used by dbxRouteModelIdParamRedirect() that corresponds to the id param of the model in the current route.
|
|
5674
5686
|
*/
|
|
5675
|
-
declare const
|
|
5687
|
+
declare const DEFAULT_DBX_ROUTE_MODEL_ID_PARAM_ID_PARAM_KEY = "id";
|
|
5676
5688
|
/**
|
|
5677
5689
|
* Default identifier used by dbxRouteModelIdParamRedirect() that corresponds to the key param of the model in the current route.
|
|
5678
5690
|
*/
|
|
5679
|
-
declare const
|
|
5691
|
+
declare const DEFAULT_DBX_ROUTE_MODEL_ID_PARAM_KEY_PARAM_KEY = "key";
|
|
5680
5692
|
/**
|
|
5681
5693
|
* Default value used by dbxRouteModelIdParamRedirect() for when a value is not available or provided.
|
|
5682
5694
|
*/
|
|
5683
|
-
declare const
|
|
5695
|
+
declare const DEFAULT_DBX_ROUTE_MODEL_ID_PARAM_USE_PARAM_VALUE = "0";
|
|
5684
5696
|
/**
|
|
5685
5697
|
* Reads a model identifier from the current route by parameter key, with support for automatic
|
|
5686
5698
|
* redirect when the parameter matches a placeholder value (e.g., `'0'`).
|
|
@@ -5794,11 +5806,11 @@ declare abstract class DbxRouteModelIdDirectiveDelegate {
|
|
|
5794
5806
|
/**
|
|
5795
5807
|
* Creates Angular DI providers that register the given source type as a {@link DbxRouteModelIdDirectiveDelegate}.
|
|
5796
5808
|
*
|
|
5797
|
-
* @typeParam S - The concrete delegate class type to register.
|
|
5798
5809
|
* @param sourceType - The class to provide as the delegate.
|
|
5799
|
-
* @returns
|
|
5810
|
+
* @returns Array of Angular providers.
|
|
5800
5811
|
*
|
|
5801
5812
|
* @see {@link DbxRouteModelIdDirectiveDelegate}
|
|
5813
|
+
* @typeParam S - The concrete delegate class type to register.
|
|
5802
5814
|
*/
|
|
5803
5815
|
declare function provideDbxRouteModelIdDirectiveDelegate<S extends DbxRouteModelIdDirectiveDelegate>(sourceType: Type<S>): Provider[];
|
|
5804
5816
|
/**
|
|
@@ -5835,11 +5847,11 @@ declare abstract class DbxRouteModelKeyDirectiveDelegate {
|
|
|
5835
5847
|
/**
|
|
5836
5848
|
* Creates Angular DI providers that register the given source type as a {@link DbxRouteModelKeyDirectiveDelegate}.
|
|
5837
5849
|
*
|
|
5838
|
-
* @typeParam S - The concrete delegate class type to register.
|
|
5839
5850
|
* @param sourceType - The class to provide as the delegate.
|
|
5840
|
-
* @returns
|
|
5851
|
+
* @returns Array of Angular providers.
|
|
5841
5852
|
*
|
|
5842
5853
|
* @see {@link DbxRouteModelKeyDirectiveDelegate}
|
|
5854
|
+
* @typeParam S - The concrete delegate class type to register.
|
|
5843
5855
|
*/
|
|
5844
5856
|
declare function provideDbxRouteModelKeyDirectiveDelegate<S extends DbxRouteModelKeyDirectiveDelegate>(sourceType: Type<S>): Provider[];
|
|
5845
5857
|
|
|
@@ -6558,7 +6570,7 @@ declare abstract class AbstractFilterSourceConnectorDirective<F> implements Filt
|
|
|
6558
6570
|
/**
|
|
6559
6571
|
* DI token for providing a default filter value to {@link AbstractFilterSourceDirective}.
|
|
6560
6572
|
*/
|
|
6561
|
-
declare const
|
|
6573
|
+
declare const DEFAULT_FILTER_SOURCE_DIRECTIVE_FILTER_TOKEN: InjectionToken<Maybe<Observable<unknown>>>;
|
|
6562
6574
|
/**
|
|
6563
6575
|
* Abstract class defining the contract for a filter source directive that can be set, reset, and initialized with filters.
|
|
6564
6576
|
*
|
|
@@ -6582,23 +6594,24 @@ type ProvideFilterSourceDirectiveDefaultFilterFactoryFunction<F = unknown> = (in
|
|
|
6582
6594
|
*
|
|
6583
6595
|
* @param sourceType - The concrete directive class.
|
|
6584
6596
|
* @param defaultFilterFactory - Optional factory to provide an initial filter value via DI.
|
|
6585
|
-
* @returns
|
|
6597
|
+
* @returns Array of Angular providers for the filter source directive.
|
|
6586
6598
|
*
|
|
6587
|
-
* @
|
|
6588
|
-
* ```typescript
|
|
6589
|
-
* @Directive({
|
|
6599
|
+
* @Directive ({
|
|
6590
6600
|
* selector: '[myFilterSource]',
|
|
6591
6601
|
* providers: provideFilterSourceDirective(MyFilterSourceDirective),
|
|
6592
6602
|
* })
|
|
6593
6603
|
* export class MyFilterSourceDirective extends AbstractFilterSourceDirective<MyFilter> {}
|
|
6594
6604
|
* ```
|
|
6605
|
+
*
|
|
6606
|
+
* @example
|
|
6607
|
+
* ```typescript
|
|
6595
6608
|
*/
|
|
6596
6609
|
declare function provideFilterSourceDirective<S extends FilterSourceDirective<F>, F = unknown>(sourceType: Type<S>, defaultFilterFactory?: ProvideFilterSourceDirectiveDefaultFilterFactoryFunction): Provider[];
|
|
6597
6610
|
/**
|
|
6598
6611
|
* Abstract directive providing a complete {@link FilterSource} implementation backed by a {@link FilterSourceInstance}.
|
|
6599
6612
|
*
|
|
6600
6613
|
* Supports setting/resetting filters, initializing from an external observable, and providing
|
|
6601
|
-
* a default filter via the {@link
|
|
6614
|
+
* a default filter via the {@link DEFAULT_FILTER_SOURCE_DIRECTIVE_FILTER_TOKEN} DI token.
|
|
6602
6615
|
*
|
|
6603
6616
|
* @typeParam F - The filter type.
|
|
6604
6617
|
*/
|
|
@@ -6664,23 +6677,24 @@ declare class DbxFilterSourceConnectorDirective<F = unknown> extends AbstractFil
|
|
|
6664
6677
|
* Creates Angular providers that register a {@link FilterSource} implementation for DI.
|
|
6665
6678
|
*
|
|
6666
6679
|
* @param sourceType - The concrete filter source class to provide.
|
|
6667
|
-
* @returns
|
|
6680
|
+
* @returns Array of Angular providers for the filter source.
|
|
6668
6681
|
*
|
|
6669
|
-
* @
|
|
6670
|
-
* ```typescript
|
|
6671
|
-
* @Directive({
|
|
6682
|
+
* @Directive ({
|
|
6672
6683
|
* selector: '[myFilterSource]',
|
|
6673
6684
|
* providers: provideFilterSource(MyFilterSourceDirective),
|
|
6674
6685
|
* })
|
|
6675
6686
|
* export class MyFilterSourceDirective { ... }
|
|
6676
6687
|
* ```
|
|
6688
|
+
*
|
|
6689
|
+
* @example
|
|
6690
|
+
* ```typescript
|
|
6677
6691
|
*/
|
|
6678
6692
|
declare function provideFilterSource<S extends FilterSource>(sourceType: Type<S>): Provider[];
|
|
6679
6693
|
/**
|
|
6680
6694
|
* Creates Angular providers that register both a {@link FilterSourceConnector} and {@link FilterSource} for DI.
|
|
6681
6695
|
*
|
|
6682
6696
|
* @param sourceType - The concrete connector class to provide.
|
|
6683
|
-
* @returns
|
|
6697
|
+
* @returns Array of Angular providers for the filter source connector.
|
|
6684
6698
|
*/
|
|
6685
6699
|
declare function provideFilterSourceConnector<S extends FilterSourceConnector>(sourceType: Type<S>): Provider[];
|
|
6686
6700
|
|
|
@@ -6796,7 +6810,7 @@ declare class DbxFilterMapDirective<F> {
|
|
|
6796
6810
|
* @dbxFilter
|
|
6797
6811
|
* @dbxFilterSlug clickable-preset
|
|
6798
6812
|
* @dbxFilterRelated source
|
|
6799
|
-
* @dbxFilterSkillRefs
|
|
6813
|
+
* @dbxFilterSkillRefs dbx-component-patterns
|
|
6800
6814
|
*
|
|
6801
6815
|
* @typeParam F - The filter type, which must include a preset field.
|
|
6802
6816
|
* @typeParam P - The preset string identifier type.
|
|
@@ -6817,7 +6831,7 @@ interface ClickableFilterPreset<F extends FilterWithPreset<P>, P extends string
|
|
|
6817
6831
|
*
|
|
6818
6832
|
* A null value or empty object is used for reset.
|
|
6819
6833
|
*/
|
|
6820
|
-
readonly presetValue: GetterOrValue<FilterWithPresetOptional<F>> | EmptyObject
|
|
6834
|
+
readonly presetValue: Maybe<GetterOrValue<FilterWithPresetOptional<F>> | EmptyObject>;
|
|
6821
6835
|
}
|
|
6822
6836
|
/**
|
|
6823
6837
|
* Type guard that checks if an object is a {@link ClickableFilterPreset}.
|
|
@@ -6840,7 +6854,7 @@ interface ClickablePartialFilterPreset<F> extends Pick<ClickableAnchorLink, 'tit
|
|
|
6840
6854
|
*
|
|
6841
6855
|
* A null value or empty object is used for no change.
|
|
6842
6856
|
*/
|
|
6843
|
-
readonly partialPresetValue: GetterOrValue<Partial<F>> | EmptyObject
|
|
6857
|
+
readonly partialPresetValue: Maybe<GetterOrValue<Partial<F>> | EmptyObject>;
|
|
6844
6858
|
/**
|
|
6845
6859
|
* The current value to test against. Returns true if this partial preset is considered active.
|
|
6846
6860
|
*/
|
|
@@ -7054,12 +7068,12 @@ interface DbxInjectionContextConfig<T = unknown, O = unknown> {
|
|
|
7054
7068
|
/**
|
|
7055
7069
|
* The {@link DbxInjectionComponentConfig} describing which component to create and how to configure it.
|
|
7056
7070
|
*/
|
|
7057
|
-
config: DbxInjectionComponentConfig<T>;
|
|
7071
|
+
readonly config: DbxInjectionComponentConfig<T>;
|
|
7058
7072
|
/**
|
|
7059
7073
|
* Callback invoked with the created component instance. The returned promise controls how long
|
|
7060
7074
|
* the injected view remains visible; the original content is restored once it resolves.
|
|
7061
7075
|
*/
|
|
7062
|
-
use: (instance: T) => Promise<O>;
|
|
7076
|
+
readonly use: (instance: T) => Promise<O>;
|
|
7063
7077
|
}
|
|
7064
7078
|
/**
|
|
7065
7079
|
* Abstract service for temporarily replacing a view's content with a dynamically injected component,
|
|
@@ -7085,7 +7099,7 @@ declare abstract class DbxInjectionContext {
|
|
|
7085
7099
|
* @typeParam T - The type of the injected component.
|
|
7086
7100
|
* @typeParam O - The return type of the `use` promise.
|
|
7087
7101
|
* @param config - The context configuration describing the component and usage callback.
|
|
7088
|
-
* @returns
|
|
7102
|
+
* @returns Resolves to the value from `config.use`.
|
|
7089
7103
|
*/
|
|
7090
7104
|
abstract showContext<T = unknown, O = unknown>(config: DbxInjectionContextConfig<T>): Promise<O>;
|
|
7091
7105
|
/**
|
|
@@ -7102,9 +7116,10 @@ declare abstract class DbxInjectionContext {
|
|
|
7102
7116
|
* This enables dependency injection consumers to request `DbxInjectionContext` and receive
|
|
7103
7117
|
* the specific directive or service implementation.
|
|
7104
7118
|
*
|
|
7105
|
-
* @typeParam T - The concrete type that extends {@link DbxInjectionContext}.
|
|
7106
7119
|
* @param type - The concrete class to register as the existing provider.
|
|
7107
|
-
* @returns
|
|
7120
|
+
* @returns Array of Angular providers.
|
|
7121
|
+
*
|
|
7122
|
+
* @typeParam T - The concrete type that extends {@link DbxInjectionContext}.
|
|
7108
7123
|
*/
|
|
7109
7124
|
declare function provideDbxInjectionContext<T extends DbxInjectionContext>(type: Type<T>): Provider[];
|
|
7110
7125
|
|
|
@@ -7161,7 +7176,7 @@ declare class DbxInjectionContextDirective<O = unknown> implements DbxInjectionC
|
|
|
7161
7176
|
* {@inheritDoc DbxInjectionContext.showContext}
|
|
7162
7177
|
*
|
|
7163
7178
|
* @param config - The injection context configuration describing the component and its usage.
|
|
7164
|
-
* @returns
|
|
7179
|
+
* @returns Resolves to the output of the injected component's usage.
|
|
7165
7180
|
*/
|
|
7166
7181
|
showContext<T, O>(config: DbxInjectionContextConfig<T>): Promise<O>;
|
|
7167
7182
|
/**
|
|
@@ -7209,7 +7224,7 @@ declare abstract class AbstractForwardDbxInjectionContextDirective implements Db
|
|
|
7209
7224
|
* {@inheritDoc DbxInjectionContext.showContext}
|
|
7210
7225
|
*
|
|
7211
7226
|
* @param config - The injection context configuration to forward to the host context.
|
|
7212
|
-
* @returns
|
|
7227
|
+
* @returns Resolves to the output of the injected component's usage.
|
|
7213
7228
|
*/
|
|
7214
7229
|
showContext<T = unknown, O = unknown>(config: DbxInjectionContextConfig<T, unknown>): Promise<O>;
|
|
7215
7230
|
/**
|
|
@@ -7277,12 +7292,12 @@ declare class DbxInjectionInstance<T> implements Initialized, Destroyable {
|
|
|
7277
7292
|
* This is useful for reactive streams where an upstream value may indicate "use the default component"
|
|
7278
7293
|
* rather than providing an explicit configuration.
|
|
7279
7294
|
*
|
|
7280
|
-
* @typeParam T - The specific {@link DbxInjectionComponentConfig} subtype.
|
|
7281
|
-
* @typeParam X - The component type.
|
|
7282
7295
|
* @param defaultConfig - A static value, getter, or component class to use as the fallback config.
|
|
7283
7296
|
* @returns An RxJS operator compatible with `pipe()`.
|
|
7284
7297
|
*
|
|
7285
7298
|
* @see {@link DbxInjectionComponentConfig}
|
|
7299
|
+
* @typeParam T - The specific {@link DbxInjectionComponentConfig} subtype.
|
|
7300
|
+
* @typeParam X - The component type.
|
|
7286
7301
|
*
|
|
7287
7302
|
* @example
|
|
7288
7303
|
* ```typescript
|
|
@@ -7370,11 +7385,12 @@ type InjectableType<T> = (Type<T> | AbstractType<T>) & Provider;
|
|
|
7370
7385
|
* This is a convenience for one-off instantiation of an injectable class using a specific
|
|
7371
7386
|
* parent injector, without needing to manually configure `Injector.create()`.
|
|
7372
7387
|
*
|
|
7373
|
-
* @typeParam T - The type to instantiate.
|
|
7374
7388
|
* @param type - The injectable class to provide and resolve.
|
|
7375
7389
|
* @param parent - The parent injector that supplies the type's dependencies.
|
|
7376
7390
|
* @returns A new instance of `T`.
|
|
7377
7391
|
*
|
|
7392
|
+
* @typeParam T - The type to instantiate.
|
|
7393
|
+
*
|
|
7378
7394
|
* @example
|
|
7379
7395
|
* ```typescript
|
|
7380
7396
|
* const service = newWithInjector(MyService, parentInjector);
|
|
@@ -7633,8 +7649,8 @@ declare class SimpleStorageAccessor<T> implements StorageAccessor<T> {
|
|
|
7633
7649
|
* @typeParam T - The type of values the created accessor will store.
|
|
7634
7650
|
*/
|
|
7635
7651
|
interface StorageAccessorFactoryConfig<T> extends SimpleStorageAccessorConfig {
|
|
7636
|
-
storage?: StorageAccessor<StoredDataString>;
|
|
7637
|
-
converter?: SimpleStorageAccessorConverter<T>;
|
|
7652
|
+
readonly storage?: StorageAccessor<StoredDataString>;
|
|
7653
|
+
readonly converter?: SimpleStorageAccessorConverter<T>;
|
|
7638
7654
|
}
|
|
7639
7655
|
/**
|
|
7640
7656
|
* Injectable factory for creating namespaced {@link SimpleStorageAccessor} instances
|
|
@@ -7718,7 +7734,7 @@ declare class FullLocalStorageObject implements FullStorageObject {
|
|
|
7718
7734
|
getItem(key: StoredDataStorageKey): Maybe<string>;
|
|
7719
7735
|
setItem(key: StoredDataStorageKey, item: string): void;
|
|
7720
7736
|
removeItem(key: StoredDataStorageKey): void;
|
|
7721
|
-
key(index: number): string
|
|
7737
|
+
key(index: number): Maybe<string>;
|
|
7722
7738
|
removeAll(): string[];
|
|
7723
7739
|
}
|
|
7724
7740
|
|
|
@@ -7776,17 +7792,20 @@ declare function provideDbxStorage(): EnvironmentProviders;
|
|
|
7776
7792
|
*
|
|
7777
7793
|
* Must be run in an Angular injection context.
|
|
7778
7794
|
*
|
|
7795
|
+
* @param input - The Destroyable object or destroy function to register for cleanup.
|
|
7796
|
+
* @returns The same input, for chaining.
|
|
7797
|
+
*
|
|
7779
7798
|
* @example
|
|
7799
|
+
* ```ts
|
|
7780
7800
|
* // Clean up a Destroyable object (e.g., SubscriptionObject, LockSet):
|
|
7781
7801
|
* const sub = new SubscriptionObject(obs$.subscribe(handler));
|
|
7782
7802
|
* clean(sub);
|
|
7783
|
-
*
|
|
7803
|
+
* ```
|
|
7784
7804
|
* @example
|
|
7805
|
+
* ```ts
|
|
7785
7806
|
* // Clean up a destroy function directly:
|
|
7786
7807
|
* clean(() => resource.release());
|
|
7787
|
-
*
|
|
7788
|
-
* @param input - The Destroyable object or destroy function to register for cleanup.
|
|
7789
|
-
* @returns The same input, for chaining.
|
|
7808
|
+
* ```
|
|
7790
7809
|
*/
|
|
7791
7810
|
declare function clean<T extends Destroyable | DestroyFunction>(input: T): T;
|
|
7792
7811
|
/**
|
|
@@ -7795,16 +7814,19 @@ declare function clean<T extends Destroyable | DestroyFunction>(input: T): T;
|
|
|
7795
7814
|
*
|
|
7796
7815
|
* Must be run in an Angular injection context.
|
|
7797
7816
|
*
|
|
7817
|
+
* @param input - The Subject to register for completion on destroy.
|
|
7818
|
+
* @returns The same input, for chaining.
|
|
7819
|
+
*
|
|
7798
7820
|
* @example
|
|
7821
|
+
* ```ts
|
|
7799
7822
|
* // Complete a BehaviorSubject when the component is destroyed:
|
|
7800
7823
|
* readonly value$ = completeOnDestroy(new BehaviorSubject<string>('initial'));
|
|
7801
|
-
*
|
|
7824
|
+
* ```
|
|
7802
7825
|
* @example
|
|
7826
|
+
* ```ts
|
|
7803
7827
|
* // Complete a ReplaySubject when the component is destroyed:
|
|
7804
7828
|
* readonly events$ = completeOnDestroy(new ReplaySubject<Event>(1));
|
|
7805
|
-
*
|
|
7806
|
-
* @param input - The Subject to register for completion on destroy.
|
|
7807
|
-
* @returns The same input, for chaining.
|
|
7829
|
+
* ```
|
|
7808
7830
|
*/
|
|
7809
7831
|
declare function completeOnDestroy<T extends Pick<Subject<unknown>, 'complete' | 'error'>>(input: T): T;
|
|
7810
7832
|
|
|
@@ -7841,14 +7863,17 @@ type CleanLockSet = LockSet & {
|
|
|
7841
7863
|
* @returns A CleanLockSet that is automatically destroyed when the context is destroyed.
|
|
7842
7864
|
*
|
|
7843
7865
|
* @example
|
|
7866
|
+
* ```ts
|
|
7844
7867
|
* // Create a simple lockset:
|
|
7845
7868
|
* readonly lockSet = cleanLockSet();
|
|
7846
|
-
*
|
|
7869
|
+
* ```
|
|
7847
7870
|
* @example
|
|
7871
|
+
* ```ts
|
|
7848
7872
|
* // Create with a callback when the lockset is destroyed:
|
|
7849
7873
|
* readonly lockSet = cleanLockSet({
|
|
7850
7874
|
* onLockSetDestroy: () => console.log('lockset destroyed')
|
|
7851
7875
|
* });
|
|
7876
|
+
* ```
|
|
7852
7877
|
*/
|
|
7853
7878
|
declare function cleanLockSet(config?: Maybe<CleanLockSetConfig>): CleanLockSet;
|
|
7854
7879
|
/**
|
|
@@ -7856,12 +7881,14 @@ declare function cleanLockSet(config?: Maybe<CleanLockSetConfig>): CleanLockSet;
|
|
|
7856
7881
|
*
|
|
7857
7882
|
* Must be run within an Angular injection context.
|
|
7858
7883
|
*
|
|
7859
|
-
* @param lockSet The lockset to use.
|
|
7860
|
-
* @param onDestroy The function to run when the lockset is unlocked.
|
|
7884
|
+
* @param lockSet - The lockset to use.
|
|
7885
|
+
* @param onDestroy - The function to run when the lockset is unlocked.
|
|
7861
7886
|
*
|
|
7862
7887
|
* @example
|
|
7888
|
+
* ```ts
|
|
7863
7889
|
* // Defer cleanup until the lockset unlocks after component destroy:
|
|
7864
7890
|
* cleanWithLockSet(this.lockSet, () => resource.release());
|
|
7891
|
+
* ```
|
|
7865
7892
|
*/
|
|
7866
7893
|
declare function cleanWithLockSet(lockSet: LockSet, onDestroy: DestroyFunction): void;
|
|
7867
7894
|
/**
|
|
@@ -7878,20 +7905,23 @@ interface CleanSubscriptionWithLockSetConfig<T extends Unsubscribable = Unsubscr
|
|
|
7878
7905
|
*
|
|
7879
7906
|
* Must be run within an Angular injection context.
|
|
7880
7907
|
*
|
|
7908
|
+
* @param input - Configuration specifying the lock set and optional initial subscription.
|
|
7909
|
+
* @returns A SubscriptionObject that is destroyed when the context is destroyed and the lock set unlocks.
|
|
7910
|
+
*
|
|
7881
7911
|
* @example
|
|
7912
|
+
* ```ts
|
|
7882
7913
|
* // Pass a subscription that waits for the lockset to unlock before cleanup:
|
|
7883
7914
|
* readonly _sub = cleanSubscriptionWithLockSet({
|
|
7884
7915
|
* lockSet: this.lockSet,
|
|
7885
7916
|
* sub: obs$.subscribe(handler)
|
|
7886
7917
|
* });
|
|
7887
|
-
*
|
|
7918
|
+
* ```
|
|
7888
7919
|
* @example
|
|
7920
|
+
* ```ts
|
|
7889
7921
|
* // Create first, then set the subscription later:
|
|
7890
7922
|
* readonly _sub = cleanSubscriptionWithLockSet({ lockSet: this.lockSet });
|
|
7891
7923
|
* this._sub.subscription = obs$.subscribe(handler);
|
|
7892
|
-
*
|
|
7893
|
-
* @param input - Configuration specifying the lock set and optional initial subscription.
|
|
7894
|
-
* @returns A SubscriptionObject that is destroyed when the context is destroyed and the lock set unlocks.
|
|
7924
|
+
* ```
|
|
7895
7925
|
*/
|
|
7896
7926
|
declare function cleanSubscriptionWithLockSet<T extends Unsubscribable = Unsubscribable>(input: CleanSubscriptionWithLockSetConfig<T>): SubscriptionObject<T>;
|
|
7897
7927
|
|
|
@@ -7900,16 +7930,17 @@ declare function cleanSubscriptionWithLockSet<T extends Unsubscribable = Unsubsc
|
|
|
7900
7930
|
*
|
|
7901
7931
|
* Must be run within an Angular injection context.
|
|
7902
7932
|
*
|
|
7933
|
+
* @param sub - Optional subscription or getter to wrap.
|
|
7934
|
+
* @returns A SubscriptionObject that is automatically destroyed when the context is destroyed.
|
|
7935
|
+
*
|
|
7903
7936
|
* @example
|
|
7937
|
+
* ```ts
|
|
7904
7938
|
* // Pass a subscription directly - it will be cleaned up automatically:
|
|
7905
7939
|
* cleanSubscription(obs$.subscribe(handler));
|
|
7906
|
-
*
|
|
7907
7940
|
* // Or create first, then set the subscription later:
|
|
7908
7941
|
* readonly _sub = cleanSubscription();
|
|
7909
7942
|
* this._sub.subscription = obs$.subscribe(handler);
|
|
7910
|
-
*
|
|
7911
|
-
* @param sub - Optional subscription or getter to wrap.
|
|
7912
|
-
* @returns A SubscriptionObject that is automatically destroyed when the context is destroyed.
|
|
7943
|
+
* ```
|
|
7913
7944
|
*/
|
|
7914
7945
|
declare function cleanSubscription<T extends Unsubscribable = Unsubscribable>(sub?: Maybe<GetterOrValue<T>>): SubscriptionObject<T>;
|
|
7915
7946
|
|
|
@@ -7918,17 +7949,20 @@ declare function cleanSubscription<T extends Unsubscribable = Unsubscribable>(su
|
|
|
7918
7949
|
*
|
|
7919
7950
|
* Must be run within an Angular injection context.
|
|
7920
7951
|
*
|
|
7952
|
+
* @param input - Optional loading state context input configuration.
|
|
7953
|
+
* @returns A mutable loading state context that is automatically destroyed on cleanup.
|
|
7954
|
+
*
|
|
7921
7955
|
* @example
|
|
7956
|
+
* ```ts
|
|
7922
7957
|
* // Create with an observable source:
|
|
7923
7958
|
* readonly context = cleanLoadingContext<MyData>(this.data$);
|
|
7924
|
-
*
|
|
7959
|
+
* ```
|
|
7925
7960
|
* @example
|
|
7961
|
+
* ```ts
|
|
7926
7962
|
* // Create empty, then set the observable source later:
|
|
7927
7963
|
* readonly context = cleanLoadingContext<MyData>();
|
|
7928
7964
|
* this.context.obs = this.data$;
|
|
7929
|
-
*
|
|
7930
|
-
* @param input - Optional loading state context input configuration.
|
|
7931
|
-
* @returns A mutable loading state context that is automatically destroyed on cleanup.
|
|
7965
|
+
* ```
|
|
7932
7966
|
*/
|
|
7933
7967
|
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>;
|
|
7934
7968
|
/**
|
|
@@ -7936,17 +7970,20 @@ declare function cleanLoadingContext<T = unknown, S extends LoadingState<T> = Lo
|
|
|
7936
7970
|
*
|
|
7937
7971
|
* Must be run within an Angular injection context.
|
|
7938
7972
|
*
|
|
7973
|
+
* @param input - Optional list loading state context input configuration.
|
|
7974
|
+
* @returns A mutable list loading state context that is automatically destroyed on cleanup.
|
|
7975
|
+
*
|
|
7939
7976
|
* @example
|
|
7977
|
+
* ```ts
|
|
7940
7978
|
* // Create with an observable source:
|
|
7941
7979
|
* readonly listContext = cleanListLoadingContext<MyItem>(this.items$);
|
|
7942
|
-
*
|
|
7980
|
+
* ```
|
|
7943
7981
|
* @example
|
|
7982
|
+
* ```ts
|
|
7944
7983
|
* // Create empty, then set the observable source later:
|
|
7945
7984
|
* readonly listContext = cleanListLoadingContext<MyItem>();
|
|
7946
7985
|
* this.listContext.obs = this.items$;
|
|
7947
|
-
*
|
|
7948
|
-
* @param input - Optional list loading state context input configuration.
|
|
7949
|
-
* @returns A mutable list loading state context that is automatically destroyed on cleanup.
|
|
7986
|
+
* ```
|
|
7950
7987
|
*/
|
|
7951
7988
|
declare function cleanListLoadingContext<L = unknown, S extends ListLoadingState<L> = ListLoadingState<L>>(input?: ListLoadingStateContextInput<L, S>): MutableListLoadingStateContext<L, S>;
|
|
7952
7989
|
|
|
@@ -7955,31 +7992,81 @@ declare function cleanListLoadingContext<L = unknown, S extends ListLoadingState
|
|
|
7955
7992
|
*
|
|
7956
7993
|
* Must be run within an Angular injection context.
|
|
7957
7994
|
*
|
|
7995
|
+
* @param input - Optional destroy function to wrap.
|
|
7996
|
+
* @returns A DestroyFunctionObject that will be automatically destroyed when the context is destroyed.
|
|
7997
|
+
*
|
|
7958
7998
|
* @example
|
|
7999
|
+
* ```ts
|
|
7959
8000
|
* // Pass a destroy function directly:
|
|
7960
8001
|
* cleanDestroy(() => resource.release());
|
|
7961
|
-
*
|
|
8002
|
+
* ```
|
|
7962
8003
|
* @example
|
|
8004
|
+
* ```ts
|
|
7963
8005
|
* // Create first, then set the destroy function later:
|
|
7964
8006
|
* readonly _destroy = cleanDestroy();
|
|
7965
8007
|
* this._destroy.setDestroyFunction(() => resource.release());
|
|
7966
|
-
*
|
|
7967
|
-
* @param input - Optional destroy function to wrap.
|
|
7968
|
-
* @returns A DestroyFunctionObject that will be automatically destroyed when the context is destroyed.
|
|
8008
|
+
* ```
|
|
7969
8009
|
*/
|
|
7970
8010
|
declare function cleanDestroy(input?: Maybe<DestroyFunction>): DestroyFunctionObject;
|
|
7971
8011
|
|
|
8012
|
+
/**
|
|
8013
|
+
* Checks whether an `ng-content` wrapper element received any projected content from its parent.
|
|
8014
|
+
*
|
|
8015
|
+
* Returns `true` if the element has any child nodes, even if the projected content is empty.
|
|
8016
|
+
* Useful for conditionally showing fallback content when no projection is provided.
|
|
8017
|
+
*
|
|
8018
|
+
* @param ref - Reference to the wrapper element around `ng-content`.
|
|
8019
|
+
* @returns `true` if the wrapper element has any child nodes.
|
|
8020
|
+
*
|
|
8021
|
+
* @ViewChild ('contentWrapper', { static: false }) contentRef: ElementRef;
|
|
8022
|
+
*
|
|
8023
|
+
* get hasContent(): boolean {
|
|
8024
|
+
* return checkNgContentWrapperHasContent(this.contentRef);
|
|
8025
|
+
* }
|
|
8026
|
+
* ```
|
|
8027
|
+
*
|
|
8028
|
+
* @example
|
|
8029
|
+
* ```typescript
|
|
8030
|
+
* // In the component class:
|
|
8031
|
+
* @example
|
|
8032
|
+
* ```html
|
|
8033
|
+
* <!-- In the component template: -->
|
|
8034
|
+
* <div #contentWrapper>
|
|
8035
|
+
* <ng-content select="[content]"></ng-content>
|
|
8036
|
+
* </div>
|
|
8037
|
+
* <div *ngIf="!hasContent">No content provided</div>
|
|
8038
|
+
* ```
|
|
8039
|
+
*/
|
|
8040
|
+
declare function checkNgContentWrapperHasContent(ref: Maybe<ElementRef<Element>>): boolean;
|
|
8041
|
+
/**
|
|
8042
|
+
* Checks whether an element has any meaningful child nodes (non-whitespace text or element nodes).
|
|
8043
|
+
*
|
|
8044
|
+
* Useful for detecting whether projected content was provided to a component by checking
|
|
8045
|
+
* the host element's child nodes at construction time, before Angular moves them for content projection.
|
|
8046
|
+
*
|
|
8047
|
+
* @param element - The host element to check.
|
|
8048
|
+
* @returns `true` if the element has at least one element child or non-whitespace text node.
|
|
8049
|
+
*
|
|
8050
|
+
* @example
|
|
8051
|
+
* ```typescript
|
|
8052
|
+
* constructor() {
|
|
8053
|
+
* const el = inject(ElementRef<HTMLElement>);
|
|
8054
|
+
* this._hasProjectedContent = hasNonTrivialChildNodes(el.nativeElement);
|
|
8055
|
+
* }
|
|
8056
|
+
* ```
|
|
8057
|
+
*/
|
|
8058
|
+
declare function hasNonTrivialChildNodes(element: HTMLElement): boolean;
|
|
7972
8059
|
/**
|
|
7973
8060
|
* RxJS operator that triggers `detectChanges()` on a `ChangeDetectorRef` after each emission.
|
|
7974
8061
|
*
|
|
7975
8062
|
* Wraps the detection call in a `setTimeout` to avoid triggering it during change detection cycles.
|
|
7976
8063
|
*
|
|
7977
|
-
* @deprecated Use Angular signals instead.
|
|
7978
|
-
*
|
|
7979
8064
|
* @param cdRef - The change detector to trigger. If `null`/`undefined`, the operator is a no-op.
|
|
7980
8065
|
* @param timeout - Delay in milliseconds before calling `detectChanges`.
|
|
7981
8066
|
* @returns An RxJS operator that triggers change detection on each emission.
|
|
7982
8067
|
*
|
|
8068
|
+
* @deprecated Use Angular signals instead.
|
|
8069
|
+
*
|
|
7983
8070
|
* @example
|
|
7984
8071
|
* ```typescript
|
|
7985
8072
|
* this.data$.pipe(tapDetectChanges(this.cdRef)).subscribe();
|
|
@@ -7989,9 +8076,9 @@ declare function tapDetectChanges<T>(cdRef: Maybe<ChangeDetectorRef>, timeout?:
|
|
|
7989
8076
|
/**
|
|
7990
8077
|
* Safely calls `detectChanges()` on a `ChangeDetectorRef`, skipping the call if the view is already destroyed.
|
|
7991
8078
|
*
|
|
7992
|
-
* @deprecated Use Angular signals instead.
|
|
7993
|
-
*
|
|
7994
8079
|
* @param cdRef - The change detector to trigger.
|
|
8080
|
+
*
|
|
8081
|
+
* @deprecated Use Angular signals instead.
|
|
7995
8082
|
*/
|
|
7996
8083
|
declare function safeDetectChanges(cdRef: ChangeDetectorRef): void;
|
|
7997
8084
|
/**
|
|
@@ -8000,12 +8087,12 @@ declare function safeDetectChanges(cdRef: ChangeDetectorRef): void;
|
|
|
8000
8087
|
* Intended for components using `OnPush` change detection that subscribe to observables
|
|
8001
8088
|
* outside of the `async` pipe. Not needed when using the `async` pipe.
|
|
8002
8089
|
*
|
|
8003
|
-
* @deprecated Use Angular signals instead.
|
|
8004
|
-
*
|
|
8005
8090
|
* @param cdRef - The change detector to mark. If `null`/`undefined`, the operator is a no-op.
|
|
8006
8091
|
* @param timeout - Delay in milliseconds before calling `markForCheck`.
|
|
8007
8092
|
* @returns An RxJS operator that marks the view for check on each emission.
|
|
8008
8093
|
*
|
|
8094
|
+
* @deprecated Use Angular signals instead.
|
|
8095
|
+
*
|
|
8009
8096
|
* @example
|
|
8010
8097
|
* ```typescript
|
|
8011
8098
|
* this.data$.pipe(tapSafeMarkForCheck(this.cdRef)).subscribe();
|
|
@@ -8015,67 +8102,20 @@ declare function tapSafeMarkForCheck<T>(cdRef: Maybe<ChangeDetectorRef>, timeout
|
|
|
8015
8102
|
/**
|
|
8016
8103
|
* Safely calls `markForCheck()` on a `ChangeDetectorRef`, skipping the call if the view is already destroyed.
|
|
8017
8104
|
*
|
|
8018
|
-
* @deprecated Use Angular signals instead.
|
|
8019
|
-
*
|
|
8020
8105
|
* @param cdRef - The change detector to mark.
|
|
8106
|
+
*
|
|
8107
|
+
* @deprecated Use Angular signals instead.
|
|
8021
8108
|
*/
|
|
8022
8109
|
declare function safeMarkForCheck(cdRef: ChangeDetectorRef): void;
|
|
8023
8110
|
/**
|
|
8024
8111
|
* Executes a callback with the given `ChangeDetectorRef` only if its view has not been destroyed.
|
|
8025
8112
|
*
|
|
8026
|
-
* @deprecated Use Angular signals instead.
|
|
8027
|
-
*
|
|
8028
8113
|
* @param cdRef - The change detector to guard.
|
|
8029
8114
|
* @param use - Callback to invoke with the change detector.
|
|
8030
|
-
*/
|
|
8031
|
-
declare function safeUseCdRef(cdRef: ChangeDetectorRef, use: (cdRef: ChangeDetectorRef) => void): void;
|
|
8032
|
-
/**
|
|
8033
|
-
* Checks whether an `ng-content` wrapper element received any projected content from its parent.
|
|
8034
|
-
*
|
|
8035
|
-
* Returns `true` if the element has any child nodes, even if the projected content is empty.
|
|
8036
|
-
* Useful for conditionally showing fallback content when no projection is provided.
|
|
8037
8115
|
*
|
|
8038
|
-
* @
|
|
8039
|
-
* @returns `true` if the wrapper element has any child nodes.
|
|
8040
|
-
*
|
|
8041
|
-
* @example
|
|
8042
|
-
* ```typescript
|
|
8043
|
-
* // In the component class:
|
|
8044
|
-
* @ViewChild('contentWrapper', { static: false }) contentRef: ElementRef;
|
|
8045
|
-
*
|
|
8046
|
-
* get hasContent(): boolean {
|
|
8047
|
-
* return checkNgContentWrapperHasContent(this.contentRef);
|
|
8048
|
-
* }
|
|
8049
|
-
* ```
|
|
8050
|
-
*
|
|
8051
|
-
* @example
|
|
8052
|
-
* ```html
|
|
8053
|
-
* <!-- In the component template: -->
|
|
8054
|
-
* <div #contentWrapper>
|
|
8055
|
-
* <ng-content select="[content]"></ng-content>
|
|
8056
|
-
* </div>
|
|
8057
|
-
* <div *ngIf="!hasContent">No content provided</div>
|
|
8058
|
-
* ```
|
|
8059
|
-
*/
|
|
8060
|
-
declare function checkNgContentWrapperHasContent(ref: Maybe<ElementRef<Element>>): boolean;
|
|
8061
|
-
/**
|
|
8062
|
-
* Checks whether an element has any meaningful child nodes (non-whitespace text or element nodes).
|
|
8063
|
-
*
|
|
8064
|
-
* Useful for detecting whether projected content was provided to a component by checking
|
|
8065
|
-
* the host element's child nodes at construction time, before Angular moves them for content projection.
|
|
8066
|
-
*
|
|
8067
|
-
* @param element - The host element to check.
|
|
8068
|
-
* @returns `true` if the element has at least one element child or non-whitespace text node.
|
|
8069
|
-
*
|
|
8070
|
-
* @example
|
|
8071
|
-
* ```typescript
|
|
8072
|
-
* constructor() {
|
|
8073
|
-
* const el = inject(ElementRef<HTMLElement>);
|
|
8074
|
-
* this._hasProjectedContent = hasNonTrivialChildNodes(el.nativeElement);
|
|
8075
|
-
* }
|
|
8076
|
-
* ```
|
|
8116
|
+
* @deprecated Use Angular signals instead.
|
|
8077
8117
|
*/
|
|
8078
|
-
declare function
|
|
8118
|
+
declare function safeUseCdRef(cdRef: ChangeDetectorRef, use: (cdRef: ChangeDetectorRef) => void): void;
|
|
8079
8119
|
|
|
8080
8120
|
/**
|
|
8081
8121
|
* Angular input transform that converts an empty string to `undefined`.
|
|
@@ -8086,16 +8126,17 @@ declare function hasNonTrivialChildNodes(element: HTMLElement): boolean;
|
|
|
8086
8126
|
* @param value - The input value to transform.
|
|
8087
8127
|
* @returns The original value, or `undefined` if the value is an empty string.
|
|
8088
8128
|
*
|
|
8089
|
-
* @
|
|
8090
|
-
* ```typescript
|
|
8091
|
-
* @Directive({ selector: '[appHighlight]' })
|
|
8129
|
+
* @Directive ({ selector: '[appHighlight]' })
|
|
8092
8130
|
* export class HighlightDirective {
|
|
8093
8131
|
* @Input({ alias: 'appHighlight', transform: transformEmptyStringInputToUndefined })
|
|
8094
8132
|
* color?: string;
|
|
8095
8133
|
* }
|
|
8096
8134
|
* ```
|
|
8135
|
+
*
|
|
8136
|
+
* @example
|
|
8137
|
+
* ```typescript
|
|
8097
8138
|
*/
|
|
8098
8139
|
declare const transformEmptyStringInputToUndefined: <T>(value: T | "") => T | undefined;
|
|
8099
8140
|
|
|
8100
|
-
export { ACTION_CONTEXT_STORE_LOCKSET_DESTROY_DELAY_TIME, APP_ACTION_DISABLED_DIRECTIVE_KEY, APP_ACTION_DISABLED_ON_SUCCESS_DIRECTIVE_KEY, APP_ACTION_ENFORCE_MODIFIED_DIRECTIVE_KEY, AbstractDbxActionHandlerDirective, AbstractDbxActionValueGetterDirective, AbstractDbxAnchorDirective, AbstractDbxButtonDirective, AbstractDbxFilterMapInstanceDirective, AbstractDbxFilterMapSourceDirective, AbstractDbxInjectionDirective, AbstractFilterSourceConnectorDirective, AbstractFilterSourceDirective, AbstractForwardDbxInjectionContextDirective, AbstractIfDirective, AbstractTransitionDirective, AbstractTransitionWatcherDirective, ActionContextStore, ActionContextStoreSource, ActionContextStoreSourceMap, AsObservablePipe, CutTextPipe, DBX_ACTION_BUTTON_ECHO_CONFIG, DBX_ACTION_HANDLER_LOCK_KEY, DBX_APP_APP_CONTEXT_STATE, DBX_APP_AUTH_ROUTER_EFFECTS_TOKEN, DBX_ASSET_LOADER_CONFIG_TOKEN, DBX_AUTH_APP_CONTEXT_STATE, DBX_INIT_APP_CONTEXT_STATE, DBX_INJECTION_COMPONENT_DATA, DBX_KNOWN_APP_CONTEXT_STATES, DBX_OAUTH_APP_CONTEXT_STATE, DBX_ONBOARD_APP_CONTEXT_STATE, DBX_PUBLIC_APP_CONTEXT_STATE,
|
|
8141
|
+
export { ACTION_CONTEXT_STORE_LOCKSET_DESTROY_DELAY_TIME, APP_ACTION_DISABLED_DIRECTIVE_KEY, APP_ACTION_DISABLED_ON_SUCCESS_DIRECTIVE_KEY, APP_ACTION_ENFORCE_MODIFIED_DIRECTIVE_KEY, AbstractDbxActionHandlerDirective, AbstractDbxActionValueGetterDirective, AbstractDbxAnchorDirective, AbstractDbxButtonDirective, AbstractDbxFilterMapInstanceDirective, AbstractDbxFilterMapSourceDirective, AbstractDbxInjectionDirective, AbstractFilterSourceConnectorDirective, AbstractFilterSourceDirective, AbstractForwardDbxInjectionContextDirective, AbstractIfDirective, AbstractTransitionDirective, AbstractTransitionWatcherDirective, ActionContextStore, ActionContextStoreSource, ActionContextStoreSourceMap, AsObservablePipe, CutTextPipe, DBX_ACTION_BUTTON_ECHO_CONFIG, DBX_ACTION_HANDLER_LOCK_KEY, DBX_APP_APP_CONTEXT_STATE, DBX_APP_AUTH_ROUTER_EFFECTS_TOKEN, DBX_ASSET_LOADER_CONFIG_TOKEN, DBX_AUTH_APP_CONTEXT_STATE, DBX_INIT_APP_CONTEXT_STATE, DBX_INJECTION_COMPONENT_DATA, DBX_KNOWN_APP_CONTEXT_STATES, DBX_OAUTH_APP_CONTEXT_STATE, DBX_ONBOARD_APP_CONTEXT_STATE, DBX_PUBLIC_APP_CONTEXT_STATE, DEFAULT_ACTION_DISABLED_KEY, DEFAULT_ACTION_MAP_WORKING_DISABLED_KEY, DEFAULT_DBX_ACTION_BUTTON_ECHO_CONFIG, DEFAULT_DBX_ACTION_BUTTON_ERROR_ECHO, DEFAULT_DBX_ACTION_BUTTON_SUCCESS_ECHO, DEFAULT_DBX_BUTTON_ECHO_DURATION, DEFAULT_DBX_ROUTE_MODEL_ID_PARAM_ID_PARAM_KEY, DEFAULT_DBX_ROUTE_MODEL_ID_PARAM_KEY_PARAM_KEY, DEFAULT_DBX_ROUTE_MODEL_ID_PARAM_USE_PARAM_VALUE, DEFAULT_FILTER_SOURCE_DIRECTIVE_FILTER_TOKEN, DEFAULT_LOCAL_ASSET_BASE_URL, DEFAULT_REDIRECT_FOR_IDENTIFIER_PARAM_KEY, DEFAULT_REDIRECT_FOR_IDENTIFIER_PARAM_VALUE, DEFAULT_REDIRECT_FOR_USER_IDENTIFIER_PARAM_KEY, DEFAULT_REDIRECT_FOR_USER_IDENTIFIER_PARAM_VALUE, DEFAULT_STORAGE_ACCESSOR_FACTORY_TOKEN, DEFAULT_STORAGE_OBJECT_TOKEN, DateDayRangePipe, DateDayTimeRangePipe, DateDistancePipe, DateFormatDistancePipe, DateFormatFromToPipe, DateRangeDistancePipe, DateTimeRangeOnlyDistancePipe, DateTimeRangeOnlyPipe, DateTimeRangePipe, DbxActionAutoModifyDirective, DbxActionAutoTriggerDirective, DbxActionButtonDirective, DbxActionButtonTriggerDirective, DbxActionContextBaseSource, DbxActionContextLoggerDirective, DbxActionContextMachine, DbxActionContextMachineAsService, DbxActionContextMapDirective, DbxActionContextStoreSourceInstance, DbxActionDirective, DbxActionDisabledDirective, DbxActionDisabledOnSuccessDirective, DbxActionEnforceModifiedDirective, DbxActionErrorHandlerDirective, DbxActionFromMapDirective, DbxActionHandlerDirective, DbxActionHandlerInstance, DbxActionHandlerValueDirective, DbxActionHasSuccessDirective, DbxActionIdleDirective, DbxActionIsModifiedDirective, DbxActionIsWorkingDirective, DbxActionMapSourceDirective, DbxActionMapWorkingDisableDirective, DbxActionPreSuccessDirective, DbxActionSourceDirective, DbxActionState, DbxActionSuccessHandlerDirective, DbxActionTriggeredDirective, DbxActionValueDirective, DbxActionValueGetterInstance, DbxActionValueStreamDirective, DbxActionValueTriggerDirective, DbxActionWorkInstanceDelegate, DbxAnchor, DbxAngularRouterService, DbxAppAuthRouterEffects, DbxAppAuthRouterService, DbxAppAuthRoutes, DbxAppAuthStateService, DbxAppContextService, DbxAppContextStateDirective, DbxAppEnvironment, DbxAppEnvironmentService, DbxAuthHasAnyRoleDirective, DbxAuthHasRolesDirective, DbxAuthNotAnyRoleDirective, DbxAuthService, DbxButton, DbxButtonDirective, DbxButtonSegueDirective, DbxCoreActionModule, DbxCoreAngularRouterSegueModule, DbxCoreAssetLoader, DbxCoreButtonModule, DbxCoreFilterModule, DbxFilterConnectSourceDirective, DbxFilterMapDirective, DbxFilterMapSourceConnectorDirective, DbxFilterMapSourceDirective, DbxFilterSourceConnectorDirective, DbxFilterSourceDirective, DbxInjectionArrayComponent, DbxInjectionComponent, DbxInjectionContext, DbxInjectionContextDirective, DbxInjectionInstance, DbxLoadingButtonDirective, DbxRouteModelIdDirective, DbxRouteModelIdDirectiveDelegate, DbxRouteModelIdFromAuthUserIdDirective, DbxRouteModelKeyDirective, DbxRouteModelKeyDirectiveDelegate, DbxRouteParamDefaultRedirectInstance, DbxRouterService, DbxRouterTransitionEventType, DbxRouterTransitionService, DbxUIRouterService, DollarAmountPipe, FilterSourceDirective, FullLocalStorageObject, GetValueOncePipe, GetValuePipe, InstantStorageAccessor, LimitedStorageAccessor, LockSetComponentStore, MemoryStorageObject, MinutesStringPipe, NO_AUTH_USER_IDENTIFIER, PrettyJsonPipe, SecondaryActionContextStoreSource, SimpleStorageAccessor, SimpleStorageAccessorFactory, StorageAccessor, StringStorageAccessor, StringifySimpleStorageAccessorConverter, SystemDateToTargetDatePipe, TargetDateToSystemDatePipe, TimeDistanceCountdownPipe, TimeDistancePipe, TimezoneAbbreviationPipe, ToJsDatePipe, ToMinutesPipe, WrapperSimpleStorageAccessorDelegate, actionContextHasNoErrorAndIsModifiedAndCanTrigger, actionContextIsModifiedAndCanTrigger, actionContextStoreSourceMap, actionContextStoreSourceMapReader, actionContextStoreSourcePipe, anchorTypeForAnchor, asSegueRef, asSegueRefString, assertValidStorageKeyPrefix, authRolesSetContainsAllRolesFrom, authRolesSetContainsAnyRoleFrom, authRolesSetContainsNoRolesFrom, authUserIdentifier, canReadyValue, canTriggerAction, canTriggerActionState, checkNgContentWrapperHasContent, clean, cleanDestroy, cleanListLoadingContext, cleanLoadingContext, cleanLockSet, cleanSubscription, cleanSubscriptionWithLockSet, cleanWithLockSet, clickableUrlInNewTab, clickableUrlMailTo, clickableUrlTel, completeOnDestroy, createInjectorForInjectionComponentConfig, dbxActionWorkProgress, dbxButtonDisplayType, dbxInjectionComponentConfigIsEqual, dbxRouteModelIdParamRedirect, dbxRouteModelKeyParamRedirect, dbxRouteParamReaderInstance, defaultStorageObjectFactory, enableHasAuthRoleHook, enableHasAuthStateHook, enableIsLoggedInHook, expandClickableAnchorLinkTree, expandClickableAnchorLinkTreeNode, expandClickableAnchorLinkTrees, filterTransitionEvent, filterTransitionSuccess, flattenExpandedClickableAnchorLinkTree, flattenExpandedClickableAnchorLinkTreeToLinks, fromAllActionContextStoreSourceMapSources, index_d$1 as fromDbxAppAuth, index_d$3 as fromDbxAppContext, goWithRouter, hasAuthRoleDecisionPipe, hasNonTrivialChildNodes, initInjectionComponent, isActionContextDisabled, isActionContextEnabled, isClickableFilterPreset, isClickablePartialFilterPreset, isDisabledActionContextState, isIdleActionState, isLatestSuccessfulRoute, isSegueRef, isSegueRefActive, isSegueRefActiveFunction, isSegueRefActiveOnTransitionSuccess, isValidStorageKeyPrefix, isWorkingActionState, latestSuccessfulRoutes, loadingStateForActionContextState, loadingStateTypeForActionContextState, loadingStateTypeForActionState, loggedInObsFromIsLoggedIn, loggedOutObsFromIsLoggedIn, makeAuthTransitionHook, makeDbxActionContextSourceReference, mapRefStringObsToSegueRefObs, mergeDbxInjectionComponentConfigs, mergeStaticProviders, newWithInjector, index_d as onDbxAppAuth, index_d$2 as onDbxAppContext, onRouterTransitionEventType, onRouterTransitionSuccessEvent, pipeActionStore, provideActionStoreSource, provideDbxActionButtonEchoConfig, provideDbxAnchor, provideDbxAppAuth, provideDbxAppAuthRouter, provideDbxAppAuthRouterState, provideDbxAppAuthState, provideDbxAppContextState, provideDbxAppEnvironment, provideDbxAssetLoader, provideDbxButton, provideDbxInjectionContext, provideDbxRouteModelIdDirectiveDelegate, provideDbxRouteModelKeyDirectiveDelegate, provideDbxStorage, provideDbxUIRouterService, provideFilterSource, provideFilterSourceConnector, provideFilterSourceDirective, provideSecondaryActionStoreSource, redirectBasedOnAuthUserState, redirectForIdentifierParamHook, redirectForUserIdentifierParamHook, refStringToSegueRef, safeDetectChanges, safeMarkForCheck, safeUseCdRef, successTransition, switchMapDbxInjectionComponentConfig, tapDetectChanges, tapSafeMarkForCheck, transformEmptyStringInputToUndefined, useActionStore };
|
|
8101
8142
|
export type { ActionContextState, ActionContextStoreSourceMapReader, ActionKey, AuthTransitionDecision, AuthTransitionDecisionGetterInput, AuthTransitionHookConfig, AuthTransitionHookOptions, AuthTransitionRedirectTarget, AuthTransitionRedirectTargetGetter, AuthTransitionRedirectTargetOrGetter, AuthTransitionStateData, AuthUserIdentifier, AuthUserState, CleanLockSet, CleanLockSetConfig, CleanSubscriptionWithLockSetConfig, ClickableAnchor, ClickableAnchorLink, ClickableAnchorLinkSegueRef, ClickableAnchorLinkTree, ClickableAnchorType, ClickableFilterPreset, ClickableFilterPresetOrPartialPreset, ClickableFunction, ClickableIconAnchorLink, ClickablePartialFilterPreset, ClickableUrl, DbxActionButtonEchoConfig, DbxActionContextMachineConfig, DbxActionContextSourceReference, DbxActionDisabledKey, DbxActionErrorHandlerFunction, DbxActionRejectedPair, DbxActionSuccessHandlerFunction, DbxActionSuccessPair, DbxActionValueGetterDirectiveComputeInputsConfig, DbxActionValueGetterInstanceConfig, DbxActionValueGetterResult, DbxActionValueGetterValueGetterFunction, DbxActionWorkOrWorkProgress, DbxActionWorkProgress, DbxAppAuthFullState, DbxAppContextFullState, DbxAppContextState, DbxButtonDisplay, DbxButtonDisplayDelegate, DbxButtonDisplayType, DbxButtonEcho, DbxButtonInterceptor, DbxButtonWorking, DbxButtonWorkingProgress, DbxCoreAssetLoaderConfig, DbxInjectionArrayEntry, DbxInjectionComponentConfig, DbxInjectionComponentConfigFactory, DbxInjectionComponentConfigWithoutInjector, DbxInjectionComponentInjectorParams, DbxInjectionContextConfig, DbxInjectionTemplateConfig, DbxKnownAppContextState, DbxRouteModelIdParamRedirect, DbxRouteModelIdParamRedirectInstance, DbxRouteParamReader, DbxRouteParamReaderInstance, DbxRouterTransitionEvent, ExpandedClickableAnchorLinkTree, GoWithRouter, HasAuthRoleHookConfig, HasAuthRoleStateData, HasAuthRoleStateRoleConfig, HasAuthStateConfig, HasAuthStateData, HasAuthStateHookConfig, HasAuthStateObjectConfig, IconAndTitle, InjectableType, IsLatestSuccessfulRouteConfig, IsLoggedInHookConfig, IsLoggedInStateData, IsSegueRefActiveConfig, IsSegueRefActiveFunction, IsSegueRefActiveFunctionConfig, LatestSuccessfulRoutesConfig, LatestSuccessfulRoutesConfigRoute, LockSetComponent, LockSetComponentStoreConfig, MousableFunction, MouseEventPair, MouseEventType, NoAuthUserIdentifier, ParsedHasAuthRoleStateRoleConfig, PipeActionStoreFunction, ProvideDbxAppAuthConfig, ProvideDbxAppAuthRouterConfig, ProvideDbxAppAuthRouterStateConfig, ProvideFilterSourceDirectiveDefaultFilterFactoryFunction, RedirectForIdentifierParamHookInput, RedirectForUserIdentifierParamHookInput, SegueRef, SegueRefOptions, SegueRefOrSegueRefRouterLink, SegueRefRawSegueParams, SegueRefRouterLink, SimpleStorageAccessorConfig, SimpleStorageAccessorConverter, SimpleStorageAccessorDelegate, StorageAccessorFactoryConfig, UseActionStoreFunction };
|