@dereekb/dbx-core 8.1.2 → 8.4.0

package/lib/router/router/index.d.ts

@@ -1,3 +1,4 @@
 export * from './provider';
 export * from './transition';
 export * from './service';
+export * from './util';

package/lib/router/router/provider/angular/angular.router.service.d.ts

@@ -1,4 +1,5 @@
 import { Observable } from 'rxjs';
+import { ObservableOrValue } from '@dereekb/rxjs';
 import { DbxRouterService, DbxRouterTransitionService } from '../../service';
 import { SegueRefOrSegueRefRouterLink, SegueRefRawSegueParams } from '../../../segue';
 import { DbxRouterTransitionEvent } from '../../transition/transition';
@@ -13,7 +14,8 @@ export declare class DbxAngularRouterService implements DbxRouterService, DbxRou
     readonly params$: Observable<SegueRefRawSegueParams>;
     readonly transitions$: Observable<DbxRouterTransitionEvent>;
     constructor(router: Router, activatedRoute: ActivatedRoute);
-    go(input: SegueRefOrSegueRefRouterLink<NavigationExtras | NavigationBehaviorOptions>): Promise<boolean>;
+    go(input: ObservableOrValue<SegueRefOrSegueRefRouterLink<NavigationExtras | NavigationBehaviorOptions>>): Promise<boolean>;
+    updateParams(inputParams: ObservableOrValue<SegueRefRawSegueParams>): Promise<boolean>;
     isActive(segueRef: SegueRefOrSegueRefRouterLink): boolean;
     comparePrecision(a: SegueRefOrSegueRefRouterLink, b: SegueRefOrSegueRefRouterLink): number;
     static ɵfac: i0.ɵɵFactoryDeclaration<DbxAngularRouterService, never>;

package/lib/router/router/provider/uirouter/uirouter.router.service.d.ts

@@ -1,8 +1,10 @@
+import { Observable } from 'rxjs';
 import { DbxRouterService, DbxRouterTransitionService } from '../../service';
 import { SegueRefOrSegueRefRouterLink, SegueRefRawSegueParams } from '../../../segue';
 import { StateService, UIRouterGlobals, TransitionOptions, TransitionService } from '@uirouter/core';
 import { OnDestroy } from '@angular/core';
 import { DbxRouterTransitionEvent } from '../../transition/transition';
+import { ObservableOrValue } from '@dereekb/rxjs';
 import * as i0 from "@angular/core";
 /**
  * UIRouter implementation of DbxRouterService and DbxRouterTransitionService.
@@ -12,13 +14,14 @@ export declare class DbxUIRouterService implements DbxRouterService, DbxRouterTr
     readonly transitionService: TransitionService;
     readonly uiRouterGlobals: UIRouterGlobals;
     private readonly _params;
-    readonly params$: import("rxjs").Observable<SegueRefRawSegueParams>;
+    readonly params$: Observable<SegueRefRawSegueParams>;
     private readonly _transitions;
-    readonly transitions$: import("rxjs").Observable<DbxRouterTransitionEvent>;
+    readonly transitions$: Observable<DbxRouterTransitionEvent>;
     constructor(state: StateService, transitionService: TransitionService, uiRouterGlobals: UIRouterGlobals);
     ngOnDestroy(): void;
     get params(): import("@uirouter/core").StateParams;
-    go(input: SegueRefOrSegueRefRouterLink<TransitionOptions>): Promise<boolean>;
+    go(input: ObservableOrValue<SegueRefOrSegueRefRouterLink<TransitionOptions>>): Promise<boolean>;
+    updateParams(inputParams: ObservableOrValue<SegueRefRawSegueParams>): Promise<boolean>;
     isActive(input: SegueRefOrSegueRefRouterLink): boolean;
     comparePrecision(aInput: SegueRefOrSegueRefRouterLink, bInput: SegueRefOrSegueRefRouterLink): number;
     static ɵfac: i0.ɵɵFactoryDeclaration<DbxUIRouterService, never>;

package/lib/router/router/service/router.service.d.ts

@@ -15,6 +15,12 @@ export declare abstract class DbxRouterService {
      * @param segueRef
      */
     abstract go(segueRef: ObservableOrValue<SegueRefOrSegueRefRouterLink>): Promise<boolean>;
