@dereekb/dbx-core 12.4.5 → 12.5.0

package/lib/action/action.d.ts

@@ -1,5 +1,25 @@
 import { LoadingStateType } from '@dereekb/rxjs';
-import { type Maybe } from '@dereekb/util';
+import { type PercentNumber, type Maybe } from '@dereekb/util';
+/**
+ * Used to denote the percent progress of a working action.
+ *
+ * This is a PercentNumber, a number between 0 and 100.
+ */
+export type DbxActionWorkProgress = PercentNumber;
+/**
+ * Used for denoting working state or progress.
+ *
+ * True is working, but no progress level.
+ */
+export type DbxActionWorkOrWorkProgress = boolean | DbxActionWorkProgress;
+/**
+ * Creates a working progress value from an array of working progress values.
+ *
+ * @param workOrWorkProgress The array of working progress values to use.
+ * @param progressPercent An optional progress percent value to use if the working progress is a boolean.
+ * @returns The working progress value.
+ */
+export declare function dbxActionWorkProgress(workOrWorkProgress: Maybe<DbxActionWorkOrWorkProgress>[], progressPercent?: Maybe<DbxActionWorkProgress>): number | boolean;
 /**
  * Used by ActionContextState to denote what state the action is in.
  */

package/lib/action/action.store.d.ts

@@ -3,7 +3,7 @@ import { ComponentStore } from '@ngrx/component-store';
 import { Observable } from 'rxjs';
 import { BooleanStringKeyArray, Maybe, ReadableError } from '@dereekb/util';
 import { LoadingStateType, LoadingState, LockSet } from '@dereekb/rxjs';
-import { DbxActionRejectedPair, DbxActionState, DbxActionSuccessPair } from './action';
+import { DbxActionRejectedPair, DbxActionState, DbxActionSuccessPair, DbxActionWorkOrWorkProgress, DbxActionWorkProgress } from './action';
 import * as i0 from "@angular/core";
 export declare function isActionContextEnabled(state: ActionContextState): boolean;
 export declare function isActionContextDisabled(state: ActionContextState): boolean;
