@dereekb/rxjs 13.3.0 → 13.4.0

package/index.cjs.js

@@ -375,15 +375,12 @@ function switchMapOnBoolean(switchOnValue, obs, otherwise) {
     });
 }
 function filterIfObjectValuesUnchanged(input) {
-    if (rxjs.isObservable(input)) {
-        return rxjs.mergeMap(function(inputFilter) {
-            return input.pipe(filterIfObjectValuesUnchanged(inputFilter));
-        });
-    } else {
-        return rxjs.filter(function(inputObject) {
-            return !util.areEqualPOJOValues(input, inputObject);
-        });
-    }
+    var result = rxjs.isObservable(input) ? rxjs.mergeMap(function(inputFilter) {
+        return input.pipe(filterIfObjectValuesUnchanged(inputFilter));
+    }) : rxjs.filter(function(inputObject) {
+        return !util.areEqualPOJOValues(input, inputObject);
+    });
+    return result;
 }
 
 function _array_like_to_array$a(arr, len) {
@@ -2875,16 +2872,16 @@ function _unsupported_iterable_to_array$4(o, minLen) {
  * @param state - the loading state to check (may be null/undefined)
  * @returns true if loading is complete
  */ function isLoadingStateFinishedLoading(state) {
+    var result = false;
     if (state) {
         var loading = state.loading;
         if (loading === true) {
-            return false;
+            result = false;
         } else {
-            return loading === false || Boolean(state.value || state.error) || state.value === null;
+            result = loading === false || Boolean(state.value || state.error) || state.value === null;
         }
-    } else {
-        return false;
     }
+    return result;
 }
 /**
  * Creates an idle {@link LoadingState} with `loading: false` and no value or error.
@@ -3021,11 +3018,8 @@ function beginLoading(state) {
  */ function isLoadingStateWithStateType(type) {
     var defaultResult = type === exports.LoadingStateType.IDLE ? true : false;
     return function(state) {
-        if (state) {
-            return loadingStateType(state) === type;
-        } else {
-            return defaultResult;
-        }
+        var result = state ? loadingStateType(state) === type : defaultResult;
+        return result;
     };
 }
 /**
@@ -3068,11 +3062,8 @@ function beginLoading(state) {
  * @param state - the loading state to check
  * @returns true if the state has a defined (non-undefined) value
  */ function isLoadingStateWithDefinedValue(state) {
-    if (state) {
-        return state.value !== undefined;
-    } else {
-        return false;
-    }
+    var result = state ? state.value !== undefined : false;
+    return result;
 }
 /**
  * Type guard that checks whether a {@link LoadingState} has a non-null error, regardless of loading status.
@@ -3086,11 +3077,8 @@ function beginLoading(state) {
  * @param state - the loading state to check
  * @returns true if the state has an error
  */ function isLoadingStateWithError(state) {
-    if (state) {
-        return state.error != null;
-    } else {
-        return false;
-    }
+    var result = state ? state.error != null : false;
+    return result;
 }
 /**
  * Type guard that checks whether a {@link LoadingState} has finished loading and has a defined value.
@@ -3098,11 +3086,8 @@ function beginLoading(state) {
  * @param state - the loading state to check
  * @returns true if finished loading with a non-undefined value
  */ function isLoadingStateFinishedLoadingWithDefinedValue(state) {
-    if (state) {
-        return isLoadingStateFinishedLoading(state) && state.value !== undefined;
-    } else {
-        return false;
-    }
+    var result = state ? isLoadingStateFinishedLoading(state) && state.value !== undefined : false;
+    return result;
 }
 /**
  * Type guard that checks whether a {@link LoadingState} has finished loading and has an error.
@@ -3110,11 +3095,8 @@ function beginLoading(state) {
  * @param state - the loading state to check
  * @returns true if finished loading with an error
  */ function isLoadingStateFinishedLoadingWithError(state) {
-    if (state) {
-        return isLoadingStateFinishedLoading(state) && state.error != null;
-    } else {
-        return false;
-    }
+    var result = state ? isLoadingStateFinishedLoading(state) && state.error != null : false;
+    return result;
 }
 /**
  * Compares the metadata (page, loading, error) of two {@link PageLoadingState} instances for equivalence.

package/index.esm.js

@@ -1,5 +1,5 @@
 import { isObservable, of, switchMap, combineLatest, map, delay, startWith, filter, skipWhile, EMPTY, distinctUntilChanged, mergeMap, BehaviorSubject, shareReplay, skip, defaultIfEmpty, first, finalize, merge, firstValueFrom, exhaustMap, scan, identity, throttleTime, takeWhile, timeout, tap, throwError, timer, delayWhen, asyncScheduler, from, catchError, Subject } from 'rxjs';
-import { getValueFromGetter, isMaybeSo, filterMaybeArrayValues, areEqualPOJOValues, convertToArray, asGetter, performTaskLoop, isMaybeNot, forEachWithArray, pushArrayItemsIntoArray, pushItemOrArrayItemsIntoArray, asArray, filterAndMapFunction, expirationDetails, objectKeysEqualityComparatorFunction, objectKeyEqualityComparatorFunction, asPromise, randomNumberFactory, mapsHaveSameKeys, mapKeysIntersectionObjectToArray, incrementingNumberFactory, filterUniqueFunction, build, cachedGetter, allKeyValueTuples, keyValueMapFactory, multiKeyValueMapFactory, timePeriodCounter, hasSameValues, compareEqualityWithValueFromItemsFunction, setContainsAllValues, setContainsAnyValue, setContainsNoneOfValue, searchStringFilterFunction, objectHasKey, reduceBooleansWithAnd, toReadableError, reduceBooleansWithOr, valuesAreBothNullishOrEquivalent, mergeObjects, safeCompareEquality, hasNonNullValue, limitArray, mapFunctionOutputPair, lastValue, flattenArray, hasValueOrNotEmpty, filteredPage, invertMaybeBoolean, FIRST_PAGE, getNextPageNumber, reduceBooleansWithOrFn, MS_IN_SECOND } from '@dereekb/util';
+import { getValueFromGetter, isMaybeSo, filterMaybeArrayValues, areEqualPOJOValues, convertToArray, asGetter, performTaskLoop, isMaybeNot, forEachWithArray, pushArrayItemsIntoArray, pushItemOrArrayItemsIntoArray, asArray, filterAndMapFunction, expirationDetails, objectKeysEqualityComparatorFunction, objectKeyEqualityComparatorFunction, asPromise, randomNumberFactory, mapsHaveSameKeys, mapKeysIntersectionObjectToArray, incrementingNumberFactory, filterUniqueFunction, build, cachedGetter, allKeyValueTuples, keyValueMapFactory, multiKeyValueMapFactory, timePeriodCounter, hasSameValues, compareEqualityWithValueFromItemsFunction, setContainsAllValues, setContainsAnyValue, setContainsNoneOfValue, searchStringFilterFunction, reduceBooleansWithAnd, toReadableError, reduceBooleansWithOr, valuesAreBothNullishOrEquivalent, mergeObjects, objectHasKey, safeCompareEquality, hasNonNullValue, limitArray, mapFunctionOutputPair, lastValue, flattenArray, hasValueOrNotEmpty, filteredPage, invertMaybeBoolean, FIRST_PAGE, getNextPageNumber, reduceBooleansWithOrFn, MS_IN_SECOND } from '@dereekb/util';
 
 function asObservable(valueOrObs) {
     if (isObservable(valueOrObs)) {
@@ -373,15 +373,12 @@ function switchMapOnBoolean(switchOnValue, obs, otherwise) {
     });
 }
 function filterIfObjectValuesUnchanged(input) {
-    if (isObservable(input)) {
-        return mergeMap(function(inputFilter) {
-            return input.pipe(filterIfObjectValuesUnchanged(inputFilter));
-        });
-    } else {
-        return filter(function(inputObject) {
-            return !areEqualPOJOValues(input, inputObject);
-        });
-    }
+    var result = isObservable(input) ? mergeMap(function(inputFilter) {
+        return input.pipe(filterIfObjectValuesUnchanged(inputFilter));
+    }) : filter(function(inputObject) {
+        return !areEqualPOJOValues(input, inputObject);
+    });
+    return result;
 }
 
 function _array_like_to_array$a(arr, len) {
@@ -2873,16 +2870,16 @@ function _unsupported_iterable_to_array$4(o, minLen) {
  * @param state - the loading state to check (may be null/undefined)
  * @returns true if loading is complete
  */ function isLoadingStateFinishedLoading(state) {
+    var result = false;
     if (state) {
         var loading = state.loading;
         if (loading === true) {
-            return false;
+            result = false;
         } else {
-            return loading === false || Boolean(state.value || state.error) || state.value === null;
+            result = loading === false || Boolean(state.value || state.error) || state.value === null;
         }
-    } else {
-        return false;
     }
+    return result;
 }
 /**
  * Creates an idle {@link LoadingState} with `loading: false` and no value or error.
@@ -3019,11 +3016,8 @@ function beginLoading(state) {
  */ function isLoadingStateWithStateType(type) {
     var defaultResult = type === LoadingStateType.IDLE ? true : false;
     return function(state) {
-        if (state) {
-            return loadingStateType(state) === type;
-        } else {
-            return defaultResult;
-        }
+        var result = state ? loadingStateType(state) === type : defaultResult;
+        return result;
     };
 }
 /**
@@ -3066,11 +3060,8 @@ function beginLoading(state) {
  * @param state - the loading state to check
  * @returns true if the state has a defined (non-undefined) value
  */ function isLoadingStateWithDefinedValue(state) {
-    if (state) {
-        return state.value !== undefined;
-    } else {
-        return false;
-    }
+    var result = state ? state.value !== undefined : false;
+    return result;
 }
 /**
  * Type guard that checks whether a {@link LoadingState} has a non-null error, regardless of loading status.
@@ -3084,11 +3075,8 @@ function beginLoading(state) {
  * @param state - the loading state to check
  * @returns true if the state has an error
  */ function isLoadingStateWithError(state) {
-    if (state) {
-        return state.error != null;
-    } else {
-        return false;
-    }
+    var result = state ? state.error != null : false;
+    return result;
 }
 /**
  * Type guard that checks whether a {@link LoadingState} has finished loading and has a defined value.
@@ -3096,11 +3084,8 @@ function beginLoading(state) {
  * @param state - the loading state to check
  * @returns true if finished loading with a non-undefined value
  */ function isLoadingStateFinishedLoadingWithDefinedValue(state) {
-    if (state) {
-        return isLoadingStateFinishedLoading(state) && state.value !== undefined;
-    } else {
-        return false;
-    }
+    var result = state ? isLoadingStateFinishedLoading(state) && state.value !== undefined : false;
+    return result;
 }
 /**
  * Type guard that checks whether a {@link LoadingState} has finished loading and has an error.
@@ -3108,11 +3093,8 @@ function beginLoading(state) {
  * @param state - the loading state to check
  * @returns true if finished loading with an error
  */ function isLoadingStateFinishedLoadingWithError(state) {
-    if (state) {
-        return isLoadingStateFinishedLoading(state) && state.error != null;
-    } else {
-        return false;
-    }
+    var result = state ? isLoadingStateFinishedLoading(state) && state.error != null : false;
+    return result;
 }
 /**
  * Compares the metadata (page, loading, error) of two {@link PageLoadingState} instances for equivalence.

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@dereekb/rxjs",
-  "version": "13.3.0",
+  "version": "13.4.0",
   "peerDependencies": {
     "rxjs": "^7.8.0",
-    "@dereekb/util": "13.3.0"
+    "@dereekb/util": "13.4.0"
   },
   "exports": {
     "./package.json": "./package.json",

package/src/lib/loading/loading.state.d.ts

@@ -443,8 +443,8 @@ export declare function mergeLoadingStateWithValue<S extends LoadingState>(state
 export declare function mergeLoadingStateWithError<S extends LoadingState = LoadingState>(state: S, error?: ReadableDataError): S;
 export type MapMultipleLoadingStateValuesFn<T, X> = (input: X[]) => T;
 export interface MapMultipleLoadingStateResultsConfiguration<T, X, L extends LoadingState<X>[], R extends LoadingState<T>> {
-    mapValues?: MapMultipleLoadingStateValuesFn<T, X>;
-    mapState?: (input: L) => R;
+    readonly mapValues?: MapMultipleLoadingStateValuesFn<T, X>;
+    readonly mapState?: (input: L) => R;
 }
 /**
  * Maps multiple {@link LoadingState} results into a single state using a value mapping or state mapping function.
@@ -461,9 +461,9 @@ export declare function mapMultipleLoadingStateResults<T, X, L extends LoadingSt
 export type MapLoadingStateFn<A, B, L extends LoadingState<A> = LoadingState<A>, O extends LoadingState<B> = LoadingState<B>> = (input: L, value?: B) => O;
 export type MapLoadingStateValuesFn<A, B, L extends LoadingState<A> = LoadingState<A>> = (input: A, state: L) => B;
 export interface MapLoadingStateResultsConfiguration<A, B, L extends LoadingState<A> = LoadingState<A>, O extends LoadingState<B> = LoadingState<B>> {
-    alwaysMapValue?: boolean;
-    mapValue?: MapLoadingStateValuesFn<A, B, L>;
-    mapState?: MapLoadingStateFn<A, B, L, O>;
+    readonly alwaysMapValue?: boolean;
+    readonly mapValue?: MapLoadingStateValuesFn<A, B, L>;
+    readonly mapState?: MapLoadingStateFn<A, B, L, O>;
 }
 /**
  * Maps the value of a single {@link LoadingState} to a new type using the provided configuration.

package/src/lib/loading/loading.state.rxjs.d.ts

@@ -350,19 +350,19 @@ export interface DistinctLoadingStateConfig<L extends LoadingState> {
      *
      * By default this uses a DecisionFunction that returns true on undefined and false on null.
      */
-    passRetainedValue?: (value: Maybe<LoadingStateValue<L>>, previousValue: Maybe<LoadingStateValue<L>>, state: L, previousState: Maybe<L>) => boolean;
+    readonly passRetainedValue?: (value: Maybe<LoadingStateValue<L>>, previousValue: Maybe<LoadingStateValue<L>>, state: L, previousState: Maybe<L>) => boolean;
     /**
      * Whether or not to compare the
      */
-    compareOnUndefinedValue?: boolean;
+    readonly compareOnUndefinedValue?: boolean;
     /**
      * Used for comparing the values of the LoadingState.
      */
-    valueComparator: EqualityComparatorFunction<Maybe<LoadingStateValue<L>>>;
+    readonly valueComparator: EqualityComparatorFunction<Maybe<LoadingStateValue<L>>>;
     /**
      * Used for comparing the metadata values of the LoadingState. By default uses isPageLoadingStateMetadataEqual.
      */
-    metadataComparator?: EqualityComparatorFunction<Maybe<Partial<L>>>;
+    readonly metadataComparator?: EqualityComparatorFunction<Maybe<Partial<L>>>;
 }
 /**
  * A special `distinctUntilChanged`-like operator for {@link LoadingState} and {@link PageLoadingState}.

package/src/lib/lock.d.ts

@@ -1,6 +1,6 @@
 import { type ObservableOrValue } from './rxjs/getter';
 import { type Subscription, type Observable } from 'rxjs';
-import { type Destroyable, type Maybe } from '@dereekb/util';
+import { type Destroyable, type Maybe, type Milliseconds, type Seconds } from '@dereekb/util';
 /**
  * Key used to identify a specific lock within a {@link LockSet}.
  */
@@ -24,9 +24,9 @@ export interface OnLockSetUnlockedConfig {
     /** Optional callback to invoke when the lock set unlocks or the timeout is reached. */
     readonly fn?: Maybe<OnLockSetUnlockedFunction>;
     /** Maximum time in milliseconds to wait for unlock before timing out. Defaults to 50 seconds. */
-    readonly timeout?: Maybe<number>;
+    readonly timeout?: Maybe<Milliseconds>;
     /** Optional delay in milliseconds after the unlock is detected before invoking the callback. */
-    readonly delayTime?: Maybe<number>;
+    readonly delayTime?: Maybe<Milliseconds>;
 }
 /**
  * Configuration for {@link LockSet.destroyOnNextUnlock}, excluding the lock set reference.
@@ -45,7 +45,7 @@ export interface SetLockedConfig {
      *
      * Only relevant for locking.
      */
-    readonly duration?: number;
+    readonly duration?: Milliseconds;
 }
 /**
  * Default lock key used by {@link LockSet.lockForTime} when no custom key is provided.
@@ -132,20 +132,20 @@ export declare class LockSet implements Destroyable {
      * @param duration - optional auto-unlock duration in milliseconds (only used with boolean config)
      */
     setLocked(key: LockKey, config: SetLockedConfig): void;