+    /**
+     * Navigates to the current url with updated parameters. Will be merged with the existing parameters.
+     *
+     * @param segueRef
+     */
+    abstract updateParams(params: ObservableOrValue<SegueRefRawSegueParams>): Promise<boolean>;
     /**
      * Returns true if the input segue ref is considered active.
      *

package/lib/router/router/util/index.d.ts

@@ -0,0 +1,2 @@
+export * from './route.reader';
+export * from './route.default';

package/lib/router/router/util/route.default.d.ts

@@ -0,0 +1,20 @@
+import { DbxRouteParamReaderInstance } from './route.reader';
+import { Destroyable, Initialized, Maybe } from '@dereekb/util';
+import { SwitchMapToDefaultFilterFunction } from '@dereekb/rxjs';
+/**
+ * Utility class used in conjuction with a DbxRouteParamReaderInstance to redirect when the default param does not equal the
+ */
+export declare class DbxRouteParamDefaultRedirectInstance<T> implements Initialized, Destroyable {
+    readonly instance: DbxRouteParamReaderInstance<T>;
+    private _enabled;
+    private _useDefaultFilter;
+    private _sub;
+    constructor(instance: DbxRouteParamReaderInstance<T>);
+    init(): void;
+    destroy(): void;
+    protected redirectWithDefaultValue(value: Maybe<T>): Promise<boolean>;
+    protected redirectWithValue(value: Maybe<T>): Promise<boolean>;
+    get enabled(): boolean;
+    set enabled(enabled: boolean);
+    setUseDefaultFilter(useValueFilter: Maybe<SwitchMapToDefaultFilterFunction<T>>): void;
+}

package/lib/router/router/util/route.reader.d.ts

@@ -0,0 +1,52 @@
+import { MaybeObservableOrValueGetter } from '@dereekb/rxjs';
+import { Destroyable, Maybe } from '@dereekb/util';
+import { Observable } from 'rxjs';
+import { DbxRouterService } from '../service/router.service';
+/**
+ * Interface used for reading a single value from the DbxRouterService. Supports a default value.
+ */
+export interface DbxRouteParamReader<T> {
+    /**
+     * The param value as read from the current router state.
+     */
+    readonly paramValue$: Observable<Maybe<T>>;
+    /**
+     * The default value observable.
+     */
+    readonly defaultValue$: Observable<Maybe<T>>;
+    /**
+     * The final computed value
+     */
+    readonly value$: Observable<Maybe<T>>;
+    /**
+     * Param key getter/setters.
+     */
+    get paramKey(): string;
+    set paramKey(paramKey: Maybe<string>);
+    /**
+     * Sets the default value source.
+     *
+     * @param defaultValue
+     */
+    setDefaultValue(defaultValue: MaybeObservableOrValueGetter<T>): void;
+}
+/**
+ * Utility class used for reading a single value from the DbxRouterService.
+ */
+export declare class DbxRouteParamReaderInstance<T> implements DbxRouteParamReader<T>, Destroyable {
+    readonly dbxRouterService: DbxRouterService;
+    readonly defaultParamKey: string;
+    readonly defaultValue?: MaybeObservableOrValueGetter<T>;
+    private _paramKey;
+    readonly paramKey$: Observable<string>;
+    private _defaultValue;
+    readonly paramValue$: Observable<Maybe<T>>;
+    readonly nextDefaultValue$: Observable<Maybe<T>>;
+    readonly defaultValue$: Observable<Maybe<T>>;
+    readonly value$: Observable<Maybe<T>>;
+    constructor(dbxRouterService: DbxRouterService, defaultParamKey: string, defaultValue?: MaybeObservableOrValueGetter<T>);
+    destroy(): void;
+    get paramKey(): string;
+    set paramKey(paramKey: Maybe<string>);
+    setDefaultValue(defaultValue: MaybeObservableOrValueGetter<T>): void;
+}

package/package.json

@@ -1,18 +1,18 @@
 {
   "name": "@dereekb/dbx-core",
-  "version": "8.1.2",
+  "version": "8.4.0",
   "peerDependencies": {
     "@angular/common": "^13.0.0",
     "@angular/core": "^13.0.0",
-    "@dereekb/util": "8.1.2",
-    "@dereekb/rxjs": "8.1.2",
+    "@dereekb/util": "8.4.0",
+    "@dereekb/rxjs": "8.4.0",
     "@ngrx/component-store": "^13.0.2",
     "@angular/platform-browser": "^13.0.0",
     "@ngrx/effects": "^13.0.2",
     "@ngrx/store": "^13.0.2",
     "@uirouter/core": "^6.0.8",
     "date-fns": "^2.28.0",
-    "@dereekb/date": "8.1.2",
+    "@dereekb/date": "8.4.0",
     "@angular/router": "^13.0.0"
   },
   "dependencies": {