@@ -22,6 +22,12 @@ export interface ActionContextState<T = unknown, O = unknown> {
      * Whether or not this action is flagged as having been modified.
      */
     readonly isModified: boolean;
+    /**
+     * The working progress of the action.
+     *
+     * Is reset to null when triggered/ready value is set.
+     */
+    readonly workProgress?: Maybe<DbxActionWorkProgress>;
     /**
      * Value that is set after a triggered action. Not to be confused with result.
      */
@@ -75,6 +81,10 @@ export declare class ActionContextStore<T = unknown, O = unknown> extends Compon
      * Pipes the readied value on ValueReady.
      */
     readonly valueReady$: Observable<T>;
+    /**
+     * Pipes the working progress on the working state.
+     */
+    readonly workProgress$: Observable<Maybe<number>>;
     /**
      * Pipes the error on the rejection state.
      */
@@ -91,6 +101,10 @@ export declare class ActionContextStore<T = unknown, O = unknown> extends Compon
      * Whether or not it is currently in a working state.
      */
     readonly isWorking$: Observable<boolean>;
+    /**
+     * Pipes the current work or work progress.
+     */
+    readonly isWorkingOrWorkProgress$: Observable<DbxActionWorkOrWorkProgress>;
     /**
      * Pipes the current error.
      */
@@ -166,6 +180,10 @@ export declare class ActionContextStore<T = unknown, O = unknown> extends Compon
      * Notifys the context that the action is in progress.
      */
     readonly startWorking: () => void;
+    /**
+     * Updates the working progress.
+     */
+    readonly setWorkProgress: (() => void) | ((observableOrValue: Maybe<number> | Observable<Maybe<number>>) => import("rxjs").Subscription);
     /**
      * Triggers rejection of the action. The value is cleared.
      */

package/lib/action/action.store.source.d.ts

@@ -1,8 +1,8 @@
 import { Observable, Subscription } from 'rxjs';
-import { LockSet, LoadingState, LoadingStateType } from '@dereekb/rxjs';
+import { LockSet, LoadingState, LoadingStateType, MaybeObservableOrValue } from '@dereekb/rxjs';
 import { Destroyable, Maybe, ReadableError } from '@dereekb/util';
 import { ActionContextState, ActionContextStore } from './action.store';
-import { DbxActionDisabledKey, DbxActionRejectedPair, DbxActionState, DbxActionSuccessPair } from './action';
+import { DbxActionDisabledKey, DbxActionRejectedPair, DbxActionState, DbxActionSuccessPair, DbxActionWorkOrWorkProgress, DbxActionWorkProgress } from './action';
 /**
  * Source that provides a ActionContextStore observable.
  */
@@ -45,6 +45,7 @@ export declare class DbxActionContextStoreSourceInstance<T = unknown, O = unknow
     get valueReady$(): Observable<T>;
     get success$(): Observable<Maybe<O>>;
     get successPair$(): Observable<DbxActionSuccessPair<T, O>>;
+    get workProgress$(): Observable<Maybe<DbxActionWorkProgress>>;
     get error$(): Observable<Maybe<ReadableError>>;
     get rejected$(): Observable<Maybe<ReadableError>>;
     get rejectedPair$(): Observable<DbxActionRejectedPair<T>>;
@@ -56,6 +57,7 @@ export declare class DbxActionContextStoreSourceInstance<T = unknown, O = unknow
     get loadingState$(): Observable<LoadingState<O>>;
     get loadingStateType$(): Observable<LoadingStateType>;
     get isWorking$(): Observable<boolean>;
+    get isWorkingOrWorkProgress$(): Observable<DbxActionWorkOrWorkProgress>;
     get isSuccess$(): Observable<boolean>;
     get disabledKeys$(): Observable<string[]>;
     get isDisabled$(): Observable<boolean>;
@@ -64,6 +66,7 @@ export declare class DbxActionContextStoreSourceInstance<T = unknown, O = unknow
     disable(key?: DbxActionDisabledKey, disable?: boolean): void;
     setIsSame(isSame?: boolean | Observable<boolean> | Observable<void>): void;
     setIsModified(isModified?: boolean | Observable<boolean> | Observable<void>): void;
+    setWorkProgress(workProgress: MaybeObservableOrValue<DbxActionWorkProgress>): void;
     trigger(): void;
     triggerWithValue(value: T | Observable<T>): void;
     readyValue(value: T | Observable<T>): void;

package/lib/button/button.d.ts

@@ -1,6 +1,16 @@
 import { Type, Provider } from '@angular/core';
 import { type Maybe } from '@dereekb/util';
 import { Observable } from 'rxjs';
+import { type DbxActionWorkProgress, type DbxActionWorkOrWorkProgress } from '../action/action';
+export type DbxButtonWorkingProgress = DbxActionWorkProgress;
+/**
+ * Working state for a button.
+ *
+ * Can be a boolean or a number.
+ *
+ * True is treated as an indeterminate progress.
+ */
+export type DbxButtonWorking = DbxActionWorkOrWorkProgress;
 /**
  * Used for intercepting button click events.
  *
@@ -33,7 +43,7 @@ export declare abstract class DbxButton {
     /**
      * Observable of the working state of the button.
      */
-    abstract readonly working$: Observable<boolean>;
+    abstract readonly working$: Observable<DbxButtonWorking>;
     /**
      * Observable of the clicked event of the button.
      */
@@ -49,11 +59,15 @@ export declare abstract class DbxButton {
      */
     abstract setDisabled(disabled?: Maybe<boolean>): void;
     /**
-     * Sets the working state of the button. IF null/undefined the button will be marked as working.
+     * Sets the working state of the button.
+     *
+     * If a number is passed, then it is treated as a progress percentage.
+     *
+     * If true is passed, then it is treated as an indeterminate progress.
      *
-     * @param working
+     * If null/undefined is passed, then the button will not be working.
      */
-    abstract setWorking(working?: Maybe<boolean>): void;
+    abstract setWorking(working?: Maybe<DbxButtonWorking>): void;
     /**
      * Sets the display content of the button.
      *

package/lib/button/button.directive.d.ts

@@ -2,7 +2,7 @@ import { OnDestroy, OnInit, Signal } from '@angular/core';
 import { type Maybe } from '@dereekb/util';
 import { Subject, BehaviorSubject } from 'rxjs';
 import { AbstractSubscriptionDirective } from '../subscription';
-import { DbxButton, DbxButtonDisplay, DbxButtonDisplayType, DbxButtonInterceptor } from './button';
+import { DbxButton, DbxButtonDisplay, DbxButtonDisplayType, DbxButtonInterceptor, DbxButtonWorking } from './button';
 import * as i0 from "@angular/core";
 /**
  * Abstract button component.
@@ -15,13 +15,14 @@ export declare abstract class AbstractDbxButtonDirective extends AbstractSubscri
     protected readonly _buttonInterceptor: BehaviorSubject<Maybe<DbxButtonInterceptor>>;
     readonly buttonClick: import("@angular/core").OutputEmitterRef<void>;
     readonly disabled: import("@angular/core").InputSignalWithTransform<boolean, Maybe<boolean>>;
-    readonly working: import("@angular/core").InputSignalWithTransform<boolean, Maybe<boolean>>;
+    readonly working: import("@angular/core").InputSignalWithTransform<import("@dereekb/dbx-core").DbxActionWorkOrWorkProgress, Maybe<import("@dereekb/dbx-core").DbxActionWorkOrWorkProgress>>;
     readonly buttonDisplay: import("@angular/core").InputSignal<Maybe<DbxButtonDisplay>>;
     private readonly _disabledSignal;
     private readonly _workingSignal;
     private readonly _buttonDisplayContentSignal;
     readonly disabledSignal: Signal<boolean>;
-    readonly workingSignal: Signal<boolean>;
+    readonly workingSignal: Signal<import("@dereekb/dbx-core").DbxActionWorkOrWorkProgress>;
+    readonly isWorkingSignal: Signal<boolean>;
     readonly icon: import("@angular/core").InputSignal<Maybe<string>>;
     readonly text: import("@angular/core").InputSignal<Maybe<string>>;
     readonly buttonDisplayContentSignal: Signal<DbxButtonDisplay>;
@@ -29,13 +30,13 @@ export declare abstract class AbstractDbxButtonDirective extends AbstractSubscri
     readonly iconSignal: Signal<Maybe<string>>;
     readonly textSignal: Signal<Maybe<string>>;
     readonly disabled$: import("rxjs").Observable<boolean>;
-    readonly working$: import("rxjs").Observable<boolean>;
+    readonly working$: import("rxjs").Observable<import("@dereekb/dbx-core").DbxActionWorkOrWorkProgress>;
     readonly display$: import("rxjs").Observable<DbxButtonDisplay>;
     readonly clicked$: import("rxjs").Observable<void>;
     ngOnInit(): void;
     ngOnDestroy(): void;
     setDisabled(disabled?: Maybe<boolean>): void;
-    setWorking(working?: Maybe<boolean>): void;
+    setWorking(working?: Maybe<DbxButtonWorking>): void;
     setDisplayContent(content: DbxButtonDisplay): void;
     /**
      * Sets the button interceptor. If any interceptor is already set, it is replaced.

package/lib/filter/filter.map.directive.d.ts

@@ -2,7 +2,7 @@ import { OnDestroy } from '@angular/core';
 import { FilterMap } from '@dereekb/rxjs';
 import * as i0 from "@angular/core";
 /**
- * Direction that provides an FilterMap.
+ * Direction that provides a FilterMap.
  */
 export declare class DbxFilterMapDirective<F> implements OnDestroy {
     readonly filterMap: FilterMap<any>;

package/lib/injection/index.d.ts

@@ -9,4 +9,5 @@ export * from './injection.instance';
 export * from './injection.rxjs';
 export * from './injection.directive';
 export * from './injection';
+export * from './injection.util';
 export * from './injector';

package/lib/injection/injection.util.d.ts

@@ -0,0 +1,9 @@
+import { StaticProvider } from '@angular/core';
+import { ArrayOrValue, Maybe } from '@dereekb/util';
+/**
+ * Merges the input providers into a single array.
+ *
+ * @param providers
+ * @returns
+ */
+export declare function mergeStaticProviders(...providers: Maybe<ArrayOrValue<StaticProvider>>[]): StaticProvider[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/dbx-core",
-  "version": "12.4.5",
+  "version": "12.5.0",
   "peerDependencies": {
     "@dereekb/util": "*",
     "@dereekb/rxjs": "*",