-    setLocked(key: LockKey, config: boolean, duration?: number): void;
+    setLocked(key: LockKey, config: boolean, duration?: Milliseconds): void;
     /**
      * Locks for a specified number of seconds using the default time lock key.
      *
      * @param seconds - duration in seconds
      */
-    lockForSeconds(seconds: number): void;
+    lockForSeconds(seconds: Seconds): void;
     /**
      * Locks for a specified duration in milliseconds, automatically unlocking when the time elapses.
      *
      * @param milliseconds - lock duration
      * @param key - optional lock key, defaults to {@link DEFAULT_LOCK_SET_TIME_LOCK_KEY}
      */
-    lockForTime(milliseconds: number, key?: LockKey): void;
+    lockForTime(milliseconds: Milliseconds, key?: LockKey): void;
     /**
      * Registers a lock observable under the given key. The lock is considered active when
      * the observable emits `true`. Empty observables are treated as unlocked.
@@ -178,7 +178,7 @@ export declare class LockSet implements Destroyable {
      * @param delayTime - optional delay in milliseconds after unlock before invoking the callback
      * @returns subscription that can be unsubscribed to cancel the wait
      */
-    onNextUnlock(config: OnLockSetUnlockedFunction | Omit<OnLockSetUnlockedConfig, 'lockSet'>, delayTime?: number): Subscription;
+    onNextUnlock(config: OnLockSetUnlockedFunction | Omit<OnLockSetUnlockedConfig, 'lockSet'>, delayTime?: Milliseconds): Subscription;
     /**
      * Establishes a parent-child relationship where this lock set's locked state is propagated
      * to the parent. When this lock set is locked, the parent will also reflect a locked state.
@@ -204,7 +204,7 @@ export declare class LockSet implements Destroyable {
      * @param config - optional callback or configuration for the unlock wait
      * @param delayTime - optional delay in milliseconds after unlock before invoking the callback
      */
-    destroyOnNextUnlock(config?: Maybe<DestroyOnNextUnlockConfig['fn'] | DestroyOnNextUnlockConfig>, delayTime?: number): void;
+    destroyOnNextUnlock(config?: Maybe<DestroyOnNextUnlockConfig['fn'] | DestroyOnNextUnlockConfig>, delayTime?: Milliseconds): void;
     /**
      * Completes all internal subjects, unsubscribes from the parent lock set, and marks this lock set as destroyed.
      */

package/src/lib/rxjs/rxjs.async.d.ts

@@ -1,4 +1,4 @@
-import { type CachedFactoryWithInput, type Destroyable } from '@dereekb/util';
+import { type CachedFactoryWithInput, type Destroyable, type Milliseconds } from '@dereekb/util';
 import { type Observable, type Subject } from 'rxjs';
 /**
  * Default amount of throttle in milliseconds used by AsyncPusher.
@@ -25,19 +25,19 @@ export interface AsyncPusherConfig<T> {
     /**
      * Time to throttle each emission.
      */
-    throttle?: number;
+    readonly throttle?: Milliseconds;
     /**
      * Whether or not to filter on distinct values.
      */
-    distinct?: boolean;
+    readonly distinct?: boolean;
     /**
      * Configuration function to build onto the internal observable.
      */
-    pipe?: (obs: Observable<T>) => Observable<T>;
+    readonly pipe?: (obs: Observable<T>) => Observable<T>;
     /**
      * (Optional) Observable to watch for cleaunup.
      */
-    cleanupObs?: Observable<unknown>;
+    readonly cleanupObs?: Observable<unknown>;
 }
 /**
  * Creates an {@link AsyncPusher} — a callable function backed by a throttled {@link BehaviorSubject}.

package/src/lib/rxjs/value.d.ts

@@ -1,5 +1,5 @@
 import { type MonoTypeOperatorFunction, type Observable, type OperatorFunction } from 'rxjs';
-import { type DecisionFunction, type GetterOrValue, type MapFunction, type Maybe, type MaybeSoStrict } from '@dereekb/util';
+import { type DecisionFunction, type GetterOrValue, type MapFunction, type Maybe, type Milliseconds, type MaybeSoStrict } from '@dereekb/util';
 import { type MaybeObservableOrValueGetter, type ObservableOrValueGetter, type MaybeObservableOrValue } from './getter';
 import { type ObservableDecisionFunction } from './decision';
 /**
@@ -135,7 +135,7 @@ export declare function switchMapToDefault<T = unknown>(defaultObs: MaybeObserva
 export declare function switchMapToDefault<T = unknown>(defaultObs: ObservableOrValueGetter<T>): OperatorFunction<Maybe<T>, T>;
 export declare function switchMapToDefault<T = unknown>(defaultObs: MaybeObservableOrValueGetter<T>, useDefault?: SwitchMapToDefaultFilterFunction<T>): OperatorFunction<Maybe<T>, Maybe<T>>;
 export interface SwitchMapObjectConfig<T> {
-    defaultGetter?: GetterOrValue<Maybe<T>>;
+    readonly defaultGetter?: GetterOrValue<Maybe<T>>;
 }
 /**
  * RxJS operator that resolves an observable/getter config input into a value, applying defaults
@@ -206,8 +206,8 @@ export declare function combineLatestMapFrom<A, B, C>(combineObs: Observable<B>,
  *
  * If the delay is not provided, or is falsy, then the second value is never emitted.
  */
-export declare function emitDelayObs<T>(startWith: T, endWith: T, delayTime: Maybe<number>): Observable<T>;
+export declare function emitDelayObs<T>(startWith: T, endWith: T, delayTime: Maybe<Milliseconds>): Observable<T>;
 /**
  * Emits a value after a given delay after every new emission.
  */
-export declare function emitAfterDelay<T>(value: T, delayTime: number): MonoTypeOperatorFunction<T>;
+export declare function emitAfterDelay<T>(value: T, delayTime: Milliseconds): MonoTypeOperatorFunction<T>;